Replace a partner's companion-guide **overlay** (extra segments + element…

Overlay saved (returns the redacted partner + validation warnings)

PUT /v1/partners/{id}/overlay

cURL

curl --silent --show-error --fail-with-body --request PUT \
  --url 'https://api.edi.stateset.com/v1/partners/{id}/overlay' \
  --header "Authorization: Bearer $EDI_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  "element_overrides": [
    {
      "element": 1,
      "segment": "string",
      "transaction_set": "string",
      "value": "49.00"
    }
  ],
  "extra_segments": [
    {
      "elements": [
        "string"
      ],
      "tag": "priority",
      "transaction_set": "string"
    }
  ]
}'

Path parameters

id · string · required

Partner ID

Request body

PartnerOverlay

element_overrides · ElementOverride[]

Force an element’s value on the first matching segment of an outbound transaction (optionally scoped to a set) — e.g. a fixed qualifier.

Show ElementOverride

element · integer · required

1-based element position (element 1 is the first after the segment tag). Minimum: 0.

segment · string · required

transaction_set · string,null

value · string · required

extra_segments · OverlaySegment[]

Extra segments appended to outbound transactions (optionally scoped to a transaction set) — e.g. a partner-required REF/N9/DTM.

Show OverlaySegment

elements · string[]

tag · string · required

transaction_set · string,null

Restrict to one transaction set (e.g. 856); None applies to all.

Response

No response body. Overlay saved (returns the redacted partner + validation warnings).

Status codes

Code	Meaning
200	Overlay saved (returns the redacted partner + validation warnings)
422	Overlay has blocking errors

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.

cURL

curl --silent --show-error --fail-with-body --request PUT \
  --url 'https://api.edi.stateset.com/v1/partners/{id}/overlay' \
  --header "Authorization: Bearer $EDI_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  "element_overrides": [
    {
      "element": 1,
      "segment": "string",
      "transaction_set": "string",
      "value": "49.00"
    }
  ],
  "extra_segments": [
    {
      "elements": [
        "string"
      ],
      "tag": "priority",
      "transaction_set": "string"
    }
  ]
}'