# Cooper Email endpoint reference

One page per HTTP endpoint, with a request example, a response example, the error codes named for that route, and idempotency.

HTML: https://cooperemail.com/docs/reference

- [POST /api/v1/onboard](https://cooperemail.com/docs/reference/onboard.md)
- [POST /api/v1/recover](https://cooperemail.com/docs/reference/recover.md)
- [GET /api/v1/recover/confirm](https://cooperemail.com/docs/reference/recover-confirm.md)
- [GET /api/v1/usernames/check](https://cooperemail.com/docs/reference/username-check.md)
- [POST /api/v1/keys](https://cooperemail.com/docs/reference/auth.md)
- [GET /api/v1/keys](https://cooperemail.com/docs/reference/keys-list.md)
- [GET /api/v1/keys/:id](https://cooperemail.com/docs/reference/keys-get.md)
- [PATCH /api/v1/keys/:id](https://cooperemail.com/docs/reference/keys-rename.md)
- [DELETE /api/v1/keys/:id](https://cooperemail.com/docs/reference/keys-revoke.md)
- [GET /api/v1/oauth/grants](https://cooperemail.com/docs/reference/oauth-grants.md)
- [GET /api/v1/oauth/grants/:client_id](https://cooperemail.com/docs/reference/oauth-grant.md)
- [DELETE /api/v1/oauth/grants/:client_id](https://cooperemail.com/docs/reference/oauth-grant-revoke.md)
- [POST /api/v1/inboxes/:id/keys](https://cooperemail.com/docs/reference/inbox-keys.md)
- [GET /api/v1/me](https://cooperemail.com/docs/reference/me.md)
- [PATCH /api/v1/me](https://cooperemail.com/docs/reference/me-patch.md)
- [GET /api/v1/lifecycle/unsubscribe](https://cooperemail.com/docs/reference/lifecycle-unsubscribe.md)
- [POST /api/v1/lifecycle/unsubscribe](https://cooperemail.com/docs/reference/lifecycle-unsubscribe-post.md)
- [POST /api/v1/inboxes](https://cooperemail.com/docs/reference/inboxes-create.md)
- [POST /api/v1/inboxes/:id/notify](https://cooperemail.com/docs/reference/inbox-notify.md)
- [GET /api/v1/inboxes/:id/wait](https://cooperemail.com/docs/reference/inbox-wait.md)
- [GET /api/v1/inboxes/:id/wait-for-code](https://cooperemail.com/docs/reference/inbox-wait-for-code.md)
- [POST /api/v1/inboxes/batch](https://cooperemail.com/docs/reference/inboxes-batch.md)
- [GET /api/v1/inboxes?q=support&limit=100](https://cooperemail.com/docs/reference/inboxes-list.md)
- [PATCH /api/v1/inboxes/:id](https://cooperemail.com/docs/reference/inboxes-update.md)
- [DELETE /api/v1/inboxes/:id](https://cooperemail.com/docs/reference/inboxes-delete.md)
- [POST /api/v1/workspaces](https://cooperemail.com/docs/reference/workspaces-create.md)
- [GET /api/v1/workspaces](https://cooperemail.com/docs/reference/workspaces-list.md)
- [GET /api/v1/workspaces/:id](https://cooperemail.com/docs/reference/workspaces-get.md)
- [PATCH /api/v1/workspaces/:id](https://cooperemail.com/docs/reference/workspaces-update.md)
- [DELETE /api/v1/workspaces/:id](https://cooperemail.com/docs/reference/workspaces-delete.md)
- [GET /api/v1/workspaces/:id/inboxes](https://cooperemail.com/docs/reference/workspaces-inboxes.md)
- [DELETE /api/v1/workspaces/:id/inboxes/:inboxId](https://cooperemail.com/docs/reference/workspaces-inbox-delete.md)
- [POST /api/v1/inboxes/:id/messages](https://cooperemail.com/docs/reference/send.md)
- [POST /api/v1/inboxes/:id/messages/:msgId/reply](https://cooperemail.com/docs/reference/reply.md)
- [POST /api/v1/inboxes/:id/messages/:msgId/reply-all](https://cooperemail.com/docs/reference/reply-all.md)
- [POST /api/v1/inboxes/:id/messages/:msgId/forward](https://cooperemail.com/docs/reference/forward.md)
- [GET /api/v1/inboxes/:id/messages](https://cooperemail.com/docs/reference/list-messages.md)
- [GET /api/v1/inboxes/:id/messages/search?q=invoice](https://cooperemail.com/docs/reference/search-messages.md)
- [POST /api/v1/inboxes/:id/messages/batch-get](https://cooperemail.com/docs/reference/batch-get-messages.md)
- [POST /api/v1/inboxes/:id/messages/batch-update](https://cooperemail.com/docs/reference/batch-update-messages.md)
- [GET /api/v1/inboxes/:id/messages/:msgId](https://cooperemail.com/docs/reference/messages.md)
- [DELETE /api/v1/inboxes/:id/messages/:msgId](https://cooperemail.com/docs/reference/delete-message.md)
- [GET /api/v1/inboxes/:id/messages/:msgId/raw](https://cooperemail.com/docs/reference/message-raw.md)
- [GET /api/v1/inboxes/:id/messages/:msgId/attachments/:attId](https://cooperemail.com/docs/reference/message-attachment.md)
- [GET /api/v1/inboxes/:id/messages/:msgId/attachments/:attId/text](https://cooperemail.com/docs/reference/attachment-text.md)
- [GET /api/v1/inboxes/:id/threads?limit=20](https://cooperemail.com/docs/reference/list-threads.md)
- [GET /api/v1/threads?inbox_id=&limit=20](https://cooperemail.com/docs/reference/list-threads-account.md)
- [GET /api/v1/inboxes/:id/threads/:threadId?limit=100](https://cooperemail.com/docs/reference/get-thread.md)
- [GET /api/v1/inboxes/:id/threads/search?q=invoice](https://cooperemail.com/docs/reference/search-threads.md)
- [PATCH /api/v1/inboxes/:id/threads/:threadId](https://cooperemail.com/docs/reference/update-thread.md)
- [DELETE /api/v1/inboxes/:id/threads/:threadId](https://cooperemail.com/docs/reference/delete-thread.md)
- [GET /api/v1/inboxes/:id/threads/:threadId/attachments/:attId](https://cooperemail.com/docs/reference/thread-attachment.md)
- [PATCH /api/v1/inboxes/:id/messages/:msgId](https://cooperemail.com/docs/reference/update-message.md)
- [POST /api/v1/inboxes/:id/messages/:msgId/read](https://cooperemail.com/docs/reference/mark-message-read.md)
- [POST /api/v1/inboxes/:id/messages/:msgId/release](https://cooperemail.com/docs/reference/release-message.md)
- [POST /api/v1/inboxes/:id/inbound](https://cooperemail.com/docs/reference/inbound.md)
- [GET /api/v1/search?q=](https://cooperemail.com/docs/reference/search.md)
- [POST /api/v1/domains](https://cooperemail.com/docs/reference/domains.md)
- [GET /api/v1/domains/:id](https://cooperemail.com/docs/reference/domain-status.md)
- [POST /api/v1/domains/:id/verify](https://cooperemail.com/docs/reference/domain-verify.md)
- [DELETE /api/v1/domains/:id](https://cooperemail.com/docs/reference/domain-delete.md)
- [GET /api/v1/domains/:id/zone-file](https://cooperemail.com/docs/reference/domain-zone-file.md)
- [GET /api/v1/events](https://cooperemail.com/docs/reference/events.md)
- [GET /api/v1/inboxes/:id/events](https://cooperemail.com/docs/reference/inbox-events.md)
- [GET /api/v1/metrics/events](https://cooperemail.com/docs/reference/metrics-events.md)
- [GET /api/v1/metrics/usage](https://cooperemail.com/docs/reference/metrics-usage.md)
- [GET /api/v1/metrics/rates](https://cooperemail.com/docs/reference/metrics-rates.md)
- [GET /api/v1/events/stream](https://cooperemail.com/docs/reference/events-stream.md)
- [POST /api/v1/webhooks](https://cooperemail.com/docs/reference/webhooks.md)
- [GET /api/v1/webhooks/:id](https://cooperemail.com/docs/reference/webhook-get.md)
- [POST /api/v1/webhooks/:id/rotate-secret](https://cooperemail.com/docs/reference/webhook-rotate-secret.md)
- [POST /api/v1/webhooks/:id/test](https://cooperemail.com/docs/reference/webhook-test.md)
- [GET /api/v1/webhooks/:id/deliveries](https://cooperemail.com/docs/reference/webhook-deliveries.md)
- [POST /api/v1/webhooks/:id/deliveries/:deliveryId/redeliver](https://cooperemail.com/docs/reference/webhook-redeliver.md)
- [POST /api/v1/inboxes/:id/owners](https://cooperemail.com/docs/reference/owners.md)
- [PATCH /api/v1/inboxes/:id/owners/:ownerId](https://cooperemail.com/docs/reference/owner-email-style.md)
- [POST /api/v1/updates](https://cooperemail.com/docs/reference/updates.md)
- [GET /api/v1/tasks?status=pending](https://cooperemail.com/docs/reference/tasks.md)
- [POST /api/v1/tasks/:id/reply](https://cooperemail.com/docs/reference/task-reply.md)
- [GET/POST /api/v1/suppressions](https://cooperemail.com/docs/reference/suppressions.md)
- [DELETE /api/v1/suppressions/:address](https://cooperemail.com/docs/reference/suppressions-delete.md)
- [GET/POST /api/v1/lists/:direction/:type](https://cooperemail.com/docs/reference/lists.md)
- [GET/DELETE /api/v1/lists/:direction/:type/:entry](https://cooperemail.com/docs/reference/lists-entry.md)
- [GET/POST /api/v1/inboxes/:id/lists/:direction/:type](https://cooperemail.com/docs/reference/inbox-lists.md)
- [GET/POST /api/v1/inboxes/:id/drafts](https://cooperemail.com/docs/reference/drafts.md)
- [GET/PATCH/DELETE /api/v1/inboxes/:id/drafts/:draftId](https://cooperemail.com/docs/reference/draft.md)
- [POST /api/v1/inboxes/:id/drafts/:draftId/send](https://cooperemail.com/docs/reference/draft-send.md)
- [GET /api/v1/drafts](https://cooperemail.com/docs/reference/drafts-account.md)
- [GET /api/v1/inboxes/:id/drafts/:draftId/attachments/:attId](https://cooperemail.com/docs/reference/draft-attachment.md)
- [GET/DELETE /api/v1/inboxes/:id/lists/:direction/:type/:entry](https://cooperemail.com/docs/reference/inbox-lists-entry.md)
- [POST /api/v1/inboxes/:id/phone-number](https://cooperemail.com/docs/reference/provision-phone-number.md)
- [GET /api/v1/inboxes/:id/phone-number](https://cooperemail.com/docs/reference/get-phone-number.md)
- [DELETE /api/v1/inboxes/:id/phone-number](https://cooperemail.com/docs/reference/release-phone-number.md)
- [POST /api/v1/inboxes/:id/sms](https://cooperemail.com/docs/reference/send-sms.md)
- [GET /api/v1/phone-numbers](https://cooperemail.com/docs/reference/list-phone-numbers.md)
- [GET /api/v1/phone-numbers/available?area_code=415](https://cooperemail.com/docs/reference/search-phone-numbers.md)