/carriers/{carrierId}/actions

Create and execute an action for a specified carrier. The carrier is updated accordingly. edit changes the carrier's details. edit-integration-toggles changes the toggles of an integrated carrier: the keys sent replace their stored values, the others stay, and credentials, provider and service are never changed. A key the carrier's integration does not offer, an invalid value or a carrier without an integration answers 400. A toggle that changes how the carrier's status updates are delivered renews that subscription with the carrier before the change is saved. Actions also include link-accounting-partner and unlink-accounting-partner.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

request to create carrier action

string
enum
required
Allowed:
payload
object
required
Responses

400

invalid action, or a change the carrier refuses

401

unauthorized

403

The role of the API key does not allow this action. The key needs a role with the matching permission, for example full access.

404

carrier not found

409

the carrier kept changing concurrently and the action was not applied; retry

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json