Skip to main content
POST
/
api
/
v2
/
account
/
{account_id}
/
relationship
/
{api_name}
curl --request POST \
  --url https://api.example.com/api/v2/account/{account_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": {}
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
account_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

Response

Successful Response

Response for POST / PATCH on one relationship edge (contracts/07 §7.3-7.4).

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.