Delete Profile API
The Delete Profile API lets you delete a profile by sending a DELETE request to {{API_BASE_URL}}/v1/profiles/{id}. The operation soft-deletes an empty profile, so before you call it you should move or disconnect active integrations belonging to that profile. This page covers the authorization header, the required path parameter, and the exact success and error response shapes so you can handle each outcome without guessing field names.
Delete Profile API overview and soft-delete precondition
Delete a profile by calling DELETE {{API_BASE_URL}}/v1/profiles/{id}. The operation soft-deletes an empty profile. That precondition matters in practice: if integrations are still active on the profile, move or disconnect them first, then send the delete request. Do not assume the profile can be deleted while integrations still depend on it, and do not assume any recovery behavior, because none is specified in the contract for this endpoint. The request has no body fields in the captured contract; the only input is the profile identifier in the path, plus the authorization header described below.
Authorization
Every request must include the x-access-key header. The captured contract names the scheme accessKey, places the value in the header, and shows the placeholder <token> as the value format. No additional token format, issuance, rotation, or scope details are specified, so send the token you were issued in that header and treat a missing or invalid value as a failure to check before debugging the path parameter. Keep the header name exactly as x-access-key, including its lowercase spelling and hyphens.
Path Parameters
The path contains one required parameter, id, whose description is Profile ID. Replace {id} in {{API_BASE_URL}}/v1/profiles/{id} with the identifier of the empty profile you intend to delete. Because id is a path parameter rather than a query parameter or body field, it belongs in the URL itself and should not be repeated in a request body. The field map below lists its exact name, type, and requiredness so you can validate your request before sending it.
Response Body
A successful deletion returns HTTP 200 with an application/json body containing two required fields: success, a boolean, and message, a string. Check success rather than relying only on the status code, and surface message to the caller as the human-readable outcome. The three error statuses, 400, 404, and 409, each return an application/json body with one required field: error, a string. The captured contract does not define distinct triggers for those statuses, so your client should branch on the status code, read error, and avoid inventing a specific cause that the contract does not state. The failure matrix below maps each status to its exact response shape.
Worked example and failure checks
To make the call, send a DELETE request to {{API_BASE_URL}}/v1/profiles/{id} with the x-access-key header set to your token, as shown in the worked HTTP example titled Delete a profile request. Before sending, confirm the profile is empty and its active integrations have been moved or disconnected. After sending, handle 200 by reading success and message, and handle 400, 404, and 409 by reading error. If you get an error response, do not retry blindly with a different profile ID; first verify that the id you placed in the path matches the intended Profile ID and that the precondition for deleting an empty profile has been met.
| Field | Location | Type | Required | Description |
|---|---|---|---|---|
| x-access-key | Header | string (<token>) | Yes | Authorization header (accessKey scheme) |
| id | Path | string | Yes | Profile ID |
Captured contract; token details beyond header name and <token> placeholder are not specified.
| Field | Type | Required | Description |
|---|---|---|---|
| success | boolean | Yes | Success flag in the 200 response |
| message | string | Yes | Message in the 200 response |
Captured contract for HTTP 200 application/json.
| Status | Content type | Field | Type | Required |
|---|---|---|---|---|
| 200 | application/json | success / message | boolean / string | Yes / Yes |
| 400 | application/json | error | string | Yes |
| 404 | application/json | error | string | Yes |
| 409 | application/json | error | string | Yes |
Captured contract; specific triggers for 400, 404, and 409 are not defined beyond the error string response.
curl -X DELETE "{{API_BASE_URL}}/v1/profiles/{id}" \
-H "x-access-key: <token>"| Scope | Field | Type | Type reference | Required | Description |
|---|---|---|---|---|---|
| id#1 | id | string | __0 | Yes | Profile ID |
| response#2 | response | object | __0 | ||
| response#2 | response.success | boolean | __1 | Yes | |
| response#2 | response.message | string | __2 | Yes | |
| response#3 | response | object | __0 | ||
| response#3 | response.error | string | __1 | Yes |