AcquisityDeveloper Docs
Cold email agentSequences

Edit a sequence variant

PATCH
/v1/workspaces/{workspaceId}/campaigns/{campaignId}/sequence/steps/{stepIndex}/variants/{variantIndex}

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. Some integration endpoints require an organization key even when a personal token has the named resource scope.

In: header

Path Parameters

workspaceId*string

Workspace id.

Formatuuid
campaignId*string

Campaign id.

Formatuuid
stepIndex*integer

Zero-based index of the step in the sequence. The first email is step 0.

Range0 <= value <= 49
variantIndex*integer

Zero-based index of the variant inside the step. A step with no A/B test has one variant, index 0.

Range0 <= value <= 25

Header Parameters

if-match*string

Required optimistic-concurrency precondition. Send the campaign's updatedAt from your most recent read (getCampaign). A missing header returns HTTP 428 and a stale value returns HTTP 412, unless the request retries an earlier Idempotency-Key. The value is checked again when the queued write runs; if the campaign changed in between, the operation fails with precondition_failed and nothing is written. Every successful sequence edit returns the campaign's new updatedAt in the operation result. Send the next edit after the previous operation has finished, using that value.

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 the original operation; because the request carries If-Match, a replay answers HTTP 202 with the id and current status of that operation, even when it already finished. 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.

Properties1 <= properties

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

application/json

curl -X PATCH "https://example.com/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08/sequence/steps/0/variants/0" \  -H "if-match: 2019-08-24T14:15:22Z" \  -H "Content-Type: application/json" \  -d '{}'
{  "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  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}