Preview CRM attribute rename impact

POST/v1/crm/object-types/{objectKind}/attributes/{attributeID}/rename-preview

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

objectKindstringrequired

attributeIDstringrequired

Request body

requiredapplication/json

new_keystringrequired

Responses

200OK

fromstringrequired

history_valuesinteger<int64>required

mapsobjectrequired

object_kindstringrequired

operationstringrequired

record_page_referencesinteger<int64>required

record_valuesinteger<int64>required

tostringrequired

view_filtersinteger<int64>required

view_sortsinteger<int64>required

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

409Conflict

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 POST "/v1/crm/object-types/string/attributes/string/rename-preview" \
  -H "Content-Type: application/json" \
  -d '{
  "new_key": "string"
}'

const response = await fetch("/v1/crm/object-types/string/attributes/string/rename-preview", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "new_key": "string"
})
});

import requests

response = requests.post(
    "/v1/crm/object-types/string/attributes/string/rename-preview",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "new_key": "string"
},
)

Response

{
  "from": "string",
  "history_values": 0,
  "maps": {},
  "object_kind": "string",
  "operation": "string",
  "record_page_references": 0,
  "record_values": 0,
  "to": "string",
  "view_filters": 0,
  "view_sorts": 0
}

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

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