Skip to main content

Delete an API token.

DELETE 

/v1/api-tokens/:id

Deletes an API token of the account that owns the API token in the request or of one of its sub accounts, and returns the deleted token.

Must be run with an API token that has the Admin role. API tokens created before token roles were introduced have the same permissions as Admin.

An API token can't delete itself. To delete the token you're calling with, use a different Admin API token.

Deleting a token affects any integrations that use that token. Make sure you update integrations that use a token you deleted.

Please ensure to change the region in the URL to match your account's region.

Request​

Path Parameters

Responses​

successful operation. Returns the deleted token.

Schema
    id int32

    ID of the API token. Use it to delete the token.

    name string

    The name of the API token

    token string

    The API token

    createdAt number

    The time at which the API token was created, in epoch seconds

    lastUsed number

    The time at which the API token was last used, in epoch seconds, or null if it was never used

    role string

    Possible values: [ADMIN, REGULAR, READ_ONLY, CUSTOM]

    The role of the API token. REGULAR is shown as User in the app.

Loading...