MOmonaco
Sequences

Update a Sequence

Changed on

Applies a state transition to a sequence (see the action field for valid values and their meanings). Returns the refreshed sequence representation, including its tasks.

patch/v1/sequences/{sequence_id}

Request

  • Base URL
    https://api.monaco.com
  • URL
    https://api.monaco.com/v1/sequences/{sequence_id}
  • Auth
    none declared

Path parameters

sequence_idstring uuid required

Request body

action'pause' | 'resume' | 'stop' | 'enqueue' | 'exclude' required

User-callable state transitions on a sequence.

Intentionally a subset of campaigns.schemas.SequenceActionEnum: system-only transitions (success, fail) and the payload-bearing update_copy transition are excluded.

Response

Successful Response

Example response

{
  "data": {
    "id": "seq_abc123",
    "contact_id": "con_def456",
    "name": "Enterprise Onboarding",
    "description": "Multi-touch onboarding sequence for enterprise accounts",
    "status": "started",
    "template_id": "seqt_789ghi",
    "created_at": "2026-01-15T10:30:00Z",
    "updated_at": "2026-05-10T14:22:00Z",
    "last_interaction": "Email today",
    "enqueued_at": "2026-01-16T09:00:00Z",
    "started_at": "2026-01-16T09:05:00Z",
    "responded_at": "2026-01-20T11:30:00Z",
    "meeting_booked_at": "2026-01-22T15:00:00Z",
    "sender_id": "usr_jkl012",
    "sender_name": "Alex Rivera",
    "exclusion_info": {
      "rule_name": "account_cooldown",
      "description": "Account was contacted within the cooldown window",
      "overridability": "HARD"
    },
    "tasks": [
      {
        "id": "tsk_abc123",
        "sequence_id": "seq_def456",
        "order": 1,
        "name": "Send intro email",
        "scheduled_at": "2026-05-15T09:00:00Z",
        "completed_at": "2026-05-15T10:00:00Z",
        "hold_until": "2026-05-15T16:00:00Z"
      }
    ]
  }
}

Changes

  • fc720ada2a81Revision changes
    • warning

      added the new call_back_later enum value to the //// response property for the response status

    • warning

      added the new contact_not_enrichable enum value to the //// response property for the response status

    • warning

      added the new email_enrichment_failed enum value to the //// response property for the response status

    • warning

      added the new email_transient_provider_error enum value to the //// response property for the response status

    • warning

      added the new email_verification_failed enum value to the //// response property for the response status

    • warning

      added the new email_verification_unavailable enum value to the //// response property for the response status

    • warning

      added the new interested enum value to the //// response property for the response status

    • warning

      added the new invalid_or_wrong_number enum value to the //// response property for the response status

    • warning

      added the new linkedin_access_restricted enum value to the //// response property for the response status

    • warning

      added the new linkedin_account_paused enum value to the //// response property for the response status

    • warning

      added the new linkedin_already_connected enum value to the //// response property for the response status

    • warning

      added the new linkedin_empty_message enum value to the //// response property for the response status

    • warning

      added the new linkedin_inmail_not_accepted enum value to the //// response property for the response status

    • warning

      added the new linkedin_request_rejected enum value to the //// response property for the response status

    • warning

      added the new linkedin_seat_without_inmail enum value to the //// response property for the response status

    • warning

      added the new linkedin_self_invite enum value to the //// response property for the response status

    • warning

      added the new linkedin_subscription_required enum value to the //// response property for the response status

    • warning

      added the new linkedin_transient_provider_error enum value to the //// response property for the response status

    • warning

      added the new mailbox_token_expired enum value to the //// response property for the response status

    • warning

      added the new meeting_scheduled enum value to the //// response property for the response status

    • warning

      added the new no_sending_mailbox enum value to the //// response property for the response status

    • warning

      added the new not_interested enum value to the //// response property for the response status

    • warning

      added the new phone_not_found enum value to the //// response property for the response status

    • warning

      added the new voicemail enum value to the //// response property for the response status

    • info

      added the new exclude enum value to the request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status