Allo

Deactivate account

Deactivates an account you provisioned and cancels its subscription, so it is not renewed. The account stays active until the end of the current paid period…

DELETE/v2/api/partner/accounts/{id}

Deactivates an account you provisioned and cancels its subscription, so it is not renewed. The already-paid period is honored: the account keeps working until the end of the current billing period, then expires. You can only deactivate accounts your own API key created.

When the paid period ends, the account and its members are deleted: their numbers are released, their API keys stop working and GET /v2/api/partner/accounts/{id} returns 404. The email and personal mobile of the account and of each member are then free, so you can create a new account with them. Until then, creating an account with one of them fails with PARTNER_ACCOUNT_ALREADY_EXISTS.

An account whose subscription has already ended is deleted right away.

If your partner contract does not allow deactivating this account, the request fails with PARTNER_CANNOT_DEACTIVATE.

If no subscription can be found for an account you are billed for, the request fails with PARTNER_ACCOUNT_SUBSCRIPTION_CONFLICT and nothing changes. Contact [email protected].

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

idstringrequired

Responses

204Account deactivated
401
403The API key lacks the PARTNER scope, or your partner contract does not allow deactivating this account (PARTNER_CANNOT_DEACTIVATE).
errorobject
404No account with this id was provisioned by your API key (PARTNER_ACCOUNT_NOT_FOUND).
errorobject
429