AcquisityDeveloper Docs
Campaigns

Update draft campaign

PATCH
/v1/workspaces/{workspaceId}/campaigns/{campaignId}

Authorization

bearerAuth
AuthorizationBearer <token>

Paste the full personal access token or organization API key value. Examples: acq_live_..., acq_org_.... Tokens can be limited to resource/action scopes such as workspaces:read, people:write, and deals:write.

In: header

Path Parameters

workspaceId*string

Workspace id.

Formatuuid
campaignId*string

Campaign id.

Formatuuid

Header Parameters

if-match*string

Required optimistic-concurrency precondition. Send the updatedAt value from the most recent read of the campaign. If the campaign has moved since then, the operation resolves terminally with a precondition_failed error and no changes are persisted.

Formatdate-time
idempotency-key?string

Client-provided key that makes retries safe. HTTP header names are case-insensitive; send Idempotency-Key or idempotency-key. Send the same key + same body to replay a completed operation (HTTP 200); reusing the key with a different body returns HTTP 409. Recommended: a v4 UUID.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Fields to update on the draft campaign. Only the fields you send are changed; omitted fields are left as-is. Unknown fields are rejected with 422. Editing sequences or the lead set is not supported here — those have their own endpoints. The schedule field updates the campaign sending schedule; within it, daysOfWeek/timeWindow/timezone replace the sending window while startDate/endDate are preserved unless you send them.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "if-match: 2019-08-24T14:15:22Z" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "status": "succeeded",  "links": {    "self": "http://example.com"  }}
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "status": "queued",  "links": {    "self": "http://example.com"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}