Try it in Swagger
Endpoint
- Method:
DELETE
- Route:
Contact/Delete/{code}
- Authentication:
Authorize
Soft-deletes a contact on the authenticated user's account by marking it retired; the row is
not removed, preserving history and references from existing orders. Account administrators only.
Retired contacts are excluded from GetAll unless
includeRetired=true.
Request Schema
| Header |
Required |
Notes |
X-Api-Key |
Required when tenant is not resolved by subdomain |
Resolves the tenant/customer database. |
Authorization: Bearer {token} |
Required for authorized endpoints |
Get a token from Auth/Token or Session/Create. |
Path Parameters
| Field |
Type |
Required |
Notes |
code |
int |
Yes |
Contact code to retire. |
Expected Response Schema
Status Codes
| Status |
Notes |
200 OK |
Contact retired; the retired contact is returned. |
403 Forbidden |
Caller is not an account administrator. |
404 Not Found |
No contact with that code exists on the account. |
Success Body
Response type: ContactLookupDto (see GetAll for fields).