API documentation | API docs for agents | OpenAPI 3.1

reject

ark.reject_carrier_onboarding

Rejects a carrier submitted through self-service onboarding, marks the carrier do-not-use, updates the invite, and sends the rejection notification.

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

carrierIdpathstringrequired: 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: 200

Request body

rejectionNotestring

max length: 2000

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/carriers/<carrierId>/onboarding/reject' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{}'

Success response

Rejected carrier onboarding

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.carrierobjectrequired

data.inviteobject | nullrequired

data.notificationobjectrequired

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