Create a custom object type

POST

/api/v1/custom-objects

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/custom-objects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "api_identifier": "example", "label_singular": "example", "label_plural": "example", "description": "example", "icon": "example", "color": "example", "is_active": true, "fields": [ { "label": "example", "type": "text", "reference_target": { "kind": "custom", "object_definition_id": "example", "entity": "lead", "cardinality": "one" }, "key": "example", "is_required": true, "default_value": "example", "choices": [ "example" ], "is_unique": true, "is_indexed": true, "is_searchable": true, "is_sortable": true, "is_filterable": true, "order": 1, "editable_role_ids": [ "example" ], "help_text": "example" } ] }'

Defines a new entity type with its fields. api_identifier cannot be changed later.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

api_identifier

required

string

>= 3 characters <= 50 characters

label_singular

required

string

>= 1 characters <= 100 characters

label_plural

required

string

>= 1 characters <= 100 characters

description

Any of:

string

string

<= 1000 characters

null

null

icon

Any of:

string

string

<= 50 characters

null

null

color

Any of:

string

string

<= 7 characters

null

null

is_active

boolean

fields

Array<object>

<= 500 items

object

label

required

string

>= 1 characters <= 200 characters

type

required

string

Allowed values: text number date boolean choice multi_choice rich_text url email phone reference

reference_target

Any of:

object

object

kind

required

string

Allowed values: custom standard

object_definition_id

Any of:

string

string

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

null

null

entity

Any of:

string

string

Allowed values: lead contact opportunity

null

null

cardinality

string

Allowed values: one

null

null

key

string

>= 1 characters <= 64 characters

is_required

boolean

default_value

choices

Array<string>

<= 500 items

is_unique

boolean

is_indexed

boolean

is_searchable

boolean

is_sortable

boolean

is_filterable

boolean

order

integer

editable_role_ids

Array<string>

help_text

Any of:

string

string

<= 500 characters

null

null

Responses

201

The new object type

Media typeapplication/json

object

custom_object

required

object

_id

required

string

api_identifier

required

string

label_singular

required

string

label_plural

required

string

description

required

string | null

fields

required

Array<object>

object

_id

required

string

key

required

string

label

required

string

type

required

string

is_required

required

boolean

key

additional properties

any

is_active

required

boolean

is_archived

required

boolean

created_at

required

string

updated_at

required

string

key

additional properties

any

Example^generated

{
  "custom_object": {
    "_id": "example",
    "api_identifier": "example",
    "label_singular": "example",
    "label_plural": "example",
    "description": "example",
    "fields": [
      {
        "_id": "example",
        "key": "example",
        "label": "example",
        "type": "example",
        "is_required": true
      }
    ],
    "is_active": true,
    "is_archived": true,
    "created_at": "example",
    "updated_at": "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"
    }
  ]
}