UNunipile
Accounts

Delete an account

Changed on

Unlink the given account from Unipile. By default, provider sessions or authorizations are revoked where supported. Set provider_session_revoke=false to delete locally without revoking them.

delete/api/v1/accounts/{id}

Request

Path parameters

idstring required

The id account to be deleted.

Query parameters

provider_session_revokeboolean

Defaults to true. Set to false to disable provider session or authorization revocation while deleting local account data. Use false when deleting a v1 account after migrating it to v2 (e.g. a LinkedIn account connected with credentials), or when deleting a Google connection used across projects sharing the same Google OAuth authorization, to avoid disconnecting the other connections.

Response

OK. The account deletion succeeded.

object'AccountDeleted' required

Changes

  • e74f29ca2aaaRevision changes
    • warning

      added the new errors/target_audience_too_small enum value to the response property for the response status

    • info

      added the new optional query request parameter provider_session_revoke