Delete an administrator
/administrators/{administrator_id}Moves the administrator to the trash. A trashed administrator can be restored with the update operation by setting deleted to false.
The last root administrator in the account cannot be deleted, and an administrator acting with their OAuth access token cannot delete themselves. Administrators with the root or master_admin role cannot be deleted through the API; attempts return delegation_limit_exceeded.
API credentials created by the deleted administrator are not revoked.
Credential: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Public ID of the administrator, prefixed with adm_.
Header Parameters
Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.
Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.
length <= 64Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/administrators/string"Update an administrator PATCH
Updates an administrator's name or email address, or restores an administrator from the trash. To restore a trashed administrator, set `deleted` to `false`. Restoring requires the `administrators.delete` permission and is rejected with `validation_failed` if another active administrator already uses the same email address. Roles and permissions can only be changed through the update administrator permissions operation. Fields such as `role`, `status`, and `password` are rejected with `unknown_field`. Send the `ETag` returned by the retrieve operation in the `If-Match` header to avoid overwriting a newer version.
Resend the access email POST
Resends the access email to the administrator. This operation replaces the administrator's password with a new one, which is sent by email and never included in the response. The email is sent asynchronously. An access email can be sent to the same administrator at most once every 10 minutes. Earlier attempts return `email_recently_sent`.