Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Sequence

sequence.add

Beta

This endpoint is in beta and may not be available for all organizations.

Enrolls a candidate in a reusable sourcing sequence. Set start to false to create an editable draft, or true to validate and start the sequence immediately.

The optional applicationId fixes the application used for token resolution. The optional from.email must be a Primary, PersonalAlias, or OrganizationAlias address returned by emailSender.list for the same acting user. NoReply is never accepted, even when returned by emailSender.list. This excludes both Ashby's no-reply address and custom-domain no-reply addresses sent through Ashby's email infrastructure. Passing any no-reply or otherwise unavailable address returns sequence_sender_not_allowed. Requests made with x-on-behalf-of create a draft owned by that user.

If validation errors or required actions block an immediate start, the sequence is returned as NotStarted with a structured Blocked startResult. If a draft already exists for the same candidate, template, and acting user, sequence_draft_already_exists includes its id in errorInfo.meta.existingSequenceId.

Requires the sourcingWrite permission.

post/sequence.add

Request body

sequenceTemplateIdstring uuid required

The reusable sourcing sequence template to use

candidateIdstring uuid required

The candidate to enroll in the sequence

applicationIdstring uuid

The candidate's application to use for token resolution

startboolean required

Whether to validate and start the sequence immediately after creating it

Response

Responses from the sequence.add endpoint

OR

Example response

{
  "success": true,
  "results": {
    "sequence": {
      "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "candidateId": "26906e15-ff36-4ed3-b25b-de806d7852f7",
      "applicationId": "71c2be26-cd82-4b9f-8e61-3ca2ed94c9a7",
      "sequenceTemplateId": "97f36cec-3736-4f14-b1e2-ec60a132efab",
      "status": "NotStarted",
      "createdAt": "2026-07-22T12:34:56.000Z",
      "stages": [
        {
          "id": "cc506f71-e2a3-438e-9130-a90b5f350ce3",
          "type": "Email",
          "from": {
            "email": "gob@example.com",
            "displayName": "Gob Bluth"
          },
          "subject": "A simple subject",
          "bodyHtml": "<p>Hello</p>",
          "sendAfter": {
            "kind": "NoDelay"
          }
        }
      ]
    },
    "startResult": null
  }
}