{ "info": { "name": "anymail REST API", "description": "The anymail REST API v1. Every request carries a workspace API token (`sgn_…`) or an OAuth\naccess token (`amo_…`) in the `Authorization: Bearer` header. A token belongs to one workspace.\n\n- Rate limit: 60 requests per minute per token, `X-RateLimit-*` headers on every authenticated response.\n- Scopes: `read` allows GET, `write` allows POST, PATCH and DELETE. A missing scope returns `403` with `code: insufficient_scope`.\n- `X-Workspace` (optional): the workspace id you expect. Another id returns `403` with `code: workspace_forbidden`.\n- `Idempotency-Key` (optional) on POST, PATCH and DELETE, except `PATCH /prospects/{id}` and `DELETE /hooks/{id}`: a replay within 24 hours returns the stored response.\n- Lists use cursor pagination: `limit` (1 to 100, default 50) and `cursor` from `next_cursor`.\n\nHuman documentation: https://developers.anymail.watch\n", "version": "v1", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://app.anymail.watch/api/v1", "type": "string" }, { "key": "token", "value": "sgn_your_token", "type": "string" } ], "item": [ { "name": "Prospects", "item": [ { "name": "List or search prospects", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/prospects", "host": [ "{{baseUrl}}" ], "path": [ "prospects" ], "query": [ { "key": "q", "value": "", "description": "Search in email, first name, last name and company name or domain (substring, case-insensitive, up to 200 characters).", "disabled": true }, { "key": "email", "value": "", "description": "Exact address, case-insensitive.", "disabled": true }, { "key": "company_id", "value": "", "description": "", "disabled": true }, { "key": "status", "value": "", "description": "", "disabled": true }, { "key": "created_since", "value": "", "description": "", "disabled": true }, { "key": "limit", "value": "", "description": "", "disabled": true }, { "key": "cursor", "value": "", "description": "The `next_cursor` of the previous page.", "disabled": true } ] }, "description": "" } }, { "name": "Create a prospect", "request": { "method": "POST", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/prospects", "host": [ "{{baseUrl}}" ], "path": [ "prospects" ], "query": [ { "key": "campaign", "value": "", "description": "Enrol the new prospect in this draft or active campaign.", "disabled": true } ] }, "description": "Creates a prospect with the rules of the form in the app. With `campaign`, also enrols it in that campaign.", "body": { "mode": "raw", "raw": "{\n \"email\": \"ada@example.com\",\n \"first_name\": \"Ada\",\n \"company_name\": \"Example Ltd\",\n \"custom_fields\": {\n \"role\": \"CTO\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a prospect", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/prospects/:id", "host": [ "{{baseUrl}}" ], "path": [ "prospects", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" } }, { "name": "Update a prospect", "request": { "method": "PATCH", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/prospects/:id", "host": [ "{{baseUrl}}" ], "path": [ "prospects", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Send the full desired state. `email` is required.", "body": { "mode": "raw", "raw": "{\n \"email\": \"ada@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"company_name\": \"Example Ltd\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete or anonymise a prospect", "request": { "method": "DELETE", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/prospects/:id", "host": [ "{{baseUrl}}" ], "path": [ "prospects", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ], "query": [ { "key": "mode", "value": "", "description": "", "disabled": true } ] }, "description": "`mode=delete` (default) removes the prospect with its enrolments and events.\n`mode=anonymize` erases personal data, adds the address to the suppression list and stops active enrolments (GDPR erasure).\n" } } ] }, { "name": "Campaigns", "item": [ { "name": "List campaigns", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "campaigns" ], "query": [ { "key": "status", "value": "", "description": "", "disabled": true }, { "key": "folder_id", "value": "", "description": "", "disabled": true }, { "key": "archived", "value": "", "description": "", "disabled": true }, { "key": "limit", "value": "", "description": "", "disabled": true }, { "key": "cursor", "value": "", "description": "The `next_cursor` of the previous page.", "disabled": true } ] }, "description": "" } }, { "name": "Create a draft campaign", "request": { "method": "POST", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "campaigns" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q4 outbound\",\n \"mailbox_ids\": [\n \"b2c3d4e5-0000-4000-8000-000000000001\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a campaign with settings, steps and statistics", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/campaigns/:id", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" } }, { "name": "Update campaign settings", "request": { "method": "PATCH", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/campaigns/:id", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Only the fields you send change. `prospect_ids` only on a draft. `mailbox_ids` not on a running campaign.", "body": { "mode": "raw", "raw": "{\n \"daily_enroll_limit\": 30,\n \"schedule\": {\n \"start_hour\": 9,\n \"end_hour\": 17,\n \"send_days\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ]\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a draft campaign", "request": { "method": "DELETE", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/campaigns/:id", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" } }, { "name": "Start a draft or resume a paused campaign", "request": { "method": "POST", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/campaigns/:id/start", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":id", "start" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Sends real email. Checks mailboxes, steps, audience, missing fields and conflicts with other campaigns first." } }, { "name": "Stop a campaign for good", "request": { "method": "POST", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/campaigns/:id/stop", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":id", "stop" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Active enrolments become `stopped` and the campaign becomes `completed`. This cannot be undone." } }, { "name": "Pause a running campaign", "request": { "method": "POST", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/campaigns/:id/pause", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":id", "pause" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" } }, { "name": "Resume a paused campaign", "request": { "method": "POST", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/campaigns/:id/resume", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":id", "resume" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" } }, { "name": "List the enrolments of a campaign", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/campaigns/:id/prospects", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":id", "prospects" ], "variable": [ { "key": "id", "value": "", "description": "" } ], "query": [ { "key": "status", "value": "", "description": "", "disabled": true }, { "key": "limit", "value": "", "description": "", "disabled": true }, { "key": "cursor", "value": "", "description": "The `next_cursor` of the previous page.", "disabled": true } ] }, "description": "" } }, { "name": "Enrol existing prospects", "request": { "method": "POST", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/campaigns/:id/prospects", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":id", "prospects" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Send exactly one of `prospect_ids` or `emails`, 1 to 200 items. Each person gets a result.", "body": { "mode": "raw", "raw": "{\n \"emails\": [\n \"ada@example.com\",\n \"bob@example.com\"\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Steps", "item": [ { "name": "List the email steps with their variants", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/campaigns/:id/steps", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":id", "steps" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" } }, { "name": "Add an email step at the end", "request": { "method": "POST", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/campaigns/:id/steps", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":id", "steps" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Only on a draft or a paused campaign. Returns the whole sequence.", "body": { "mode": "raw", "raw": "{\n \"subject\": \"Quick question, {{first_name}}\",\n \"body\": \"Hi {{first_name}},\\n\\nAre you the right person to talk to about outbound at {{company}}?\",\n \"delay_days\": 0\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Edit an email step", "request": { "method": "PATCH", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/campaigns/:id/steps/:stepId", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":id", "steps", ":stepId" ], "variable": [ { "key": "id", "value": "", "description": "" }, { "key": "stepId", "value": "", "description": "" } ] }, "description": "Content fields change variant A. Other variants stay as they are.", "body": { "mode": "raw", "raw": "{\n \"delay_days\": 3\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete an email step", "request": { "method": "DELETE", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/campaigns/:id/steps/:stepId", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":id", "steps", ":stepId" ], "variable": [ { "key": "id", "value": "", "description": "" }, { "key": "stepId", "value": "", "description": "" } ] }, "description": "Later steps move up one position. The last remaining step cannot be deleted." } }, { "name": "Add an A/B variant", "request": { "method": "POST", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/campaigns/:id/steps/:stepId/variants", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":id", "steps", ":stepId", "variants" ], "variable": [ { "key": "id", "value": "", "description": "" }, { "key": "stepId", "value": "", "description": "" } ] }, "description": "Takes the next free label (B, C or D). Omitted fields are copied from variant A.", "body": { "mode": "raw", "raw": "{\n \"subject\": \"{{first_name}}, a question about {{company}}\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Edit an A/B variant", "request": { "method": "PATCH", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/campaigns/:id/steps/:stepId/variants/:label", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":id", "steps", ":stepId", "variants", ":label" ], "variable": [ { "key": "id", "value": "", "description": "" }, { "key": "stepId", "value": "", "description": "" }, { "key": "label", "value": "", "description": "Variant label, case-insensitive." } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"active\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete an A/B variant", "request": { "method": "DELETE", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/campaigns/:id/steps/:stepId/variants/:label", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":id", "steps", ":stepId", "variants", ":label" ], "variable": [ { "key": "id", "value": "", "description": "" }, { "key": "stepId", "value": "", "description": "" }, { "key": "label", "value": "", "description": "Variant label, case-insensitive." } ] }, "description": "" } } ] }, { "name": "Statistics", "item": [ { "name": "Campaign totals, funnel and per step and variant metrics", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/campaigns/:id/stats", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":id", "stats" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" } } ] }, { "name": "Companies", "item": [ { "name": "List companies with temperature", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/companies", "host": [ "{{baseUrl}}" ], "path": [ "companies" ], "query": [ { "key": "search", "value": "", "description": "", "disabled": true }, { "key": "temperature", "value": "", "description": "", "disabled": true }, { "key": "limit", "value": "", "description": "", "disabled": true }, { "key": "cursor", "value": "", "description": "The `next_cursor` of the previous page.", "disabled": true } ] }, "description": "" } }, { "name": "Get a company card", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" } } ] }, { "name": "Replies", "item": [ { "name": "List classified replies", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/replies", "host": [ "{{baseUrl}}" ], "path": [ "replies" ], "query": [ { "key": "classification", "value": "", "description": "", "disabled": true }, { "key": "since", "value": "", "description": "Received at or after this time (ISO 8601).", "disabled": true }, { "key": "campaign_id", "value": "", "description": "", "disabled": true }, { "key": "prospect_id", "value": "", "description": "", "disabled": true }, { "key": "limit", "value": "", "description": "", "disabled": true }, { "key": "cursor", "value": "", "description": "The `next_cursor` of the previous page.", "disabled": true } ] }, "description": "" } }, { "name": "Correct the classification of a reply", "request": { "method": "PATCH", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/replies/:id", "host": [ "{{baseUrl}}" ], "path": [ "replies", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"classification\": \"not_interested\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Inbox", "item": [ { "name": "List inbox messages with the full text", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/inbox/messages", "host": [ "{{baseUrl}}" ], "path": [ "inbox", "messages" ], "query": [ { "key": "category", "value": "", "description": "", "disabled": true }, { "key": "unread", "value": "", "description": "", "disabled": true }, { "key": "since", "value": "", "description": "Received at or after this time (ISO 8601).", "disabled": true }, { "key": "campaign_id", "value": "", "description": "", "disabled": true }, { "key": "prospect_id", "value": "", "description": "", "disabled": true }, { "key": "limit", "value": "", "description": "", "disabled": true }, { "key": "cursor", "value": "", "description": "The `next_cursor` of the previous page.", "disabled": true } ] }, "description": "" } }, { "name": "Reply to an inbox message", "request": { "method": "POST", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/inbox/messages/:id/reply", "host": [ "{{baseUrl}}" ], "path": [ "inbox", "messages", ":id", "reply" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Sends real email from the mailbox the message arrived in, in the same thread.", "body": { "mode": "raw", "raw": "{\n \"body\": \"Thanks Ada, Tuesday 10:00 works. I will send an invite.\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Offers", "item": [ { "name": "List sent offers", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/offers", "host": [ "{{baseUrl}}" ], "path": [ "offers" ], "query": [ { "key": "status", "value": "", "description": "", "disabled": true }, { "key": "prospect_id", "value": "", "description": "", "disabled": true }, { "key": "campaign_id", "value": "", "description": "", "disabled": true }, { "key": "limit", "value": "", "description": "", "disabled": true }, { "key": "cursor", "value": "", "description": "The `next_cursor` of the previous page.", "disabled": true } ] }, "description": "" } }, { "name": "Create an offer from HTML and send it", "request": { "method": "POST", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/offers", "host": [ "{{baseUrl}}" ], "path": [ "offers" ] }, "description": "Turns an HTML document into a tracked offer page for one prospect and, unless `send` is false, emails the link from the workspace mailboxes. The HTML is sanitised on the server.", "body": { "mode": "raw", "raw": "{\n \"prospect_id\": \"4c0f0f9e-0000-4000-8000-000000000001\",\n \"html\": \"

Offer

…

\",\n \"subject\": \"Our offer\",\n \"send\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List people who can be the contact on an offer", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/team", "host": [ "{{baseUrl}}" ], "path": [ "team" ] }, "description": "" } }, { "name": "Get an offer with its visits", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/offers/:id", "host": [ "{{baseUrl}}" ], "path": [ "offers", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" } } ] }, { "name": "Suppressions", "item": [ { "name": "List the suppression list of the workspace", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/suppressions", "host": [ "{{baseUrl}}" ], "path": [ "suppressions" ], "query": [ { "key": "kind", "value": "", "description": "", "disabled": true }, { "key": "limit", "value": "", "description": "", "disabled": true }, { "key": "cursor", "value": "", "description": "The `next_cursor` of the previous page.", "disabled": true } ] }, "description": "" } }, { "name": "Exclude an address or a domain", "request": { "method": "POST", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/suppressions", "host": [ "{{baseUrl}}" ], "path": [ "suppressions" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"target\": \"example.com\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove a suppression", "request": { "method": "DELETE", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/suppressions/:id", "host": [ "{{baseUrl}}" ], "path": [ "suppressions", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" } } ] }, { "name": "Webhook subscriptions", "item": [ { "name": "List subscriptions", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/hooks", "host": [ "{{baseUrl}}" ], "path": [ "hooks" ], "query": [ { "key": "limit", "value": "", "description": "", "disabled": true }, { "key": "cursor", "value": "", "description": "The `next_cursor` of the previous page.", "disabled": true } ] }, "description": "" } }, { "name": "Subscribe a URL to an event", "request": { "method": "POST", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/hooks", "host": [ "{{baseUrl}}" ], "path": [ "hooks" ] }, "description": "The same pair of `event` and `target_url` returns the existing subscription with `200`.", "body": { "mode": "raw", "raw": "{\n \"event\": \"new_reply\",\n \"target_url\": \"https://hooks.example.com/anymail\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Recent payloads of one event", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/hooks/samples", "host": [ "{{baseUrl}}" ], "path": [ "hooks", "samples" ], "query": [ { "key": "event", "value": "", "description": "", "disabled": true } ] }, "description": "Up to three latest payloads delivered for `event`, newest first, in the webhook payload format. Empty until a subscription to that event received a delivery. Meant for the test step of no-code triggers." } }, { "name": "Unsubscribe", "request": { "method": "DELETE", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/hooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "hooks", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" } } ] }, { "name": "Mailboxes", "item": [ { "name": "List mailboxes", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/mailboxes", "host": [ "{{baseUrl}}" ], "path": [ "mailboxes" ] }, "description": "" } }, { "name": "Connect a mailbox with SMTP and IMAP", "request": { "method": "POST", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mailboxes", "host": [ "{{baseUrl}}" ], "path": [ "mailboxes" ] }, "description": "Tests the connection first and saves nothing when it fails. Use an app password. Hosts on private networks are refused. The password is never returned.", "body": { "mode": "raw", "raw": "{\n \"email\": \"ada@acme.com\",\n \"password\": \"app-password\",\n \"host\": \"mail.acme.com\",\n \"from_name\": \"Ada Lovelace\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a mailbox", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/mailboxes/:id", "host": [ "{{baseUrl}}" ], "path": [ "mailboxes", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "" } }, { "name": "Update mailbox settings", "request": { "method": "PATCH", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true }, { "key": "Idempotency-Key", "value": "", "description": "1 to 255 characters. A replay within 24 hours returns the stored response with `Idempotent-Replayed true`.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mailboxes/:id", "host": [ "{{baseUrl}}" ], "path": [ "mailboxes", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"daily_limit\": 40\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Domains", "item": [ { "name": "List sending domains with SPF, DKIM and DMARC", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/domains", "host": [ "{{baseUrl}}" ], "path": [ "domains" ] }, "description": "" } } ] }, { "name": "Workspaces", "item": [ { "name": "List the workspaces of this token", "request": { "method": "GET", "header": [ { "key": "X-Workspace", "value": "", "description": "The workspace id you expect. Another workspace than the one of the token returns 403.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/workspaces", "host": [ "{{baseUrl}}" ], "path": [ "workspaces" ] }, "description": "" } } ] } ] }