edi-profiles
EDI document profile configurations that tell the platform how to parse and envelope X12 / EDIFACT documents for a specific trading partner.
REST API: EDI Profiles
celigo edi-profiles <subcommand> [args] [flags]Supports all global flags.
Subcommands
list
List all EDI profiles.
get <id>
Fetch one EDI profile by ID.
create
Create an EDI profile from a JSON body (--file <path> or stdin).
update <id>
Full replace from a JSON body (--file <path> or stdin); destructive PUT.
set <id> key=value …
Safe field edit: GET → modify → PUT. Supports key=file://<path>.
delete <id>
Delete an EDI profile.
dependencies <id> (alias used-by)
List resources that depend on this EDI profile.
audit <id>
Show the EDI profile's audit log (change history).
celigo edi-profiles list
List every EDI profile in the account. Default table columns: _id, name, lastModified.
Signature
Arguments
None.
Flags
None beyond the global flags (--format, --jq, --profile, --verbose).
Example
Corresponds to: GET /v1/ediprofiles
celigo edi-profiles get
Fetch a single EDI profile by ID.
Signature
Arguments
<id>
string
Yes
EDI profile _id.
Flags
None beyond the global flags.
Example
Corresponds to: GET /v1/ediprofiles/{_id}
celigo edi-profiles create
Create an EDI profile from a JSON body. Read the body from a file with -f, --file, or pipe it on stdin.
Signature
Arguments
None.
Flags
-f, --file <path>
string
—
Read the JSON body from a file instead of stdin (--file - also means stdin). Added in celigo-cli 2026.6.1.
Request body
A JSON object matching the POST /v1/ediprofiles request schema. Common top-level fields include name, format (x12 | edifact), envelope settings (ISA/GS for X12, UNB/UNH for EDIFACT), and transactions[] with per-document definitions.
Example
Corresponds to: POST /v1/ediprofiles
celigo edi-profiles update
Replace an EDI profile with a JSON body (--file <path> or stdin).
⚠️
updateerases omitted fields.PUTis a full replace — any envelope block, transaction, or segment missing from the body is cleared.GETthe profile first, edit it, then send back the complete object — or usesetfor partial edits.
Signature
Arguments
<id>
string
Yes
EDI profile _id.
Flags
-f, --file <path>
string
—
Read the JSON body from a file instead of stdin (--file - also means stdin). Added in celigo-cli 2026.6.1.
--force
boolean
false
Submit even if the body contains masked credential values (***) copied from a GET.
Request body
Pass the complete resource — any envelope block, transaction, or segment you omit will be removed on save. Prefer set for partial edits.
Example
Corresponds to: PUT /v1/ediprofiles/{_id}
celigo edi-profiles set
Safe field edit: the CLI does a GET, applies one or more key=value assignments, then PUTs the full object back. Prefer this over update for partial changes — envelope and transaction nesting makes manual full-body edits error-prone.
Signature
Arguments
<id>
string
Yes
EDI profile _id.
<assignments...>
string
Yes
One or more key=value pairs. Values are JSON-parsed (disabled=false → boolean, quoted strings stay strings). key=null removes the field. Dot notation (envelope.ISA.senderId=ACME) and array indexing (transactions[0].name="850") are supported. Use key=file://<path> to load a value from a file (added in celigo-cli 2026.6.1).
Flags
None beyond the global flags.
Examples
Corresponds to: GET /v1/ediprofiles/{_id} then PUT /v1/ediprofiles/{_id}
celigo edi-profiles delete
Delete an EDI profile by ID. Prompts for confirmation unless -y is passed.
⚠️
deleteis immediate. Any flow wired to this profile starts failing on the next document until you repoint it. Rundependenciesfirst.
Signature
Arguments
<id>
string
Yes
EDI profile _id.
Flags
-y, --yes
boolean
false
Skip the interactive confirmation prompt.
Example
Corresponds to: DELETE /v1/ediprofiles/{_id}
celigo edi-profiles dependencies
List resources that depend on this EDI profile (alias: used-by). Use it to check whether a profile is safe to delete — an empty result means nothing references it.
Signature
Arguments
<id>
string
Yes
EDI profile _id.
Example
Corresponds to: GET /v1/ediprofiles/{_id}/dependencies
celigo edi-profiles audit
Show the audit log (change history) for one EDI profile.
Signature
Arguments
<id>
string
Yes
EDI profile _id.
Example
Corresponds to: GET /v1/ediprofiles/{_id}/audit
Gotchas
One profile per trading partner per direction. Inbound and outbound typically need separate profiles — inbound envelope identifiers are the partner's, outbound are yours. Clone rather than toggle.
Envelope identifiers are case-sensitive and padded. X12 ISA fields are fixed-width; match exactly what the partner sends in their onboarding spec or acknowledgments will reject.
Profiles are referenced by flows and file definitions. Before deleting, confirm no active flow is wired to the profile — the reference will dangle and the flow will start failing on the next document.
Generation endpoint is not exposed by the CLI.
POST /v1/ediprofiles/generate(derive a profile from a sample file) is UI-only; the workflow is complex enough that Celigo kept it in the browser.API path is
ediprofiles(no hyphen). The CLI command isedi-profiles; the underlying endpoint is/v1/ediprofiles.
Related
edi-transactions — read the transaction log produced when flows exchange documents against these profiles.
file-definitions — parsing rules for the raw file formats the profile envelopes.
flows — flows that reference an EDI profile to envelope or parse documents during execution.
Last updated
Was this helpful?