POST /whatsapp/send

POST

/api/v1/whatsapp/send

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/whatsapp/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "account_id": "example", "to": "example", "body": "", "lead_id": "example", "contact_id": "example", "attachment": { "s3_key": "example", "filename": "example", "content_type": "example" } }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

account_id

required

string

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

to

required

string

>= 1 characters <= 30 characters

body

string

"" <= 4096 characters

lead_id

required

string

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

contact_id

string

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

attachment

object

s3_key

required

string

>= 1 characters <= 512 characters

filename

required

string

>= 1 characters <= 255 characters

content_type

required

string

>= 1 characters <= 255 characters

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