01 · Save account

POST

/api/v1/super-dispatch/accounts

Last modified:2026-09-18 19:26:21

Upserts one account per company/environment; reconnects a soft-deleted account. Returns 201 for create or replacement. Saving does not verify credentials. Secret is encrypted. Clears cached OAuth token; test connection next.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Successful response

Bodyapplication/json

🟠401401

🟠409409

🟠422422

🔴500500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://connect.dispatchable.com/super-dispatch/api/v1/super-dispatch/accounts' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "My Super Dispatch account",
    "client_id": "replace-with-client-id",
    "client_secret": "replace-with-client-secret",
    "is_sandbox": false
}'

Response Example

201 - Success

{
    "success": true,
    "data": {
        "id": 1,
        "uuid": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
        "company_uuid": "demo-company",
        "name": "My Super Dispatch account",
        "client_id": "replace-with-client-id",
        "created_by": "demo-user",
        "is_active": true,
        "is_sandbox": false,
        "token_type": "Bearer",
        "expires_in": null,
        "access_token_expires_at": null,
        "last_connected_at": null,
        "last_error": null,
        "created_at": "2026-09-18T16:00:00.000000Z",
        "updated_at": "2026-09-18T16:00:00.000000Z",
        "deleted_at": null
    }
}

Modified at 2026-09-18 19:26:21

Retrieve and refresh payment

List accounts