Skip to content

Create Relationship Definition

POST
/objects/{object_slug}/relationships

Define a relationship from this object to another custom object or to contacts, companies or deals.

Schema administration: needs objects:manage and Admin access. A refusal’s detail is {code, message}: slug_conflict / schema_change_in_progress (409), not_found (404, the target), source_not_found (404), unsupported_target (422).

Authorizations

Parameters

Path Parameters

object_slug
required
string

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
api_slug
required
string
>= 1 characters <= 100 characters /^[a-z][a-z0-9_]*$/
source_label
required
string
>= 1 characters <= 100 characters
source_many
boolean
default: true
target
required
object
kind
required
string
Allowed values: custom contacts companies deals
object_id
Any of:
string format: uuid
target_label
required
string
>= 1 characters <= 100 characters
target_many
boolean
default: true

Responses

201

Successful Response

object
data
required
object
api_slug
required
string
created_at
required
string format: date-time
id
required
string format: uuid
is_archived
required
boolean
revision
required
integer
source_kind
required
string
source_label
required
string
source_many
required
boolean
source_object_definition_id
required
Any of:
string format: uuid
target_kind
required
string
target_label
required
string
target_many
required
boolean
target_object_definition_id
required
Any of:
string format: uuid
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string