Update a field of a custom object type

PUT

/api/v1/custom-objects/{id}/fields/{fieldId}

curl --request PUT \
  --url https://api.pitch2sale.com/api/v1/custom-objects/example/fields/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "label": "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" }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Path Parameters

id

required

string

fieldId

required

string

Request Body^required

Media typeapplication/json

object

label

string

>= 1 characters <= 200 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

Example^generated

{
  "label": "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"
}

Responses

200

OK

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