Skip to content
Pitch2SaleDevelopers
Open the app
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

Schedule an email to a lead

POST
/api/v1/email/schedule
curl --request POST \
  --url https://api.pitch2sale.com/api/v1/email/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "to": "hello@example.com", "cc": [ "hello@example.com" ], "bcc": [ "hello@example.com" ], "subject": "example", "body_html": "example", "body_text": "example", "connected_account_id": "example", "lead_id": "example", "contact_id": "example", "template_id": "example", "attachments": [ { "filename": "example", "content_type": "example", "s3_key": "example", "size_bytes": 1 } ], "scheduled_at": "2026-04-15T12:00:00Z", "follow_up": { "amount": 1, "unit": "days" }, "enroll_in_workflow_id": "example" }'

Queues the email for scheduled_at, between 1 minute and 30 days from now.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
to
required
string format: email
cc
Array<string>
<= 20 items
bcc
Array<string>
<= 20 items
subject
required
string
>= 1 characters <= 500 characters
body_html
required
string
>= 1 characters
body_text
string
connected_account_id
required
string
/^[0-9a-fA-F]{24}$/
lead_id
required
string
/^[0-9a-fA-F]{24}$/
contact_id
string
/^[0-9a-fA-F]{24}$/
template_id
string
/^[0-9a-fA-F]{24}$/
attachments
Array<object>
<= 10 items
object
filename
required
string
>= 1 characters <= 255 characters
content_type
required
string
>= 1 characters <= 100 characters
s3_key
required
string
>= 1 characters <= 500 characters
size_bytes
required
integer
>= 1 <= 26214400
scheduled_at
required
string format: date-time
follow_up
object
amount
required
integer
>= 1 <= 90
unit
required
string
Allowed values: days hours
enroll_in_workflow_id
string
/^[0-9a-fA-F]{24}$/

Responses

Section titled “Responses”

201

Section titled “201”

The scheduled job

Media typeapplication/json
object
message
required
string
job_id
required
string
scheduled_at
required
string
Examplegenerated
{
  "message": "example",
  "job_id": "example",
  "scheduled_at": "example"
}

400

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}