sequences

Attach contacts to a sequence step

post/v1/sequences/{sequenceId}/contacts

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

{"stackTrail":"paths:/v1/sequences/{sequenceId}/contacts:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"message":"Contacts added to sequence successfully","payload":{"id":1,"email":"user@example.com","isSubscribed":true,"createdAt":"2024-01-01T00:00:00.000Z"}}}

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 endpoint across all 1 revision of this API.