Skip to content

Delete Profile API

The Delete Profile API soft-deletes an empty profile by its Profile ID. Use it when a profile no longer needs to be kept and it has no active integrations attached. If active integrations still belong to the profile, the request is blocked until those integrations are moved or disconnected.

Endpoint

Send a DELETE request to the endpoint shown in the Delete profile endpoint example, replacing the example identifier with the Profile ID you want to remove. Include the x-access-key header with your API key.

Path Parameters

The identifier is supplied as the id path parameter, typed as a string, and described as the Profile ID. Check the identifier before sending the request: a 400 response means Invalid profile id, while a 404 response means Profile not found.

Empty profiles only

Deletion is limited to an empty profile. While active integrations belong to the profile, the API returns 409 Conflict and the profile is not deleted. Before retrying, work through a pre-delete checklist: confirm the profile is empty, then for each active integration either move it to another profile, move them to Default, or disconnect it. Once no active integrations remain on the profile, retry the same DELETE request with the same Profile ID. Treat a 409 Conflict as a signal to finish that cleanup first rather than repeating the delete unchanged.

Example

Use the cURL example titled Delete a profile with cURL to send the DELETE request with the x-access-key header and the Profile ID in the path.

Response

A successful deletion returns a JSON body with success set to true and the message Profile deleted. If the response instead reports Invalid profile id, correct the identifier and try again; if it reports Profile not found, stop and verify that the profile still exists before issuing another request.

Status Codes

Use the status code together with the response body to decide the next step. A 200 means Profile deleted and no further action is needed for that profile. A 400 means Invalid profile id, so correct the Profile ID. A 404 means Profile not found, so verify the profile exists and has not already been deleted. A 409 means Profile has active integrations, so move them to another profile, move them to Default, or disconnect them, then retry the delete.

Path Parameters
ParameterTypeDescription
idstringProfile ID

Exact source contract; origin modularized only in examples.

Status Codes and Failure Matrix
CodeMeaningNext step
200Profile deletedNo further action for that profile.
400Invalid profile idCorrect the Profile ID and retry.
404Profile not foundVerify the profile exists before retrying.
409Profile has active integrationsMove integrations to another profile, move them to Default, or disconnect them, then retry.

Exact source status meanings; next step for 409 is the documented remediation.

Delete a profile with cURL
curl -X DELETE "{{API_BASE_URL}}/v1/profiles/65ab123" \
  -H "x-access-key: YOUR_API_KEY"
Contract example 1
DELETE {{API_BASE_URL}}/v1/profiles/{id}
Contract example 5
{
	"success": true,
	"message": "Profile deleted."
}