Sequences

Choose Sequence Related Record And Enroll

Choose the record (as PUT), then enrol exactly this contact in the sequence.

ENROLLING STARTS THE CONTACT'S SENDS once the sequence is live, so it needs the launch access that running the sequence needs and the run tier. Only this contact is enrolled: nobody else on the sequence's list is. Safe to retry: an enrolled contact reports already_enrolled; not_enrolled carries the reason.

NOTE: STARTING a sequence (POST /sequences/{id}/run) enrols its WHOLE associated list, every contact on it, not just contacts you chose. To enrol a single contact, use this route on a sequence that is already live.

post/sequences/{sequence_id}/related-records/enroll

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/sequences/{sequence_id}/related-records/enroll
  • 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.