Send an SMS to a lead

POST

/api/v1/sms/send

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/sms/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "to": "example", "body": "example", "lead_id": "example", "contact_id": "example", "from_number_id": "example", "template_id": "example", "media_urls": [ "https://example.com" ], "override": true }'

Sends from one of the organization’s numbers (MMS with https media_urls on capable numbers) and logs an SMS activity. Consent, opt-out, A2P registration and the messaging kill switch are always enforced; quiet hours too unless override is set. Limited to 30 sends per minute per user.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

to

required

string

>= 1 characters

body

required

string

>= 1 characters <= 1600 characters

lead_id

required

string

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

contact_id

string

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

from_number_id

string

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

template_id

string

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

media_urls

Array<string>

<= 10 items

override

boolean

Example^generated

{
  "to": "example",
  "body": "example",
  "lead_id": "example",
  "contact_id": "example",
  "from_number_id": "example",
  "template_id": "example",
  "media_urls": [
    "https://example.com"
  ],
  "override": true
}

Responses

200

The SMS was sent

Media typeapplication/json

object

message

required

string

activity_id

required

string

Example^generated

{
  "message": "example",
  "activity_id": "example"
}

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

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