Sequences

List Sequence Related Fields

The variables (related.<definition>.<attribute>) a step can use from a contact's linked custom-object records.

Only relationships to contacts whose custom object the credential may read (its own object grants) are offered, and only fields it may see. supported_step_types lists the step types whose sends fill them. 404 while the organisation's relationships or record_context custom-object switch is off.

get/sequencer/related-fields

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/sequencer/related-fields
  • Auth: HTTP bearer

Query parameters

step_typestring nullable

Only the variables a step of this type can use.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

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.