POST /copilot/execute

POST

/api/v1/copilot/execute

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/copilot/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "actions": [ { "id": "example", "type": "draft_followup_email", "params": { "lead_id": "example", "subject": "example", "instructions": "example" } } ] }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

actions

required

Array

>= 1 items <= 10 items

Any of:

object

object

id

required

string

>= 1 characters <= 128 characters

type

required

string

Allowed value: draft_followup_email

params

required

object

lead_id

required

string

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

subject

string

<= 300 characters

instructions

string

<= 2000 characters

object

object

id

required

string

>= 1 characters <= 128 characters

type

required

string

Allowed value: create_task

params

required

object

lead_id

required

string

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

title

required

string

>= 1 characters <= 200 characters

due_date

required

string

>= 1 characters

object

object

id

required

string

>= 1 characters <= 128 characters

type

required

string

Allowed value: create_callback

params

required

object

lead_id

required

string

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

phone

required

string

/^\+[1-9]\d{1,14}$/

scheduled_at

required

string

>= 1 characters

timezone

required

string

note

string

<= 2000 characters

object

object

id

required

string

>= 1 characters <= 128 characters

type

required

string

Allowed value: flag_deal_at_risk

params

required

object

deal_id

required

string

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

reason

string

<= 500 characters

object

object

id

required

string

>= 1 characters <= 128 characters

type

required

string

Allowed value: build_sequence

params

required

object

name

required

string

>= 1 characters <= 120 characters

steps

required

Array

>= 1 items <= 6 items

Any of:

object

object

type

required

string

Allowed value: email

subject

string

<= 300 characters

body

string

<= 4000 characters

delay_days

integer

<= 90

object

object

type

required

string

Allowed value: wait

delay_days

integer

<= 90

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

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