sequences

Get sequence step variants

get/v1/sequences/{sequenceId}/steps/{stepId}

Request

Base URL
https://developer.saleshandy.com (the document declares no server; this is the origin it was published from)
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/saleshandy/apis/develop-with-saleshandy/docs/v1/sequences/:sequenceId/steps/:stepId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

sequenceIdstring required

The ID of the sequence

stepIdstring required

The ID of the step

Response

Sequence step variants fetched successfully

idstring

Unique identifier for the sequence step variant

taskNotestring

Optional note associated with the variant task

statusnumber

Status of the variant (0: Inactive, 1: Active)

typenumber

Type of the sequence step (1: Email, 2: LinkedInConnectionRequest, 3: LinkedInMessage, 4: LinkedInInMail, 5: LinkedInViewProfile, 9: Custom, 11-15: Call variants, 16-18: WhatsApp variants)

executionTypenumber

Execution type of the step (1: Automated, 2: Manual)

stepStatusnumber

Status of the parent step (0: Inactive, 1: Active)

Example response

[
  {
    "id": "MAwgmlAKaN",
    "payload": {
      "content": "<div><span style=\"font-family: sans-serif; font-size: 13px;\">Sample email content</span></div>",
      "preheader": "Sample preheader",
      "subject": "Sample email subject",
      "connectionNote": "LinkedIn Connection Note",
      "message": "Sample LinkedIn InMail message",
      "title": "Sample Custom Title",
      "action": {
        "url": "https://example.com",
        "name": "Visit Example Website"
      }
    },
    "status": 1,
    "type": 1,
    "executionType": 1,
    "stepStatus": 1
  }
]

Changes

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