Archive a customer
Archives a customer: it leaves lists, search and pickers while every record it owns is kept and it stays readable by id. Reversible via the unarchive action, and NOT a deletion. Idempotent: archiving an already-archived customer returns its current state.
Archives a customer: it leaves lists, search and pickers while every record it owns is kept and it stays readable by id. Reversible via the unarchive action, and NOT a deletion. Idempotent: archiving an already-archived customer returns its current state.
Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.
In: header
Path Parameters
UUIDv7 identifier of the resource.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/archive"{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "contact", "kind": "prospect", "first_name": "string", "last_name": "string", "company_name": "string", "company_number": "string", "email": "user@example.com", "phone": "string", "address_line1": "string", "address_line2": "string", "city": "string", "region": "string", "postcode": "string", "country_code": "st", "date_of_birth": "2019-08-24", "is_charity": true, "is_connected_party": true, "is_business": true, "kyc_status": "not_required", "marketing_consent": true, "marketing_consent_at": "2019-08-24T14:15:22Z", "relief_assist_requested": true, "relief_assist_requested_at": "2019-08-24T14:15:22Z", "notes": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "archived_at": "2019-08-24T14:15:22Z" }}{ "error": { "code": "unauthorized", "message": "Missing or invalid credential." }}{ "error": { "code": "insufficient_scope", "message": "The credential lacks a scope required by this endpoint." }}{ "error": { "code": "not_found", "message": "Resource not found." }}{ "error": { "code": "conflict", "message": "The request conflicts with current resource state." }}{ "error": { "code": "rate_limited", "message": "Rate limit exceeded. Retry after 7s." }}{ "error": { "code": "validation_error", "message": "string", "details": [ { "field": "string", "issue": "string" } ] }}