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.

Add a note to a lead

POST
/api/v1/activity/note
curl --request POST \
  --url https://api.pitch2sale.com/api/v1/activity/note \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "lead_id": "example", "contact_id": "example", "body": "example", "body_text": "example", "is_pinned": true, "activity_at": "2026-04-15T12:00:00Z", "custom_fields": { "additionalProperty": "example" }, "attachments": [ { "url": "https://example.com", "content_type": "example", "size_bytes": 1, "filename": "example", "file_id": "example" } ] }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
lead_id
required
string
/^[0-9a-fA-F]{24}$/
contact_id
string
/^[0-9a-fA-F]{24}$/
body
required
string
>= 1 characters
body_text
string
is_pinned
boolean
activity_at
string format: date-time
custom_fields
object
key
additional properties
attachments
Array<object>
<= 10 items
object
url
required
string format: uri
<= 2048 characters
content_type
required
string
>= 1 characters <= 256 characters /^[a-zA-Z0-9!#$&^_.+-]+\/[a-zA-Z0-9!#$&^_.+-]+$/
size_bytes
required
integer
> 0 <= 26214400
filename
required
string
>= 1 characters <= 500 characters
file_id
string
Examplegenerated
{
  "lead_id": "example",
  "contact_id": "example",
  "body": "example",
  "body_text": "example",
  "is_pinned": true,
  "activity_at": "2026-04-15T12:00:00Z",
  "custom_fields": {
    "additionalProperty": "example"
  },
  "attachments": [
    {
      "url": "https://example.com",
      "content_type": "example",
      "size_bytes": 1,
      "filename": "example",
      "file_id": "example"
    }
  ]
}

Responses

Section titled “Responses”

201

Section titled “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
Examplegenerated
{
  "activity": {
    "_id": "example",
    "type": "example",
    "lead_id": "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"
    }
  ]
}

402

Section titled “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
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"
    }
  ]
}