Create CRM record relationship

POST/v1/crm/object-types/{objectKind}/records/{objectID}/relationships

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

objectKindstringrequired

objectIDstringrequired

Request body

requiredapplication/json

is_primarybooleanrequired

metadataany

relationship_definition_idstringrequired

rolestring

to_object_idstringrequired

to_object_kindstringrequired

Responses

200OK

created_atstringrequired

from_object_idstringrequired

from_object_kindstringrequired

idstringrequired

is_primarybooleanrequired

metadataanyrequired

related_object_idstringrequired

related_object_kindstringrequired

relationship_definition_idstringrequired

relationship_keystringrequired

rolestring

to_object_idstringrequired

to_object_kindstringrequired

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 POST "/v1/crm/object-types/string/records/string/relationships" \
  -H "Content-Type: application/json" \
  -d '{
  "is_primary": true,
  "metadata": "string",
  "relationship_definition_id": "string",
  "role": "string",
  "to_object_id": "string",
  "to_object_kind": "string"
}'

const response = await fetch("/v1/crm/object-types/string/records/string/relationships", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "is_primary": true,
  "metadata": "string",
  "relationship_definition_id": "string",
  "role": "string",
  "to_object_id": "string",
  "to_object_kind": "string"
})
});

import requests

response = requests.post(
    "/v1/crm/object-types/string/records/string/relationships",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "is_primary": True,
  "metadata": "string",
  "relationship_definition_id": "string",
  "role": "string",
  "to_object_id": "string",
  "to_object_kind": "string"
},
)

Response

{
  "created_at": "string",
  "from_object_id": "string",
  "from_object_kind": "string",
  "id": "string",
  "is_primary": true,
  "metadata": "string",
  "related_object_id": "string",
  "related_object_kind": "string",
  "relationship_definition_id": "string",
  "relationship_key": "string",
  "role": "string",
  "to_object_id": "string",
  "to_object_kind": "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"
  }
}