---
title: "Stop an email sequence for someone"
method: POST
path: "/email-sequences/{id}/stop"
tags: ["Email"]
---

# Stop an email sequence for someone

`POST /email-sequences/{id}/stop`

## Request

- Base URL: `https://api.hypamoon.com/api/v1`
- URL: `https://api.hypamoon.com/api/v1/email-sequences/{id}/stop`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://app.hypamoon.com/oauth/authorize`, token URL `https://api.hypamoon.com/oauth/token`, scopes: `messages:write`)

For example when the person replied. Steps that were scheduled for them are not sent.

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `email` string, required

## Response `200`

Stopped.

- object
  - `id` string, uuid, required
  - `sequence_id` string, uuid, required
  - `email` string, required
  - `status` 'active' | 'completed' | 'stopped', required
  - `step` integer, required: The step that is next (0 is the first).
  - `next_send_at` string, date-time, nullable, required
  - `stop_reason` string, nullable, required: Why it stopped: unsubscribed, stopped, or the event (like order.paid).
  - `created_at` string, date-time, required

## Other responses

- `400`: Bad Request: invalid_json.
- `401`: Unauthorized: unauthorized, missing_api_key, invalid_api_key, api_key_revoked, project_deleted.
- `403`: Forbidden: project_not_enabled, key_mode_mismatch, missing_scope, verification_required.
- `404`: Not Found: not_found.
- `422`: Unprocessable Content: validation_failed.
- `429`: Too Many Requests: rate_limited.
- `500`: Internal Server Error: internal_error.
- `503`: Service Unavailable: service_unavailable.

---

[API](https://skmtc.dev/hypamoon/apis/hypamoon-api.md) · [All operations](https://skmtc.dev/hypamoon/apis/hypamoon-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hypamoon/apis/hypamoon-api/revisions/9f0b90004c06?raw)