CRM Associations

POST

/api/v1/workspaces/{workspaceId}/crm/{objectSlug}/records/{recordId}/associations

Scope crm:write

Create an association between two CRM records.

Pfad

workspaceIdPflicht

string (uuid)

Workspace that owns the resource.

objectSlugPflicht

string

CRM object slug, for example contact.

recordIdPflicht

string (uuid)

CRM record identifier.

Request

application/json · CrmAssociationCreateDto

targetRecordId

string (uuid)

Identifier of the target record.

targetObjectSlugPflicht

string

Target object slug.

associationTypeId

string (uuid)

Identifier of the association type.

Antworten

200CrmAssociationDtoThe request succeeded. The JSON body contains url, data, and meta. The linked schema is data.

CRM association.

string (uuid)

Identifier.

associationTypeId

string (uuid)

Identifier of the association type.

associationTypeNamePflicht

string

Name of the association type.

associationTypeSlugPflicht

string

Association type slug.

associationLabel

string

Association label.

isOutgoing

boolean

Whether this is outgoing.

targetPflicht

CrmAssociationTargetRecordDto

createdByUserId

string (uuid)

Member who created this.

createdAt

string (date-time)

When this was created.

400ApiProblemThe request is invalid.

401ApiProblemThe private app token is missing or invalid.

403ApiProblemThe token is missing the required scope, or this action is not allowed.

404ApiProblemThe workspace or resource was not found.

defaultApiProblemError response.