Skip to main content
POST
/
{custom_object_api_name}
/
{record_id}
/
relationship
/
{api_name}
curl --request POST \ --url https://api.reevo.ai/api/v2/public/{custom_object_api_name}/{record_id}/relationship/{api_name} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "related_record_id": "<target-uuid>" } '
{
  "parent": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "record_type": "<string>"
  },
  "api_name": "<string>",
  "item": {
    "related_record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "related_record_type": "<string>",
    "through": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "record_type": "<string>",
      "attributes": {}
    }
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}

Authorizations

​
Authorization
string
header
required

Reevo API key passed as Authorization: Bearer <api-key>.

Path Parameters

​
custom_object_api_name
string
required

Full custom-object api_name, including the cus_obj__ prefix (e.g. cus_obj__pet_crud_ab12cd). Discover available custom objects via GET /_organization_schema_summary.

Example:

"cus_obj__pet_crud_ab12cd"

​
record_id
string<uuid>
required
​
api_name
string
required

Body

application/json

Reference-or-match target shape shared by every relationship POST body.

Exactly one of related_record_id / related_record_match must be present; both or neither raises (mapped to field_value_invalid).

​
related_record_id
​
related_record_match
Related Record Match · object | null

Response

Successful Response

Response for POST / PATCH on one relationship edge.

Carries the single affected RelationshipItem (the write produced exactly one edge), unlike the paginated SingleRelationshipResponse which carries a list.

​
parent
ParentRef · object
required

Reference back to the parent record on a sub-resource response.

​
api_name
string
required
​
item
RelationshipItem · object
required

One related-record entry inside a RelationshipEnvelope.