sequences

Attach contacts to a sequence step

post/v1/sequences/{sequenceId}/contacts

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/contacts/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

sequenceIdstring required

Sequence ID

Request body

stepIdstring required

Sequence step ID

contactIdsstring[] required

Contact IDs to add

Example request

{
  "stepId": "bwOLEx4l8G",
  "contactIds": [
    "2dP27N0gZ4",
    "VMw56r9jPb"
  ]
}

Response

Contacts added to sequence successfully

unknown required

Example response

{
  "message": "Contacts added to sequence successfully",
  "payload": {
    "id": 1,
    "email": "user@example.com",
    "isSubscribed": true,
    "createdAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

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