Log an SMS on a lead

POST

/api/v1/activity/sms

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/activity/sms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "lead_id": "example", "contact_id": "example", "direction": "inbound", "body": "example", "body_text": "example", "metadata": { "additionalProperty": "example" }, "is_pinned": true, "activity_at": "2026-04-15T12:00:00Z", "custom_fields": { "additionalProperty": "example" } }'

Records an SMS on the timeline; it does not send one.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

lead_id

required

string

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

contact_id

string

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

direction

required

string

Allowed values: inbound outbound

body

required

string

>= 1 characters

body_text

string

metadata

object

key

additional properties

is_pinned

boolean

activity_at

string format: date-time

custom_fields

object

key

additional properties

Responses

201

The new activity

Media typeapplication/json

object

activity

required

object

_id

required

string

type

required

string

lead_id

required

string | null

key

additional properties

any

Example^generated

{
  "activity": {
    "_id": "example",
    "type": "example",
    "lead_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"
    }
  ]
}

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