Sequences

Choose Sequence Related Record

Use record_id for this contact's related fields of definition_id in this sequence. Enrols nobody.

The record must be a live record of a relationship the credential may read, linked to the contact through it, and the contact must be inside the key's contact scope and belong to the sequence; otherwise 404 "Record unavailable". A choice replaces any earlier one. Needs write access to the sequence.

put/sequences/{sequence_id}/related-records

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/sequences/{sequence_id}/related-records
  • Auth: HTTP bearer

Path parameters

sequence_idstring required

Sequence id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

contact_idinteger required
definition_idstring uuid required

The relationship definition the record is linked through.

record_idstring uuid required

The linked custom-object record whose fields personalise this contact's sends.

Response

Successful Response

dataSequenceRelatedRecordsPayload required

Related-record variables, pins or an enrolment result for a sequence.

Changes

No recorded changes to this operation across all 2 revisions of this API.