Log an activity or note on a custom object record

POST

/api/v1/custom-objects/{objectId}/records/{recordId}/activities

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/custom-objects/example/records/example/activities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "type": "call", "direction": "inbound", "subject": "example", "body": "example", "body_text": "example", "status": "example", "duration_seconds": 1, "metadata": { "additionalProperty": "example" }, "is_pinned": true, "activity_at": "example", "custom_activity_type_id": "example" }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Path Parameters

objectId

required

string

recordId

required

string

Request Body^required

Media typeapplication/json

object

type

required

string

Allowed values: call email email_thread sms whatsapp meeting note task_completed lead_status_change opportunity_status_change lead_merge form_submission custom

direction

Any of:

string

string

Allowed values: inbound outbound

null

null

subject

Any of:

string

string

<= 500 characters

null

null

body

Any of:

string

string

<= 50000 characters

null

null

body_text

Any of:

string

string

<= 50000 characters

null

null

status

Any of:

string

string

<= 80 characters

null

null

duration_seconds

Any of:

integer

integer

null

null

metadata

Any of:

object

object

key

additional properties

null

null

is_pinned

boolean

activity_at

string | null

custom_activity_type_id

Any of:

string

string

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

null

null

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