Update CRM object attribute

PATCH/v1/crm/object-types/{objectKind}/attributes/{attributeID}

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

objectKindstringrequired

attributeIDstringrequired

Request body

requiredapplication/json

default_valueany

descriptionstring

display_orderinteger<int32>required

field_typestringrequired

is_activebooleanrequired

is_multiselectbooleanrequired

is_requiredbooleanrequired

is_uniquebooleanrequired

labelstringrequired

optionsany

Responses

200OK

created_atstringrequired

default_valueanyrequired

descriptionstring | nullrequired

display_orderinteger<int32>required

field_typestringrequired

idstringrequired

is_activebooleanrequired

is_multiselectbooleanrequired

is_requiredbooleanrequired

is_uniquebooleanrequired

keystringrequired

labelstringrequired

object_kindstringrequired

optionsanyrequired

relationshipCRMAttributeRelationship

Show properties

cardinalitystringrequired

directionstringrequired

paired_attribute_idstring

paired_attribute_keystringrequired

paired_object_kindstringrequired

related_object_kindstringrequired

relationship_definition_idstringrequired

relationship_keystringrequired

sourcestringrequired

updated_atstringrequired

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/object-types/string/attributes/string" \
  -H "Content-Type: application/json" \
  -d '{
  "default_value": "string",
  "description": "string",
  "display_order": 0,
  "field_type": "string",
  "is_active": true,
  "is_multiselect": true,
  "is_required": true,
  "is_unique": true,
  "label": "string",
  "options": "string"
}'

const response = await fetch("/v1/crm/object-types/string/attributes/string", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "default_value": "string",
  "description": "string",
  "display_order": 0,
  "field_type": "string",
  "is_active": true,
  "is_multiselect": true,
  "is_required": true,
  "is_unique": true,
  "label": "string",
  "options": "string"
})
});

import requests

response = requests.patch(
    "/v1/crm/object-types/string/attributes/string",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "default_value": "string",
  "description": "string",
  "display_order": 0,
  "field_type": "string",
  "is_active": True,
  "is_multiselect": True,
  "is_required": True,
  "is_unique": True,
  "label": "string",
  "options": "string"
},
)

Response

{
  "created_at": "string",
  "default_value": "string",
  "description": "string",
  "display_order": 0,
  "field_type": "string",
  "id": "string",
  "is_active": true,
  "is_multiselect": true,
  "is_required": true,
  "is_unique": true,
  "key": "string",
  "label": "string",
  "object_kind": "string",
  "options": "string",
  "relationship": {
    "cardinality": "string",
    "direction": "string",
    "paired_attribute_id": "string",
    "paired_attribute_key": "string",
    "paired_object_kind": "string",
    "related_object_kind": "string",
    "relationship_definition_id": "string",
    "relationship_key": "string"
  },
  "source": "string",
  "updated_at": "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"
  }
}

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