Delete a user
Deletes a user. The response returns the user with is_deleted set to true.
Authorizations
Base64-encoded HMAC-SHA256 signature of the request. Every request must also include the x-bigco-hmac-username and x-date headers, and POST/PUT requests must include x-digest. See the Authentication guide for the full signing procedure.
Path Parameters
The Sotto ID of the user to delete.
x >= 11
Response
The deleted user.
The user's unique Sotto ID. Use this for update and delete requests.
1
The user's phone number in E.164 format.
"+15551234567"
UTC time when the user was created.
"2024-01-01T12:00:00Z"
UTC time when the user was last updated.
"2024-10-01T12:00:00Z"
50"Jane"
50"Doe"
50"jane.doe@example.com"
Date of birth in MM/DD/YYYY format.
"01/01/1990"
true if subscribed to messages, false if unsubscribed, null if the user has neither opted in nor opted out.
true
Key/value pairs of custom data. Each key must match a configured custom data field name, lowercased and snake-cased (e.g. "Loyalty Tier" becomes loyalty_tier). Values may be a string, number, or array.
A user's resolved location, derived from their postal code.
Whether the user has been deleted.
false