Upsert CRM object access grant

PUT/v1/crm/object-types/{objectKind}/access

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

objectKindstringrequired

Request body

requiredapplication/json

access_levelstringrequired

principal_idstring

principal_typestringrequired

Responses

200OK

access_levelstringrequired

created_atstringrequired

idstringrequired

object_kindstringrequired

principal_idstring | nullrequired

principal_typestringrequired

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

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 PUT "/v1/crm/object-types/string/access" \
  -H "Content-Type: application/json" \
  -d '{
  "access_level": "string",
  "principal_id": "string",
  "principal_type": "string"
}'

const response = await fetch("/v1/crm/object-types/string/access", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "access_level": "string",
  "principal_id": "string",
  "principal_type": "string"
})
});

import requests

response = requests.put(
    "/v1/crm/object-types/string/access",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "access_level": "string",
  "principal_id": "string",
  "principal_type": "string"
},
)

Response

{
  "access_level": "string",
  "created_at": "string",
  "id": "string",
  "object_kind": "string",
  "principal_id": "string",
  "principal_type": "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"
  }
}