API documentation | API docs for agents | OpenAPI 3.1

{inviteId}

ark.cancel_carrier_invite

Cancels a pending carrier onboarding invite and removes pending invite uploads when available.

Availability: Expanded preview
Scopes: carriers:write
ARK permissions: canInviteCarrier
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

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

Request body

None.

Example request

Shell

curl -X DELETE 'https://arktms.com/api/v1/carrier-invites/<inviteId>' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>"

Success response

Cancelled carrier invite

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.inviteobjectrequired

data.storageCleanupobjectrequired

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