Skip to navigation
HeyReach APICampaigns

GetCampaignSequenceV2

View as Markdown

Retrieves the current sequence (workflow) of a campaign with every message version in full - text and voice alike.

The v2 version of GetCampaignSequence, and the read to use for a campaign with voice notes. A MESSAGE node’s payload carries messageVersions: every version of the step, voice versions included, each with the length and transcript of the recording behind it.

The returned object can be sent as-is in the sequence field of CreateV2 and UpdateSequenceV2. Do not send it to the v1 Create or UpdateSequence: they refuse a non-empty messageVersions with 400. Returns an empty 200 response if the campaign has no sequence.

Query Parameters

  • campaignId (long, required): The campaign whose sequence to retrieve.

What the response contains

The node and message version fields are described on UpdateSequenceV2. Every node type other than MESSAGE returns the same payload as GetCampaignSequence, including its rules for the SEND_LEAD_TO_* external lead flags.

  • A STATIC voice version that holds a recording reports the recording’s durationMs and transcript. Its staticClipTranscript is always the recording’s own transcript, and its importedTranscript is null.

  • A STATIC version without a recording has staticClipId: null and needsRecording: true - for example a step that arrived in a shared sequence, which never carries audio. It shows the transcripts it arrived with in staticClipTranscript and importedTranscript. Give it a recording before you send the sequence back (see UpdateSequenceV2).

  • A version whose staticClipId is not a recording in your workspace comes back with that id and with durationMs, transcript and staticClipTranscript set to null. The read still answers 200, but sending that version back is rejected with 400 STATIC_CLIP_NOT_FOUND.

  • message on a STATIC version is always empty ("" or null).

  • TEXT and DYNAMIC versions return staticClipId, durationMs, transcript, staticClipTranscript and importedTranscript as null, and needsRecording as false.

Errors

  • 404 CAMPAIGN_NOT_FOUND: no campaign with this id in the workspace.
  • 404 CAMPAIGN_API_NOT_ENABLED: the campaign API is not enabled for your account.

Headers

X-API-KEYstringOptional

API key header using this scheme. Example: “X-API-KEY: {API_KEY}”

Query parameters

campaignIdlongRequired
The campaign whose sequence to retrieve.

Response

OK. The body is empty when the campaign has no sequence.
nodeTypeenum
The action or check this node performs. Required on every node.
actionDelayintegerOptional0-100Defaults to 0

The wait before this node runs, in actionDelayUnit. A node after an action step needs at least 3 hours - see UpdateSequenceV2.

actionDelayUnitenumOptionalDefaults to HOUR

Unit of actionDelay.

Allowed values:
payloadobject or map from strings to anyOptional

Node-specific configuration. A MESSAGE node uses the v2 message payload; every other node type uses its v1 payload (see UpdateSequence). VIEW_PROFILE, FOLLOW, FIND_EMAIL, CHECK_IS_CONNECTION, CHECK_IS_OPEN_PROFILE and END have no payload.

conditionalNodeobjectOptional

The next node when the branching condition is true. On MESSAGE and INMAIL, the END node taken when the lead replies.

unconditionalNodeobjectOptional

The next node to follow unconditionally, or when a branching condition is false. Required for every node except END.

externalReferencestring or nullOptional<=100 characters
Your own tracking ID for this step. Left out of responses when not set.

Errors

404
Get Campaign Sequence V2campaigns Request Not Found Error