{ "openapi": "3.1.0", "info": { "title": "Inboxed API", "version": "1.0.0", "description": "The Inboxed REST API. Authenticate with a workspace API key from Settings → API: `Authorization: Bearer ibx_…`. 600 requests a minute per key; every answer carries RateLimit-* headers. Errors are JSON: {\"error\", \"code\"}. List endpoints page with `limit` and `cursor` (default 50, at most 100)." }, "servers": [ { "url": "https://inboxed.si/api/v1" } ], "security": [ { "apiKey": [] } ], "tags": [ { "name": "Campaigns" }, { "name": "Leads" }, { "name": "Suppressions" }, { "name": "Mailboxes" }, { "name": "Inbox" }, { "name": "Wallet" }, { "name": "Webhooks" } ], "paths": { "/campaigns": { "get": { "operationId": "listCampaigns", "tags": [ "Campaigns" ], "summary": "List campaigns", "description": "Scope: `read`.", "x-scope": "read", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Items per page, 1 to 100.", "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "The next_cursor from the previous page.", "schema": { "type": "string", "maxLength": 200 } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "draft", "setting_up", "active", "paused", "completed", "stopped" ] } } ], "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "next_cursor" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Campaign" } }, "next_cursor": { "type": [ "string", "null" ], "description": "Pass as cursor to get the next page; null on the last page." } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/campaigns/{id}": { "get": { "operationId": "getCampaign", "tags": [ "Campaigns" ], "summary": "Get a campaign", "description": "Scope: `read`.", "x-scope": "read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Campaign" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/campaigns/{id}/stats": { "get": { "operationId": "getCampaignStats", "tags": [ "Campaigns" ], "summary": "Campaign stats", "description": "Results and how many enrolled leads are in each state. Rates are fractions (0.05 = 5%); opens are estimates.\n\nScope: `read`.", "x-scope": "read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CampaignStats" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/campaigns/{id}/pause": { "post": { "operationId": "pauseCampaign", "tags": [ "Campaigns" ], "summary": "Pause a campaign", "description": "Free. Unsent emails aren’t charged.\n\nScope: `campaigns:write`.", "x-scope": "campaigns:write", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Any unique string (e.g. a UUID). Retrying with the same key within 24 hours returns the first answer instead of doing it twice.", "schema": { "type": "string", "maxLength": 255 } } ], "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Campaign" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/campaigns/{id}/resume": { "post": { "operationId": "resumeCampaign", "tags": [ "Campaigns" ], "summary": "Resume a campaign", "description": "Starts sending (and charging) again. Needs wallet balance, the campaigns:launch scope, and a key creator who is still a manager.\n\nScope: `campaigns:launch` (spends: the key’s creator must still have the role).", "x-scope": "campaigns:launch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Any unique string (e.g. a UUID). Retrying with the same key within 24 hours returns the first answer instead of doing it twice.", "schema": { "type": "string", "maxLength": 255 } } ], "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Campaign" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/campaigns/{id}/leads": { "post": { "operationId": "addCampaignLeads", "tags": [ "Campaigns" ], "summary": "Add leads to a running campaign", "description": "Copies existing leads (leadIds) or creates new ones (leads, verified on add) in the campaign’s list and enrols them. Up to 1000 per request. This sends more emails, so it needs campaigns:launch.\n\nScope: `campaigns:launch` (spends: the key’s creator must still have the role).", "x-scope": "campaigns:launch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Any unique string (e.g. a UUID). Retrying with the same key within 24 hours returns the first answer instead of doing it twice.", "schema": { "type": "string", "maxLength": 255 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "leadIds": { "description": "Existing leads (any list) to copy into the campaign's list.", "maxItems": 1000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "leads": { "description": "New leads to add to the campaign's list (verified on add).", "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "minLength": 3, "maxLength": 254 }, "firstName": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "timezone": { "description": "IANA time zone, e.g. Europe/Ljubljana.", "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ] }, "country": { "description": "ISO 3166 alpha-2.", "anyOf": [ { "type": "string", "pattern": "^[A-Za-z]{2}$" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ] }, "companySize": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 10000000 }, { "type": "null" } ] }, "language": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}$" }, { "type": "null" } ] }, "custom": { "description": "Custom fields by snake_case key, usable as {{key}} in emails.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string", "maxLength": 500 } } }, "required": [ "email" ], "additionalProperties": false } } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "campaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "copied": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "created": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "enrolled": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "invalid": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "error": { "type": "string" } }, "required": [ "email" ], "additionalProperties": false } }, "maxEmails": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pricePerEmail": { "type": "string" }, "note": { "type": "string" } }, "required": [ "campaignId", "copied", "created", "enrolled", "invalid", "maxEmails", "pricePerEmail", "note" ], "additionalProperties": false } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/campaigns/{id}/leads/remove": { "post": { "operationId": "removeCampaignLeads", "tags": [ "Campaigns" ], "summary": "Stop leads in a campaign", "description": "Stops leads for good (by leadIds or emails). They get no more emails and are never charged. Leads that replied or bounced are left alone.\n\nScope: `campaigns:write`.", "x-scope": "campaigns:write", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Any unique string (e.g. a UUID). Retrying with the same key within 24 hours returns the first answer instead of doing it twice.", "schema": { "type": "string", "maxLength": 255 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "leadIds": { "maxItems": 1000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "emails": { "maxItems": 1000, "type": "array", "items": { "type": "string", "maxLength": 254 } } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "campaignId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "stopped": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "leads": { "type": "array", "items": { "type": "object", "properties": { "leadId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "email": { "type": "string" } }, "required": [ "leadId", "email" ], "additionalProperties": false } } }, "required": [ "campaignId", "stopped", "leads" ], "additionalProperties": false } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/lists": { "get": { "operationId": "listLists", "tags": [ "Leads" ], "summary": "List lead lists", "description": "Scope: `read`.", "x-scope": "read", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Items per page, 1 to 100.", "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "The next_cursor from the previous page.", "schema": { "type": "string", "maxLength": 200 } } ], "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "next_cursor" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LeadList" } }, "next_cursor": { "type": [ "string", "null" ], "description": "Pass as cursor to get the next page; null on the last page." } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "createList", "tags": [ "Leads" ], "summary": "Create a list", "description": "Scope: `leads:write`.", "x-scope": "leads:write", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Any unique string (e.g. a UUID). Retrying with the same key within 24 hours returns the first answer instead of doing it twice.", "schema": { "type": "string", "maxLength": 255 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/LeadList" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/lists/{id}": { "get": { "operationId": "getList", "tags": [ "Leads" ], "summary": "Get a list", "description": "Scope: `read`.", "x-scope": "read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/LeadList" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "renameList", "tags": [ "Leads" ], "summary": "Rename a list", "description": "Scope: `leads:write`.", "x-scope": "leads:write", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/LeadList" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "operationId": "deleteList", "tags": [ "Leads" ], "summary": "Delete a list and its leads", "description": "Refused (409) while a running campaign uses the list.\n\nScope: `leads:write`.", "x-scope": "leads:write", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "deletedLeads": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "ok", "id", "deletedLeads" ], "additionalProperties": false } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/lists/{id}/leads": { "get": { "operationId": "listLeads", "tags": [ "Leads" ], "summary": "List leads in a list", "description": "Scope: `read`.", "x-scope": "read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page, 1 to 100.", "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "The next_cursor from the previous page.", "schema": { "type": "string", "maxLength": 200 } } ], "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "next_cursor" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Lead" } }, "next_cursor": { "type": [ "string", "null" ], "description": "Pass as cursor to get the next page; null on the last page." } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "upsertLeads", "tags": [ "Leads" ], "summary": "Create or update leads", "description": "One lead object, or {\"leads\": [...]} with up to 1000. Addresses already in the list are updated with the fields you send; repeats in one request count once. New addresses are verified before they’re stored. A single invalid lead returns 422; in bulk, each item reports its own result.\n\nScope: `leads:write`.", "x-scope": "leads:write", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Any unique string (e.g. a UUID). Retrying with the same key within 24 hours returns the first answer instead of doing it twice.", "schema": { "type": "string", "maxLength": 255 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "email": { "type": "string", "minLength": 3, "maxLength": 254 }, "firstName": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "timezone": { "description": "IANA time zone, e.g. Europe/Ljubljana.", "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ] }, "country": { "description": "ISO 3166 alpha-2.", "anyOf": [ { "type": "string", "pattern": "^[A-Za-z]{2}$" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ] }, "companySize": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 10000000 }, { "type": "null" } ] }, "language": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}$" }, { "type": "null" } ] }, "custom": { "description": "Custom fields by snake_case key, usable as {{key}} in emails.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string", "maxLength": 500 } } }, "required": [ "email" ], "additionalProperties": false }, { "type": "object", "properties": { "leads": { "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "minLength": 3, "maxLength": 254 }, "firstName": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "timezone": { "description": "IANA time zone, e.g. Europe/Ljubljana.", "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ] }, "country": { "description": "ISO 3166 alpha-2.", "anyOf": [ { "type": "string", "pattern": "^[A-Za-z]{2}$" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ] }, "companySize": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 10000000 }, { "type": "null" } ] }, "language": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}$" }, { "type": "null" } ] }, "custom": { "description": "Custom fields by snake_case key, usable as {{key}} in emails.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string", "maxLength": 500 } } }, "required": [ "email" ], "additionalProperties": false } } }, "required": [ "leads" ] } ] } } } }, "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/LeadUpsertResult" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/leads/{id}": { "get": { "operationId": "getLead", "tags": [ "Leads" ], "summary": "Get a lead", "description": "Scope: `read`.", "x-scope": "read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Lead" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "updateLead", "tags": [ "Leads" ], "summary": "Update a lead", "description": "Send only the fields to change. custom keys are merged.\n\nScope: `leads:write`.", "x-scope": "leads:write", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "timezone": { "description": "IANA time zone, e.g. Europe/Ljubljana.", "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ] }, "country": { "description": "ISO 3166 alpha-2.", "anyOf": [ { "type": "string", "pattern": "^[A-Za-z]{2}$" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ] }, "companySize": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 10000000 }, { "type": "null" } ] }, "language": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}$" }, { "type": "null" } ] }, "custom": { "description": "Custom fields by snake_case key, usable as {{key}} in emails.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string", "maxLength": 500 } } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Lead" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/suppressions": { "get": { "operationId": "listSuppressions", "tags": [ "Suppressions" ], "summary": "List the suppress list", "description": "Scope: `read`.", "x-scope": "read", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 100, "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 400 } }, { "name": "reason", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "unsubscribe", "bounce", "complaint", "manual", "crm" ] } } ], "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "next_cursor" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Suppression" } }, "next_cursor": { "type": [ "string", "null" ], "description": "Pass as cursor to get the next page; null on the last page." } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "addSuppressions", "tags": [ "Suppressions" ], "summary": "Add emails or domains", "description": "Live sequences to these addresses (or domains) stop straight away.\n\nScope: `suppressions:write`.", "x-scope": "suppressions:write", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Any unique string (e.g. a UUID). Retrying with the same key within 24 hours returns the first answer instead of doing it twice.", "schema": { "type": "string", "maxLength": 255 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "entries": { "minItems": 1, "maxItems": 10000, "type": "array", "items": { "type": "string", "maxLength": 300 }, "description": "Emails, or domains (acme.com or @acme.com) to block a whole company." } }, "required": [ "entries" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "added": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "alreadyListed": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "invalid": { "type": "array", "items": { "type": "string" } }, "stoppedEnrollments": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "added", "alreadyListed", "invalid", "stoppedEnrollments" ], "additionalProperties": false } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/suppressions/{entry}": { "delete": { "operationId": "removeSuppression", "tags": [ "Suppressions" ], "summary": "Remove an entry", "description": "URL-encode the email or @domain. Unsubscribes and spam complaints can’t be removed (409).\n\nScope: `suppressions:write`.", "x-scope": "suppressions:write", "parameters": [ { "name": "entry", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "entry": { "type": "string" } }, "required": [ "ok", "entry" ], "additionalProperties": false } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/erasure": { "post": { "operationId": "erasePerson", "tags": [ "Suppressions" ], "summary": "Erase a person (GDPR)", "description": "Deletes everything the workspace holds about this address and keeps a hash so they’re never emailed again. Can’t be undone. Admin scope.\n\nScope: `admin` (spends: the key’s creator must still have the role).", "x-scope": "admin", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Any unique string (e.g. a UUID). Retrying with the same key within 24 hours returns the first answer instead of doing it twice.", "schema": { "type": "string", "maxLength": 255 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "maxLength": 254, "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "email" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "emailHash": { "type": "string" }, "counts": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number" } } }, "required": [ "ok", "emailHash", "counts" ], "additionalProperties": false } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/mailboxes": { "get": { "operationId": "listMailboxes", "tags": [ "Mailboxes" ], "summary": "List mailboxes", "description": "Scope: `read`.", "x-scope": "read", "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Mailbox" } } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/mailboxes/{id}": { "get": { "operationId": "getMailbox", "tags": [ "Mailboxes" ], "summary": "Mailbox status", "description": "Connection status, today’s sends, last reply sync and the last DNS check.\n\nScope: `read`.", "x-scope": "read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/MailboxDetail" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/conversations": { "get": { "operationId": "listConversations", "tags": [ "Inbox" ], "summary": "List conversations", "description": "Newest first. Filter by status, intent or campaign.\n\nScope: `read`.", "x-scope": "read", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "open", "waiting", "snoozed", "closed" ] } }, { "name": "intent", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 40 } }, { "name": "campaignId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 } } ], "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "next_cursor" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Conversation" } }, "next_cursor": { "type": [ "string", "null" ], "description": "Pass as cursor to get the next page; null on the last page." } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/conversations/{id}": { "get": { "operationId": "getConversation", "tags": [ "Inbox" ], "summary": "Get a conversation with its messages", "description": "Scope: `read`.", "x-scope": "read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "lead": { "type": "string" }, "email": { "type": "string" }, "company": { "type": [ "string", "null" ] }, "subject": { "type": "string" }, "intent": { "type": [ "string", "null" ] }, "priority": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "reason": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "open", "waiting", "snoozed", "closed" ] }, "unread": { "type": "boolean" }, "campaignId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "lastMessageAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "ISO 8601 timestamp" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "ISO 8601 timestamp" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } } }, "required": [ "id", "lead", "email", "company", "subject", "intent", "priority", "reason", "status", "unread", "campaignId", "lastMessageAt", "createdAt", "messages" ], "additionalProperties": false } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/conversations/{id}/messages": { "get": { "operationId": "listMessages", "tags": [ "Inbox" ], "summary": "List messages", "description": "Oldest first; next_cursor is the last message id.\n\nScope: `read`.", "x-scope": "read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page, 1 to 100.", "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "The next_cursor from the previous page.", "schema": { "type": "string", "maxLength": 200 } } ], "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "next_cursor" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } }, "next_cursor": { "type": [ "string", "null" ], "description": "Pass as cursor to get the next page; null on the last page." } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/conversations/{id}/replies": { "post": { "operationId": "replyToConversation", "tags": [ "Inbox" ], "summary": "Reply to a conversation", "description": "Saves a reply in the team inbox. It waits for a manager’s approval, unless you send \"send\": true and the key’s creator can approve replies (manager or above): then it goes out from the conversation’s mailbox within a minute. Replies are free.\n\nScope: `inbox:write`.", "x-scope": "inbox:write", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Any unique string (e.g. a UUID). Retrying with the same key within 24 hours returns the first answer instead of doing it twice.", "schema": { "type": "string", "maxLength": 255 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string", "minLength": 1, "maxLength": 20000 }, "send": { "type": "boolean" } }, "required": [ "body" ] } } } }, "responses": { "201": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "approval": { "type": "string", "enum": [ "pending", "approved" ] }, "message": { "type": "string" } }, "required": [ "ok", "id", "approval", "message" ], "additionalProperties": false } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/wallet": { "get": { "operationId": "getWallet", "tags": [ "Wallet" ], "summary": "Wallet balance", "description": "Scope: `read`.", "x-scope": "read", "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "properties": { "balance": { "type": "string" }, "emailsCovered": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "balance", "emailsCovered" ], "additionalProperties": false } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/hooks": { "get": { "operationId": "listHooks", "tags": [ "Webhooks" ], "summary": "List hook subscriptions", "description": "Scope: `read`.", "x-scope": "read", "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/HookSubscription" } } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "subscribeHook", "tags": [ "Webhooks" ], "summary": "Subscribe a URL to an event", "description": "target_url must be https and resolve to a public address. Subscribing the same URL to the same event again returns the existing subscription.\n\nScope: `read`.", "x-scope": "read", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Any unique string (e.g. a UUID). Retrying with the same key within 24 hours returns the first answer instead of doing it twice.", "schema": { "type": "string", "maxLength": 255 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "enum": [ "campaign.completed", "campaign.paused", "email.bounced", "email.clicked", "email.opened", "email.sent", "lead.added", "lead.hot", "lead.unsubscribed", "mailbox.disconnected", "reply.interested", "reply.received" ] }, "target_url": { "type": "string", "minLength": 1, "maxLength": 2000 }, "source": { "default": "api", "type": "string", "enum": [ "zapier", "make", "n8n", "api" ] } }, "required": [ "event", "target_url" ] } } } }, "responses": { "201": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HookSubscription" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/hooks/{id}": { "delete": { "operationId": "unsubscribeHook", "tags": [ "Webhooks" ], "summary": "Delete a hook subscription", "description": "Scope: `read`.", "x-scope": "read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "ok", "id" ], "additionalProperties": false } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/hooks/sample": { "get": { "operationId": "hookSample", "tags": [ "Webhooks" ], "summary": "Sample event", "description": "An array with one object shaped exactly like a delivery: recent real data, or a made-up one marked \"example\": true.\n\nScope: `read`.", "x-scope": "read", "parameters": [ { "name": "event", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "campaign.completed", "campaign.paused", "email.bounced", "email.clicked", "email.opened", "email.sent", "lead.added", "lead.hot", "lead.unsubscribed", "mailbox.disconnected", "reply.interested", "reply.received" ] } } ], "responses": { "200": { "description": "OK", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "event": { "type": "string" }, "sentAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "ISO 8601 timestamp" }, "data": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "type": "boolean" } }, "required": [ "event", "sentAt", "data" ], "additionalProperties": false } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key lacks the scope, the creator lacks the role, or the IP isn’t allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (600).", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "webhooks": { "campaign.completed": { "post": { "summary": "Campaign finished", "description": "A campaign has emailed every lead it will email.\n\nSigned with `X-Inboxed-Signature: sha256=` using the workspace webhook secret.", "parameters": [ { "name": "X-Inboxed-Event", "in": "header", "schema": { "type": "string", "const": "campaign.completed" } }, { "name": "X-Inboxed-Delivery", "in": "header", "description": "Unique per delivery; use it to ignore repeats.", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Inboxed-Signature", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "event", "sentAt", "data" ], "properties": { "event": { "const": "campaign.completed" }, "sentAt": { "type": "string", "format": "date-time" }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Campaign id" }, "name": { "type": "string", "description": "" }, "status": { "type": "string", "description": "completed" }, "sent": { "type": "integer", "description": "" }, "replies": { "type": "integer", "description": "" }, "positive": { "type": "integer", "description": "" }, "meetings": { "type": "integer", "description": "" }, "bounced": { "type": "integer", "description": "" }, "launchedAt": { "type": "string", "description": "" }, "url": { "type": "string", "description": "Campaign in the app" } } } } }, "example": { "event": "campaign.completed", "sentAt": "2026-01-01T09:00:00.000Z", "data": { "id": "00000000-0000-0000-0000-000000000000", "name": "Example campaign", "status": "completed", "sent": 480, "replies": 21, "positive": 6, "meetings": 2, "bounced": 4, "launchedAt": "2026-01-01T09:00:00.000Z", "url": "https://app.example/app/campaigns/00000000-0000-0000-0000-000000000000" } } } } }, "responses": { "200": { "description": "Any 2xx within 10 seconds counts as delivered. 410 Gone removes a REST-hook subscription." } } } }, "campaign.paused": { "post": { "summary": "Campaign paused", "description": "A teammate, the API or Inboxed (empty wallet, bounce guard, budget) paused a campaign.\n\nSigned with `X-Inboxed-Signature: sha256=` using the workspace webhook secret.", "parameters": [ { "name": "X-Inboxed-Event", "in": "header", "schema": { "type": "string", "const": "campaign.paused" } }, { "name": "X-Inboxed-Delivery", "in": "header", "description": "Unique per delivery; use it to ignore repeats.", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Inboxed-Signature", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "event", "sentAt", "data" ], "properties": { "event": { "const": "campaign.paused" }, "sentAt": { "type": "string", "format": "date-time" }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Campaign id" }, "name": { "type": "string", "description": "" }, "status": { "type": "string", "description": "paused" }, "reason": { "type": "string", "description": "Why it paused" }, "by": { "type": "string", "description": "user, api or system" }, "sent": { "type": "integer", "description": "" }, "url": { "type": "string", "description": "" } } } } }, "example": { "event": "campaign.paused", "sentAt": "2026-01-01T09:00:00.000Z", "data": { "id": "00000000-0000-0000-0000-000000000000", "name": "Example campaign", "status": "paused", "sent": 120, "replies": 4, "positive": 1, "meetings": 0, "bounced": 2, "launchedAt": "2026-01-01T09:00:00.000Z", "url": "https://app.example/app/campaigns/00000000-0000-0000-0000-000000000000", "reason": "Paused through the API.", "by": "api" } } } } }, "responses": { "200": { "description": "Any 2xx within 10 seconds counts as delivered. 410 Gone removes a REST-hook subscription." } } } }, "email.bounced": { "post": { "summary": "Email bounced", "description": "A send hard-bounced or a bounce report arrived.\n\nSigned with `X-Inboxed-Signature: sha256=` using the workspace webhook secret.", "parameters": [ { "name": "X-Inboxed-Event", "in": "header", "schema": { "type": "string", "const": "email.bounced" } }, { "name": "X-Inboxed-Delivery", "in": "header", "description": "Unique per delivery; use it to ignore repeats.", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Inboxed-Signature", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "event", "sentAt", "data" ], "properties": { "event": { "const": "email.bounced" }, "sentAt": { "type": "string", "format": "date-time" }, "data": { "type": "object", "properties": { "email": { "type": "string", "description": "" }, "campaignId": { "type": "string", "description": "" }, "reason": { "type": "string", "description": "The server’s answer" } } } } }, "example": { "event": "email.bounced", "sentAt": "2026-01-01T09:00:00.000Z", "data": { "email": "lead@example.com", "campaignId": "00000000-0000-0000-0000-000000000000", "reason": "550 5.1.1 User unknown" } } } } }, "responses": { "200": { "description": "Any 2xx within 10 seconds counts as delivered. 410 Gone removes a REST-hook subscription." } } } }, "email.clicked": { "post": { "summary": "Link clicked", "description": "A lead clicked a tracked link (bot clicks excluded).\n\nSigned with `X-Inboxed-Signature: sha256=` using the workspace webhook secret.", "parameters": [ { "name": "X-Inboxed-Event", "in": "header", "schema": { "type": "string", "const": "email.clicked" } }, { "name": "X-Inboxed-Delivery", "in": "header", "description": "Unique per delivery; use it to ignore repeats.", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Inboxed-Signature", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "event", "sentAt", "data" ], "properties": { "event": { "const": "email.clicked" }, "sentAt": { "type": "string", "format": "date-time" }, "data": { "type": "object", "properties": { "email": { "type": "string", "description": "" }, "campaignId": { "type": "string", "description": "" }, "messageId": { "type": "string", "description": "" }, "subject": { "type": "string", "description": "" }, "engagement": { "type": "object", "description": "kind, at, step, url, client, device" } } } } }, "example": { "event": "email.clicked", "sentAt": "2026-01-01T09:00:00.000Z", "data": { "email": "lead@example.com", "campaignId": "00000000-0000-0000-0000-000000000000", "messageId": "00000000-0000-0000-0000-000000000000", "subject": "Quick question", "engagement": { "kind": "click", "at": "2026-01-01T09:00:00.000Z", "step": 1, "url": "https://example.com/pricing" } } } } } }, "responses": { "200": { "description": "Any 2xx within 10 seconds counts as delivered. 410 Gone removes a REST-hook subscription." } } } }, "email.opened": { "post": { "summary": "Email opened (estimated)", "description": "A tracked email was opened by a person (machine opens excluded). Opens are estimates.\n\nSigned with `X-Inboxed-Signature: sha256=` using the workspace webhook secret.", "parameters": [ { "name": "X-Inboxed-Event", "in": "header", "schema": { "type": "string", "const": "email.opened" } }, { "name": "X-Inboxed-Delivery", "in": "header", "description": "Unique per delivery; use it to ignore repeats.", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Inboxed-Signature", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "event", "sentAt", "data" ], "properties": { "event": { "const": "email.opened" }, "sentAt": { "type": "string", "format": "date-time" }, "data": { "type": "object", "properties": { "email": { "type": "string", "description": "" }, "campaignId": { "type": "string", "description": "" }, "messageId": { "type": "string", "description": "" }, "subject": { "type": "string", "description": "" }, "engagement": { "type": "object", "description": "kind, at, step, client, device, estimated" } } } } }, "example": { "event": "email.opened", "sentAt": "2026-01-01T09:00:00.000Z", "data": { "email": "lead@example.com", "campaignId": "00000000-0000-0000-0000-000000000000", "messageId": "00000000-0000-0000-0000-000000000000", "subject": "Quick question", "engagement": { "kind": "open", "at": "2026-01-01T09:00:00.000Z", "step": 1, "estimated": true } } } } } }, "responses": { "200": { "description": "Any 2xx within 10 seconds counts as delivered. 410 Gone removes a REST-hook subscription." } } } }, "email.sent": { "post": { "summary": "Email sent", "description": "A campaign email was accepted by the mail server (and charged).\n\nSigned with `X-Inboxed-Signature: sha256=` using the workspace webhook secret.", "parameters": [ { "name": "X-Inboxed-Event", "in": "header", "schema": { "type": "string", "const": "email.sent" } }, { "name": "X-Inboxed-Delivery", "in": "header", "description": "Unique per delivery; use it to ignore repeats.", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Inboxed-Signature", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "event", "sentAt", "data" ], "properties": { "event": { "const": "email.sent" }, "sentAt": { "type": "string", "format": "date-time" }, "data": { "type": "object", "properties": { "messageId": { "type": "string", "description": "Inboxed id of the sent email" }, "campaignId": { "type": "string", "description": "" }, "email": { "type": "string", "description": "Recipient" }, "step": { "type": "integer", "description": "Sequence step, from 1" }, "subject": { "type": "string", "description": "" }, "mailbox": { "type": "string", "description": "Sending address" }, "variant": { "type": "string", "description": "A/Z version letter" }, "sentAt": { "type": "string", "description": "" } } } } }, "example": { "event": "email.sent", "sentAt": "2026-01-01T09:00:00.000Z", "data": { "messageId": "00000000-0000-0000-0000-000000000000", "campaignId": "00000000-0000-0000-0000-000000000000", "email": "lead@example.com", "step": 1, "subject": "Quick question", "mailbox": "you@yourcompany.com", "variant": "A", "sentAt": "2026-01-01T09:00:00.000Z" } } } } }, "responses": { "200": { "description": "Any 2xx within 10 seconds counts as delivered. 410 Gone removes a REST-hook subscription." } } } }, "lead.added": { "post": { "summary": "Lead added", "description": "A lead was created through the API or added to a running campaign.\n\nSigned with `X-Inboxed-Signature: sha256=` using the workspace webhook secret.", "parameters": [ { "name": "X-Inboxed-Event", "in": "header", "schema": { "type": "string", "const": "lead.added" } }, { "name": "X-Inboxed-Delivery", "in": "header", "description": "Unique per delivery; use it to ignore repeats.", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Inboxed-Signature", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "event", "sentAt", "data" ], "properties": { "event": { "const": "lead.added" }, "sentAt": { "type": "string", "format": "date-time" }, "data": { "type": "object", "properties": { "leadId": { "type": "string", "description": "" }, "listId": { "type": "string", "description": "" }, "email": { "type": "string", "description": "" }, "firstName": { "type": "string", "description": "" }, "lastName": { "type": "string", "description": "" }, "company": { "type": "string", "description": "" }, "verifyStatus": { "type": "string", "description": "valid, invalid, risky, catch_all, disposable, role_based or unverified" }, "source": { "type": "string", "description": "api or campaign" }, "url": { "type": "string", "description": "" } } } } }, "example": { "event": "lead.added", "sentAt": "2026-01-01T09:00:00.000Z", "data": { "leadId": "00000000-0000-0000-0000-000000000000", "listId": "00000000-0000-0000-0000-000000000000", "email": "lead@example.com", "firstName": "Example", "lastName": "Lead", "company": "Example Co", "verifyStatus": "valid", "source": "api", "url": "https://app.example/app/leads/00000000-0000-0000-0000-000000000000" } } } } }, "responses": { "200": { "description": "Any 2xx within 10 seconds counts as delivered. 410 Gone removes a REST-hook subscription." } } } }, "lead.hot": { "post": { "summary": "Hot lead", "description": "A lead opened, clicked or replied enough to count as hot.\n\nSigned with `X-Inboxed-Signature: sha256=` using the workspace webhook secret.", "parameters": [ { "name": "X-Inboxed-Event", "in": "header", "schema": { "type": "string", "const": "lead.hot" } }, { "name": "X-Inboxed-Delivery", "in": "header", "description": "Unique per delivery; use it to ignore repeats.", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Inboxed-Signature", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "event", "sentAt", "data" ], "properties": { "event": { "const": "lead.hot" }, "sentAt": { "type": "string", "format": "date-time" }, "data": { "type": "object", "properties": { "email": { "type": "string", "description": "" }, "leadId": { "type": "string", "description": "" }, "campaignId": { "type": "string", "description": "" }, "engagement": { "type": "object", "description": "" }, "detail": { "type": "string", "description": "" } } } } }, "example": { "event": "lead.hot", "sentAt": "2026-01-01T09:00:00.000Z", "data": { "email": "lead@example.com", "leadId": "00000000-0000-0000-0000-000000000000", "campaignId": "00000000-0000-0000-0000-000000000000", "detail": "Clicked https://example.com/pricing" } } } } }, "responses": { "200": { "description": "Any 2xx within 10 seconds counts as delivered. 410 Gone removes a REST-hook subscription." } } } }, "lead.unsubscribed": { "post": { "summary": "Lead unsubscribed", "description": "A lead unsubscribed by link or by replying.\n\nSigned with `X-Inboxed-Signature: sha256=` using the workspace webhook secret.", "parameters": [ { "name": "X-Inboxed-Event", "in": "header", "schema": { "type": "string", "const": "lead.unsubscribed" } }, { "name": "X-Inboxed-Delivery", "in": "header", "description": "Unique per delivery; use it to ignore repeats.", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Inboxed-Signature", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "event", "sentAt", "data" ], "properties": { "event": { "const": "lead.unsubscribed" }, "sentAt": { "type": "string", "format": "date-time" }, "data": { "type": "object", "properties": { "email": { "type": "string", "description": "" }, "campaignId": { "type": "string", "description": "" }, "via": { "type": "string", "description": "link, reply or crm" } } } } }, "example": { "event": "lead.unsubscribed", "sentAt": "2026-01-01T09:00:00.000Z", "data": { "email": "lead@example.com", "campaignId": "00000000-0000-0000-0000-000000000000", "via": "link" } } } } }, "responses": { "200": { "description": "Any 2xx within 10 seconds counts as delivered. 410 Gone removes a REST-hook subscription." } } } }, "mailbox.disconnected": { "post": { "summary": "Mailbox disconnected", "description": "A mailbox can’t send: its sign-in failed or it was disconnected. Sent once per incident.\n\nSigned with `X-Inboxed-Signature: sha256=` using the workspace webhook secret.", "parameters": [ { "name": "X-Inboxed-Event", "in": "header", "schema": { "type": "string", "const": "mailbox.disconnected" } }, { "name": "X-Inboxed-Delivery", "in": "header", "description": "Unique per delivery; use it to ignore repeats.", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Inboxed-Signature", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "event", "sentAt", "data" ], "properties": { "event": { "const": "mailbox.disconnected" }, "sentAt": { "type": "string", "format": "date-time" }, "data": { "type": "object", "properties": { "mailboxId": { "type": "string", "description": "" }, "email": { "type": "string", "description": "" }, "provider": { "type": "string", "description": "google, microsoft or smtp" }, "reason": { "type": "string", "description": "The provider’s error" }, "reconnectUrl": { "type": "string", "description": "Where to reconnect it" } } } } }, "example": { "event": "mailbox.disconnected", "sentAt": "2026-01-01T09:00:00.000Z", "data": { "mailboxId": "00000000-0000-0000-0000-000000000000", "email": "you@yourcompany.com", "provider": "google", "reason": "535 5.7.8 Username and Password not accepted", "reconnectUrl": "https://app.example/app/mailboxes/00000000-0000-0000-0000-000000000000" } } } } }, "responses": { "200": { "description": "Any 2xx within 10 seconds counts as delivered. 410 Gone removes a REST-hook subscription." } } } }, "reply.interested": { "post": { "summary": "Interested reply", "description": "A reply is tagged Interested or Meeting request.\n\nSigned with `X-Inboxed-Signature: sha256=` using the workspace webhook secret.", "parameters": [ { "name": "X-Inboxed-Event", "in": "header", "schema": { "type": "string", "const": "reply.interested" } }, { "name": "X-Inboxed-Delivery", "in": "header", "description": "Unique per delivery; use it to ignore repeats.", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Inboxed-Signature", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "event", "sentAt", "data" ], "properties": { "event": { "const": "reply.interested" }, "sentAt": { "type": "string", "format": "date-time" }, "data": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "" }, "campaignId": { "type": "string", "description": "" }, "lead": { "type": "string", "description": "" }, "email": { "type": "string", "description": "" }, "company": { "type": "string", "description": "" }, "intent": { "type": "string", "description": "" }, "excerpt": { "type": "string", "description": "" }, "url": { "type": "string", "description": "" } } } } }, "example": { "event": "reply.interested", "sentAt": "2026-01-01T09:00:00.000Z", "data": { "conversationId": "00000000-0000-0000-0000-000000000000", "campaignId": "00000000-0000-0000-0000-000000000000", "lead": "Example Lead", "email": "lead@example.com", "company": "Example Co", "intent": "Interested", "excerpt": "Sounds good. Can we talk next week?", "url": "https://app.example/app/inbox?c=00000000-0000-0000-0000-000000000000" } } } } }, "responses": { "200": { "description": "Any 2xx within 10 seconds counts as delivered. 410 Gone removes a REST-hook subscription." } } } }, "reply.received": { "post": { "summary": "Reply received", "description": "A lead replied (auto-replies such as out-of-office aren’t sent).\n\nSigned with `X-Inboxed-Signature: sha256=` using the workspace webhook secret.", "parameters": [ { "name": "X-Inboxed-Event", "in": "header", "schema": { "type": "string", "const": "reply.received" } }, { "name": "X-Inboxed-Delivery", "in": "header", "description": "Unique per delivery; use it to ignore repeats.", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Inboxed-Signature", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "event", "sentAt", "data" ], "properties": { "event": { "const": "reply.received" }, "sentAt": { "type": "string", "format": "date-time" }, "data": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "" }, "campaignId": { "type": "string", "description": "" }, "lead": { "type": "string", "description": "" }, "email": { "type": "string", "description": "" }, "company": { "type": "string", "description": "" }, "intent": { "type": "string", "description": "" }, "excerpt": { "type": "string", "description": "" }, "url": { "type": "string", "description": "" } } } } }, "example": { "event": "reply.received", "sentAt": "2026-01-01T09:00:00.000Z", "data": { "conversationId": "00000000-0000-0000-0000-000000000000", "campaignId": "00000000-0000-0000-0000-000000000000", "lead": "Example Lead", "email": "lead@example.com", "company": "Example Co", "intent": "Question", "excerpt": "How does pricing work?", "url": "https://app.example/app/inbox?c=00000000-0000-0000-0000-000000000000" } } } } }, "responses": { "200": { "description": "Any 2xx within 10 seconds counts as delivered. 410 Gone removes a REST-hook subscription." } } } } }, "components": { "securitySchemes": { "apiKey": { "type": "http", "scheme": "bearer", "description": "Scopes: read (Read), leads:write (Write leads), campaigns:write (Manage campaigns), campaigns:launch (Spend: add leads, resume), inbox:write (Reply), suppressions:write (Suppressions), admin (Admin)." } }, "schemas": { "Error": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string", "description": "What went wrong, in plain words." }, "code": { "type": "string", "description": "Stable machine-readable code, e.g. not_found, missing_scope, rate_limited." }, "details": { "description": "Extra detail, e.g. validation issues." } } }, "Campaign": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "setting_up", "active", "paused", "completed", "stopped" ] }, "pausedReason": { "type": [ "string", "null" ] }, "listId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "sent": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "replies": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "positive": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "meetings": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "bounced": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "spent": { "type": "string", "description": "Formatted, e.g. $1.20" }, "launchedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "ISO 8601 timestamp" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "ISO 8601 timestamp" } }, "required": [ "id", "name", "status", "pausedReason", "listId", "sent", "replies", "positive", "meetings", "bounced", "spent", "launchedAt", "createdAt" ], "additionalProperties": false }, "CampaignStats": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "status": { "type": "string" }, "sent": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "replies": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "positive": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "meetings": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "bounced": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "opens": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "clicks": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "replyRate": { "type": "number" }, "positiveRate": { "type": "number" }, "bounceRate": { "type": "number" }, "openRate": { "type": "number" }, "clickRate": { "type": "number" }, "spent": { "type": "string" }, "spentMicros": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "maxEmails": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "leads": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "description": "Enrolled leads by status" } }, "required": [ "id", "name", "status", "sent", "replies", "positive", "meetings", "bounced", "opens", "clicks", "replyRate", "positiveRate", "bounceRate", "openRate", "clickRate", "spent", "spentMicros", "maxEmails", "leads" ], "additionalProperties": false }, "LeadList": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "source": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "ISO 8601 timestamp" }, "leads": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "name", "source", "createdAt" ], "additionalProperties": false }, "Lead": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "listId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "email": { "type": "string" }, "firstName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "company": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "region": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "companySize": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "language": { "type": [ "string", "null" ] }, "custom": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "verifyStatus": { "type": "string", "enum": [ "unverified", "valid", "invalid", "risky", "catch_all", "disposable", "role_based" ] }, "verifyReason": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "ISO 8601 timestamp" } }, "required": [ "id", "listId", "email", "firstName", "lastName", "company", "title", "timezone", "country", "region", "city", "companySize", "language", "custom", "verifyStatus", "verifyReason", "createdAt" ], "additionalProperties": false }, "LeadUpsertResult": { "type": "object", "properties": { "listId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "summary": { "type": "object", "properties": { "created": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updated": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "duplicate": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "invalid": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "created", "updated", "duplicate", "invalid" ], "additionalProperties": false }, "results": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "email": { "type": "string" }, "result": { "type": "string", "enum": [ "created", "updated", "duplicate", "invalid" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "verifyStatus": { "type": "string" }, "error": { "type": "string" } }, "required": [ "index", "email", "result" ], "additionalProperties": false } } }, "required": [ "listId", "summary", "results" ], "additionalProperties": false }, "Suppression": { "type": "object", "properties": { "entry": { "type": "string" }, "kind": { "type": "string", "enum": [ "email", "domain" ] }, "reason": { "type": "string", "enum": [ "unsubscribe", "bounce", "complaint", "manual", "crm" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "ISO 8601 timestamp" } }, "required": [ "entry", "kind", "reason", "createdAt" ], "additionalProperties": false }, "Mailbox": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "email": { "type": "string" }, "provider": { "type": "string", "enum": [ "google", "microsoft", "smtp" ] }, "connected": { "type": "boolean" }, "status": { "type": "string", "enum": [ "active", "paused", "error" ] }, "statusReason": { "type": [ "string", "null" ] }, "dailyLimit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "health": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmup": { "type": "string" } }, "required": [ "id", "email", "provider", "connected", "status", "statusReason", "dailyLimit", "health", "warmup" ], "additionalProperties": false }, "MailboxDetail": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "email": { "type": "string" }, "provider": { "type": "string", "enum": [ "google", "microsoft", "smtp" ] }, "connected": { "type": "boolean" }, "status": { "type": "string", "enum": [ "active", "paused", "error" ] }, "statusReason": { "type": [ "string", "null" ] }, "dailyLimit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "health": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmup": { "type": "string" }, "sentToday": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "lastSyncedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "ISO 8601 timestamp" }, { "type": "null" } ] }, "dns": { "anyOf": [ { "type": "object", "properties": { "checkedAt": { "type": "string" }, "spf": { "type": "string" }, "dkim": { "type": "string" }, "dmarc": { "type": "string" }, "issues": { "type": "array", "items": { "type": "string" } } }, "required": [ "checkedAt", "spf", "dkim", "dmarc", "issues" ], "additionalProperties": false }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "ISO 8601 timestamp" } }, "required": [ "id", "email", "provider", "connected", "status", "statusReason", "dailyLimit", "health", "warmup", "sentToday", "lastSyncedAt", "dns", "createdAt" ], "additionalProperties": false }, "Conversation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "lead": { "type": "string" }, "email": { "type": "string" }, "company": { "type": [ "string", "null" ] }, "subject": { "type": "string" }, "intent": { "type": [ "string", "null" ] }, "priority": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "reason": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "open", "waiting", "snoozed", "closed" ] }, "unread": { "type": "boolean" }, "campaignId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "lastMessageAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "ISO 8601 timestamp" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "ISO 8601 timestamp" } }, "required": [ "id", "lead", "email", "company", "subject", "intent", "priority", "reason", "status", "unread", "campaignId", "lastMessageAt", "createdAt" ], "additionalProperties": false }, "Message": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "from": { "type": "string", "enum": [ "lead", "us" ] }, "name": { "type": "string" }, "body": { "type": "string" }, "at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "ISO 8601 timestamp" }, "approval": { "anyOf": [ { "type": "string", "enum": [ "pending", "approved", "rejected", "sent" ] }, { "type": "null" } ] } }, "required": [ "id", "from", "name", "body", "at", "approval" ], "additionalProperties": false }, "HookSubscription": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "event": { "type": "string", "enum": [ "campaign.completed", "campaign.paused", "email.bounced", "email.clicked", "email.opened", "email.sent", "lead.added", "lead.hot", "lead.unsubscribed", "mailbox.disconnected", "reply.interested", "reply.received" ] }, "target_url": { "type": "string" }, "source": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "ISO 8601 timestamp" } }, "required": [ "id", "event", "target_url", "source", "created_at" ], "additionalProperties": false } } } }