Skip to navigation

Delete Member

Soft-deletes a member and its linked account context for the authenticated SP Digital business.

Example curl:

curl --request POST '{{base_url}}/sp/members/delete' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"idempotency_key": "{{$timestamp}}-member-delete",
"contact_id": {{contact_id}}
}'

Example success response shape:

{
"success": true,
"message": "Member deleted successfully.",
"data": {
"member_id": 123,
"contact_id": 456,
"deleted": true
},
"meta": {}
}

Example error response shape:

{
"success": false,
"message": "The same idempotency_key cannot be reused with a different payload.",
"error": {
"code": "idempotency_key_reused_with_different_payload",
"details": {}
}
}

Common platform errors:

  • idempotency_key_required
  • member_not_found
  • unauthorized
  • sp_scope_not_granted
  • sp_token_scope_missing
  • legacy_field_not_allowed
  • query_parameters_not_allowed
  • invalid_content_type

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

AuthorizationstringOptional

Response

200 OK Example
successbooleanOptional
messagestringOptional
dataobjectOptional
metaobjectOptional