Create a task linked to a custom object record

POST

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

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/custom-objects/example/records/example/tasks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "assigned_to": "example", "title": "example", "description": "example", "type": "task", "due_date": "example", "due_time": "example", "priority": "low", "reminder_at": "example" }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Path Parameters

objectId

required

string

recordId

required

string

Request Body^required

Media typeapplication/json

object

assigned_to

required

string

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

title

required

string

>= 1 characters <= 500 characters

description

Any of:

string

string

<= 50000 characters

null

null

type

string

Allowed values: task call

due_date

required

string

due_time

Any of:

string

string

<= 20 characters

null

null

priority

string

Allowed values: low medium high

reminder_at

string | null

Responses

201

The new task

Media typeapplication/json

object

task

required

object

_id

required

string

title

required

string

key

additional properties

any

Example^generated

{
  "task": {
    "_id": "example",
    "title": "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"
    }
  ]
}