ShipMsgDocs
Contents

API reference

service-context

API reference descriptions are provided in English to preserve the exact published contract.

Read setup intent and asset-specific service responsibilities

GET /v1/accounts/{AC}/service-context

getV1AccountsByAcServiceContext200

Required scope: `accounts:read`.

Parameters

Parameters
NameTypeRequiredDescription
ACpath · string (AC… SID)yesAccount SID

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Choose a setup offer without changing existing assets or service rights

PATCH /v1/accounts/{AC}/service-context

patchV1AccountsByAcServiceContextIdempotency-Key required200

Required scope: `accounts:write`.

Parameters

Parameters
NameTypeRequiredDescription
ACpath · string (AC… SID)yesAccount SID
Request body (1 fields)
Request body
NameTypeRequiredDescription
selectedOffer"SELF_SERVICE" | "ASSISTED" | "MANAGED"yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.