API documentation | API docs for agents | OpenAPI 3.1

{connectionId}

ark.update_edi_partner_connection

Updates an EDI partner connection status, transport identifiers, routing identifiers, and setup notes.

Availability: Expanded preview
Scopes: edi:write
ARK permissions: canAdminEdi
Team visibility: Not entity-scoped
Idempotency-Key: Required for this write
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

connectionIdpathstringrequired: format: uuid
Idempotency-Keyheaderstringrequired: Required for external write operations. Reuse the same key only for exact retries of the same request body.; min length: 1; max length: 255

Request body

partnerDisplayNamestring

min length: 1; max length: 200

requestNotesstring | null

max length: 5000

onboardingStatusstring

one of: requested, internal_review, testing, active, suspended, error, archived

transportStatusstring

one of: pending, configured, testing, active, suspended, error

assignmentStatusstring

one of: active, suspended, archived

serverKeystring | null

max length: 200

agreementIdstring | null

max length: 200

connectorIdstring | null

max length: 200

inboundAs2Identitystring | null

max length: 200

outboundAs2Identitystring | null

max length: 200

isaSenderIdstring | null

max length: 50

isaReceiverIdstring | null

max length: 50

gsSenderIdstring | null

max length: 50

gsReceiverIdstring | null

max length: 50

routingDiscriminatorstring | null

max length: 100

Example request

Shell

curl -X PATCH 'https://arktms.com/api/v1/edi/connections/<connectionId>' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{}'

Success response

Updated EDI partner connection

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.connectionobjectrequired

data.messagestringrequired

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found
HTTP 409: Idempotency conflict or in-progress retry