Preview CRM custom object type rename impact

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

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

objectKindstringrequired

Request body

requiredapplication/json

new_kindstringrequired

Responses

200OK

activity_eventsinteger<int64>required

attributesinteger<int64>required

deleted_recordsinteger<int64>required

enriched_datainteger<int64>required

export_jobsinteger<int64>required

fromstringrequired

import_jobsinteger<int64>required

list_entriesinteger<int64>required

listsinteger<int64>required

mapsobjectrequired

operationstringrequired

record_pagesinteger<int64>required

recordsinteger<int64>required

relationshipsinteger<int64>required

tostringrequired

viewsinteger<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/custom-object-types/string/rename-preview" \
  -H "Content-Type: application/json" \
  -d '{
  "new_kind": "string"
}'

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

import requests

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

Response

{
  "activity_events": 0,
  "attributes": 0,
  "deleted_records": 0,
  "enriched_data": 0,
  "export_jobs": 0,
  "from": "string",
  "import_jobs": 0,
  "list_entries": 0,
  "lists": 0,
  "maps": {},
  "operation": "string",
  "record_pages": 0,
  "records": 0,
  "relationships": 0,
  "to": "string",
  "views": 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"
  }
}