---
title: "Choose Sequence Related Record"
method: PUT
path: "/sequences/{sequence_id}/related-records"
tags: ["Sequences"]
---

# Choose Sequence Related Record

`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

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.

## Path parameters

- `sequence_id` string, required: Sequence id.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- ChooseRelatedRecordRequest
  - `contact_id` integer, required
  - `definition_id` string, uuid, required: The relationship definition the record is linked through.
  - `record_id` string, uuid, required: The linked custom-object record whose fields personalise this contact's sends.

## Response `200`

Successful Response

- ApiResponseSequenceRelatedRecordsPayload
  - `data` SequenceRelatedRecordsPayload, required: Related-record variables, pins or an enrolment result for a sequence.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)