Update CRM custom object type

PATCH/v1/crm/custom-object-types/{objectKind}

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

objectKindstringrequired

Request body

requiredapplication/json

descriptionstring

icon_keystring

is_activeboolean

labelstring

metadataany

plural_labelstring

primary_display_fieldstring

Responses

200OK

backing_entitystringrequired

backing_tablestringrequired

domainstringrequired

explicitbooleanrequired

generalizedbooleanrequired

icon_keystringrequired

kindstringrequired

labelstringrequired

plural_labelstringrequired

primary_display_fieldstringrequired

supported_capabilitiesstring[] | nullrequired

supports_custom_fieldsbooleanrequired

supports_listsbooleanrequired

supports_relationshipsbooleanrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X PATCH "/v1/crm/custom-object-types/string" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "string",
  "icon_key": "string",
  "is_active": true,
  "label": "string",
  "metadata": "string",
  "plural_label": "string",
  "primary_display_field": "string"
}'

const response = await fetch("/v1/crm/custom-object-types/string", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "description": "string",
  "icon_key": "string",
  "is_active": true,
  "label": "string",
  "metadata": "string",
  "plural_label": "string",
  "primary_display_field": "string"
})
});

import requests

response = requests.patch(
    "/v1/crm/custom-object-types/string",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "description": "string",
  "icon_key": "string",
  "is_active": True,
  "label": "string",
  "metadata": "string",
  "plural_label": "string",
  "primary_display_field": "string"
},
)

Response

{
  "backing_entity": "string",
  "backing_table": "string",
  "domain": "string",
  "explicit": true,
  "generalized": true,
  "icon_key": "string",
  "kind": "string",
  "label": "string",
  "plural_label": "string",
  "primary_display_field": "string",
  "supported_capabilities": [
    "string"
  ],
  "supports_custom_fields": true,
  "supports_lists": true,
  "supports_relationships": true
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}