Skip to main content
DELETE
Delete One Carrier By Source System Id
Hard delete; carriers have no archive state. See Deleting and archiving.

Authorizations

Authorization
string
header
required

Your API key, sent in the Authorization header: Authorization: YOUR_API_KEY. A Bearer prefix is also accepted (Authorization: Bearer YOUR_API_KEY). Keys are created in the Upwell dashboard (Account → API keys) and are scoped to one organization.

Query Parameters

sourceSystem
string

"sourceSystem" is required (enter it either in parameters or request body)

sourceSystemId
string

"sourceSystemId" is required (enter it either in parameters or request body)

Body

application/json

Query parameters can also be provided in the request body as a JSON object

sourceSystem
string

Name of the originating system. Together with sourceSystemId, identifies the external record within your organization.

sourceSystemId
string

Record identifier in the originating system. Preserve leading zeros; use it with sourceSystem for lookup/update.

Response

Responses for DELETE /api/rest/carriers

deleteCarrier
CarriersMutationResponse · object | null

response of any mutation on the table "carriers"