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

overrides) without touching any other field — the save path behind the visual mapping editor…

PUT /v1/partners/{id}/overlay

cURL

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

overrides) without touching any other field — the save path behind the visual mapping editor. Validate-before-publish is enforced: an overlay with blocking errors is rejected. An empty overlay clears it.

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.

extra_segments · OverlaySegment[]

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

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

cURL

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