Sign in

v4

latestOpenAPI 3.0.22026-07-3188146256.6 KB
Relations

addRelations

Relates one or more entities to parent entity by adding items to a relation attribute

post/v1/entity/{slug}/{id}/relations

Path parameters

slugstring required

URL-friendly identifier for the entity schema

Example:contact

Entity Type

idstring uuid required

Entity id

Query parameters

asyncboolean

Don't wait for updated entity to become available in Search API. Useful for large migrations

string ulid

See https://github.com/ulid/spec

OR
'' | 'null' nullable
Example:01F130Q52Q6MWSNS8N2AVXV4JN

Activity to include in event feed

Request body

entity_idstring uuid required
org_idstring

Organization Id the entity belongs to

_schemastring

URL-friendly identifier for the entity schema

attributestring required
_tagsstring[]
reverseboolean

Whether this is a reverse relation

Example request

[
  {
    "_schema": "contact"
  }
]

Response

Success

entity_idstring uuid required
org_idstring

Organization Id the entity belongs to

_schemastring

URL-friendly identifier for the entity schema

attributestring required
_tagsstring[]
reverseboolean

Whether this is a reverse relation

Example response

{
  "_schema": "contact"
}