Update an A/B variant of a sequence

PUT

/api/v1/sequences/{id}/variants/{variant_id}

curl --request PUT \
  --url https://api.pitch2sale.com/api/v1/sequences/example/variants/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "traffic_pct": 1, "is_control": true, "steps": [ { "order": 1, "type": "email", "delay_days": 0, "delay_hours": 0, "email_template_id": "example", "email_subject": "example", "email_body": "example", "task_title": "example", "task_description": "example", "conditions": { "skip_if_replied": false, "skip_if_opened": false, "skip_if_clicked": false } } ] }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Path Parameters

id

required

string

variant_id

required

string

Request Body^required

Media typeapplication/json

object

name

string

>= 1 characters <= 200 characters

traffic_pct

number

<= 100

is_control

boolean

steps

Array<object>

0 <= 50 items

object

order

required

integer

type

required

string

Allowed values: email call_task linkedin_task manual_task wait

delay_days

integer

0 <= 365

delay_hours

integer

0 <= 23

email_template_id

Any of:

string

string

/^[0-9a-fA-F]{24}$/

null

null

email_subject

Any of:

string

string

<= 500 characters

null

null

email_body

Any of:

string

string

<= 50000 characters

null

null

task_title

Any of:

string

string

<= 500 characters

null

null

task_description

Any of:

string

string

<= 5000 characters

null

null

conditions

object

skip_if_replied

boolean

skip_if_opened

boolean

skip_if_clicked

boolean

Responses

200

OK

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

402

Feature not available on the organization plan

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}