Create a sequence

POST

/api/v1/sequences

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/sequences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "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 } } ], "settings": { "send_window": { "start_hour": 9, "end_hour": 17 }, "timezone": "UTC", "exclude_weekends": true, "stop_on_reply": true, "stop_on_meeting_booked": false, "max_per_day": 50 } }'

Created as a draft; add at least one email step before activating.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters <= 200 characters

description

Any of:

string

string

<= 2000 characters

null

null

steps

required

Array<object>

>= 1 items <= 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

settings

object

send_window

object

start_hour

integer

default: 9 <= 23

end_hour

integer

default: 17 <= 23

timezone

string

default: UTC <= 100 characters

exclude_weekends

boolean

default: true

stop_on_reply

boolean

default: true

stop_on_meeting_booked

boolean

max_per_day

integer

default: 50 >= 1 <= 500

Responses

201

The new sequence

Media typeapplication/json

object

sequence

required

object

_id

required

string

name

required

string

status

required

string

Allowed values: draft active paused archived

key

additional properties

any

Example

{
  "sequence": {
    "status": "draft"
  }
}

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"
    }
  ]
}