Delete a campaign

Deletes a campaign by ID from the brand of the specified profile. The profile must belong to the authenticated organization.

DELETE
/v3/profiles/{profileId}/campaigns/{campaignId}

Path Parameters

profileId*string

Profile ID from route parameter

Formatuuid
campaignId*string

Campaign ID from route parameter

Formatuuid

Header Parameters

x-profile-id?string

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

sandbox?boolean

Sandbox flag - when true, the operation is simulated without side effects Useful for testing integrations without actual execution

Response Body

application/json

application/json

application/json

curl -X DELETE "https://api.sent.dm/v3/profiles/770e8400-e29b-41d4-a716-446655440002/campaigns/b2c3d4e5-f6a7-8901-bcde-f12345678901" \  -H "Content-Type: application/json" \  -d '{    "sandbox": false  }'
Empty
{
  "success": false,
  "data": null,
  "error": {
    "code": "VALIDATION_001",
    "message": "Invalid profile or campaign ID format",
    "details": null,
    "doc_url": "https://docs.sent.dm/errors/VALIDATION_001"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:50.2553586+00:00",
    "version": "v3"
  }
}
Empty
Empty
{
  "success": false,
  "data": null,
  "error": {
    "code": "RESOURCE_010",
    "message": "Campaign not found for this profile",
    "details": null,
    "doc_url": "https://docs.sent.dm/errors/RESOURCE_010"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:50.2553609+00:00",
    "version": "v3"
  }
}
{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_001",
    "message": "Failed to delete campaign. Please contact support with request ID: req_7X9zKp2jDw",
    "details": null,
    "doc_url": "https://docs.sent.dm/errors/INTERNAL_001"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:50.2553616+00:00",
    "version": "v3"
  }
}

Update a campaign PUT

Updates an existing campaign under the brand of the specified profile. Cannot update campaigns that have already been submitted to TCR.

List users GET

Retrieves all users who have access to the organization or profile identified by the API key, including their roles and status. Shows invited users (pending acceptance) and active users. Requires developer role or higher.