SequenceStates

Enroll a prospect in a sequence

Enrolls a prospect into a sequence, creating a new sequence state.

When enrolling on behalf of a user, respect the sequence's privacy (returned by GET /v1/sequences/{id}): enroll into private sequences only on behalf of their owner.

post/sequenceStates

Request

  • Base URL: https://partner-api.nooks.in/v1
  • URL: https://partner-api.nooks.in/v1/sequenceStates
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://oauth.nooks.in/oauth/authorize, token URL https://oauth.nooks.in/oauth/token, scopes: sequence-states:write)

Request body

Example request

{
  "data": {
    "prospect": {
      "id": "770e8400-e29b-41d4-a716-446655440003"
    },
    "sequence": {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    },
    "owner": {
      "id": "KKLvN5wQoghWFwUvC75CZ12QM7I3"
    },
    "state": "active",
    "mailbox": {
      "id": "bb0e8400-e29b-41d4-a716-446655440040"
    },
    "scheduledAt": "2025-12-01T09:00:00-05:00",
    "sequenceStep": {
      "id": "aa0e8400-e29b-41d4-a716-446655440051"
    },
    "emailOverrides": {
      "aa0e8400-e29b-41d4-a716-446655440050": {
        "subject": "Custom subject for step",
        "body": "<p>Custom email body</p>"
      }
    },
    "enrich": {
      "phoneNumbers": true
    }
  }
}

Response

Prospect successfully enrolled in sequence

idstring uuid required

Unique identifier for the sequence state

state'active' | 'paused' | 'finished' | 'pending_start' required

Current state of the enrollment:

  • active: Prospect is actively progressing through the sequence
  • paused: Enrollment is temporarily paused
  • finished: Enrollment has completed or been stopped
  • pending_start: Enrolled but queued behind the sequence's start throttle; no tasks exist yet and nothing has been sent
createdAtstring date-time required

When the enrollment was created

updatedAtstring date-time required

When the enrollment was last updated

Example response

{
  "id": "880e8400-e29b-41d4-a716-446655440010",
  "state": "active",
  "sequence": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "prospect": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "account": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "creator": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "owner": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "sequenceStep": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "createdAt": "2025-11-01T10:00:00.000Z",
  "updatedAt": "2025-11-05T14:30:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.