{ "openapi": "3.1.0", "info": { "title": "Branding Optics API", "version": "1.1.0", "description": "Send texts, manage contacts, templates, keyword replies, automation flows, spam protection and archived conversations for your account. Existing keys retain their permissions; explicitly enable new scopes in Settings → API keys. Authenticate with an API key created in Settings → API keys. Send it as `Authorization: Bearer `. Every key is tied to one account and to the areas you allow." }, "servers": [ { "url": "https://brandingoptics.com" } ], "security": [ { "ApiKeyAuth": [] } ], "tags": [ { "name": "Messages", "description": "Send text messages." }, { "name": "Chats", "description": "Conversations and their history." }, { "name": "Contacts", "description": "Your saved contacts." }, { "name": "Account", "description": "Account details, phone numbers and credits." }, { "name": "Templates", "description": "Saved message templates." }, { "name": "Keywords", "description": "Keyword auto-replies." }, { "name": "Automations", "description": "Automated text flows and the conversations they run." }, { "name": "Blocking", "description": "Blocked numbers and spam protection." }, { "name": "Team", "description": "People on your account: invite, change role, remove." } ], "paths": { "/api/public/v1/account": { "get": { "tags": [ "Account" ], "summary": "Account details", "description": "Requires the `account:read` permission.", "responses": { "200": { "description": "Account details", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Account" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/api/public/v1/contacts": { "get": { "tags": [ "Contacts" ], "summary": "List contacts", "description": "Requires the `contacts:read` permission.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "maximum": 200 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Contacts", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } }, "post": { "tags": [ "Contacts" ], "summary": "Create a contact", "description": "Requires the `contacts:write` permission.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactInput" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Contact" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/api/public/v1/contacts/{contactId}": { "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Contacts" ], "summary": "Get one contact", "responses": { "200": { "description": "Contact", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Contact" } } } } } }, "404": { "$ref": "#/components/responses/NotFound" } } }, "patch": { "tags": [ "Contacts" ], "summary": "Update a contact", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactInput" } } } }, "responses": { "200": { "description": "Updated", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Contact" } } } } } }, "404": { "$ref": "#/components/responses/NotFound" } } }, "delete": { "tags": [ "Contacts" ], "summary": "Delete a contact", "responses": { "200": { "description": "Deleted" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/public/v1/chats": { "get": { "tags": [ "Chats" ], "summary": "List conversations", "description": "Active conversations by default. Requires the `chats:read` permission.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "maximum": 200 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 } }, { "name": "archived", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Set to true to list archived conversations instead." } ], "responses": { "200": { "description": "Conversations", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Chat" } }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/api/public/v1/chats/{chatId}/messages": { "parameters": [ { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Chats" ], "summary": "List messages in a conversation", "description": "Newest first. Requires the `chats:read` permission.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "maximum": 200 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 } } ], "responses": { "200": { "description": "Messages", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } } } } }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/public/v1/messages": { "post": { "tags": [ "Messages" ], "summary": "Send a text message", "description": "Uses message credits: 1 for a text, 2 when a picture is attached. Requires the `messages:send` permission.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "to" ], "properties": { "to": { "type": "string", "example": "+15551234567" }, "body": { "type": "string", "maxLength": 1600 }, "media_url": { "type": "string", "description": "Public URL of a picture to attach." }, "phone_number_id": { "type": "string", "format": "uuid", "description": "Which of your lines to send from. Defaults to your first active line." } } } } } }, "responses": { "201": { "description": "Sent", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SendResult" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/api/public/v1/chats/{chatId}": { "parameters": [ { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Chats" ], "summary": "Get one conversation", "description": "Requires the `chats:read` permission.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ChatDetail" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Chats" ], "summary": "Archive or restore a conversation", "description": "Requires the `chats:write` permission.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Chat" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/public/v1/chats/archive": { "post": { "tags": [ "Chats" ], "summary": "Archive or restore many conversations", "description": "Requires the `chats:write` permission.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkArchiveInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updated": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "archived": { "type": "boolean" } } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/public/v1/chat-retention": { "get": { "tags": [ "Chats" ], "summary": "Get the keep-archived-for window", "description": "Requires the `chats:read` permission.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Retention" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Chats" ], "summary": "Set the keep-archived-for window", "description": "Requires the `chats:write` permission.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Retention" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Retention" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/public/v1/templates": { "get": { "tags": [ "Templates" ], "summary": "List saved templates", "description": "Requires the `templates:read` permission.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "maximum": 200 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Template" } }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Templates" ], "summary": "Create a template", "description": "Requires the `templates:write` permission.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateInput" } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Template" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/public/v1/templates/{templateId}": { "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Templates" ], "summary": "Get one template", "description": "Requires the `templates:read` permission.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Template" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Templates" ], "summary": "Update a template", "description": "Requires the `templates:write` permission.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplatePatch" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Template" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Templates" ], "summary": "Delete a template", "description": "Requires the `templates:write` permission.", "responses": { "200": { "description": "OK" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/public/v1/keywords": { "get": { "tags": [ "Keywords" ], "summary": "List keyword replies", "description": "Requires the `keywords:read` permission.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "maximum": 200 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Keyword" } }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Keywords" ], "summary": "Create a keyword reply", "description": "Requires the `keywords:write` permission.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeywordInput" } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Keyword" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/public/v1/keywords/{keywordId}": { "parameters": [ { "name": "keywordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Keywords" ], "summary": "Get one keyword reply", "description": "Requires the `keywords:read` permission.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Keyword" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Keywords" ], "summary": "Update a keyword reply", "description": "Requires the `keywords:write` permission.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeywordPatch" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Keyword" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Keywords" ], "summary": "Delete a keyword reply", "description": "Requires the `keywords:write` permission.", "responses": { "200": { "description": "OK" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/public/v1/blocked-contacts": { "get": { "tags": [ "Blocking" ], "summary": "List blocked numbers", "description": "Requires the `blocks:read` permission.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "maximum": 200 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BlockedContact" } }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Blocking" ], "summary": "Block a number", "description": "Requires the `blocks:write` permission.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockInput" } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BlockedContact" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/public/v1/blocked-contacts/{blockId}": { "parameters": [ { "name": "blockId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Blocking" ], "summary": "Get one blocked number", "description": "Requires the `blocks:read` permission.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BlockedContact" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Blocking" ], "summary": "Unblock a number", "description": "Requires the `blocks:write` permission.", "responses": { "200": { "description": "OK" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/public/v1/spam-settings": { "get": { "tags": [ "Blocking" ], "summary": "Get spam protection settings", "description": "Requires the `blocks:read` permission.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpamSettings" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Blocking" ], "summary": "Update spam protection settings", "description": "Requires the `blocks:write` permission.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpamSettings" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpamSettings" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/public/v1/automations": { "get": { "tags": [ "Automations" ], "summary": "List automated text flows", "description": "Requires the `automations:read` permission.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "maximum": 200 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Automation" } }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Automations" ], "summary": "Create an automated text flow", "description": "Requires the `automations:write` permission.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationInput" } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Automation" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/public/v1/automations/{flowId}": { "parameters": [ { "name": "flowId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Automations" ], "summary": "Get one flow with its questions", "description": "Requires the `automations:read` permission.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationDetail" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Automations" ], "summary": "Replace a flow and its questions", "description": "Requires the `automations:write` permission.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Automation" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Automations" ], "summary": "Turn a flow on or off", "description": "Requires the `automations:write` permission.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Automation" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Automations" ], "summary": "Delete a flow", "description": "Requires the `automations:write` permission.", "responses": { "200": { "description": "OK" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/public/v1/automation-runs": { "get": { "tags": [ "Automations" ], "summary": "List flow conversations", "description": "Requires the `automations:read` permission.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "maximum": 200 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 } }, { "name": "flow_id", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationRun" } }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/public/v1/automation-runs/{runId}": { "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Automations" ], "summary": "Get one flow conversation and its answers", "description": "Requires the `automations:read` permission.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRunDetail" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Automations" ], "summary": "Stop a flow conversation or hand it to your team", "description": "Requires the `automations:write` permission.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunStatusInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AutomationRun" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Record exists, or a running flow cannot be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/public/v1/team": { "get": { "tags": [ "Team" ], "summary": "List team members and pending invitations", "description": "Requires the `team:read` permission.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "maximum": 200 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TeamMember" } }, "pending_invites": { "type": "array", "items": { "$ref": "#/components/schemas/TeamInvite" } }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Team" ], "summary": "Add or invite a person", "description": "Adds them straight away when they already have an account, otherwise sends an invitation email. Requires the `team:write` permission.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamInviteInput" } } } }, "responses": { "201": { "description": "Added or invited", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TeamMember" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "description": "Already on this team", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/public/v1/team/{memberId}": { "parameters": [ { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "Team" ], "summary": "Get one team member", "description": "Requires the `team:read` permission.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TeamMember" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "patch": { "tags": [ "Team" ], "summary": "Promote or change a member's role", "description": "Roles are admin, manager or member. The account owner cannot be changed. Requires the `team:write` permission.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamRoleInput" } } } }, "responses": { "200": { "description": "Updated", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TeamMember" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "delete": { "tags": [ "Team" ], "summary": "Remove someone from the team", "description": "Requires the `team:write` permission.", "responses": { "200": { "description": "Removed" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/public/v1/team/{memberId}/password-reset": { "parameters": [ { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "post": { "tags": [ "Team" ], "summary": "Send a password reset email to a team member", "description": "Emails the member a link to choose a new password. Useful when syncing accounts from a directory. Requires the `team:write` permission.", "responses": { "200": { "description": "Email sent", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "password_reset_sent": { "type": "boolean" } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "No email address on file", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/public/v1/directory": { "get": { "tags": [ "Directory sync" ], "summary": "Directory connection status", "description": "Shows the work directory connection, verified email domains, group-to-role mappings and the last ten sync runs. Requires the `directory:read` permission.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DirectoryStatus" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/api/public/v1/directory/sync": { "post": { "tags": [ "Directory sync" ], "summary": "Run a directory sync now", "description": "Adds new people, updates roles and removes leavers based on the connected directory. The owner is never removed and the last admin is never demoted. Requires the `directory:write` permission.", "responses": { "200": { "description": "Sync finished", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SyncOutcome" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "description": "Directory not connected or no access group chosen", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Request could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "http", "scheme": "bearer", "description": "Your API key from Settings → API keys." } }, "responses": { "Unauthorized": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Forbidden": { "description": "The key is not allowed to do this", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "NotFound": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "BadRequest": { "description": "Something in the request was wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "schemas": { "TemplatePatch": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "body": { "type": "string", "minLength": 1, "maxLength": 1600 } }, "additionalProperties": false }, "KeywordPatch": { "type": "object", "properties": { "keyword": { "type": "string", "minLength": 1, "maxLength": 40 }, "active": { "type": "boolean" }, "responses": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 1600 }, "minItems": 1, "maxItems": 10 } }, "additionalProperties": false }, "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" } } } } }, "ChatDetail": { "allOf": [ { "$ref": "#/components/schemas/Chat" }, { "type": "object", "properties": { "recipients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "phone": { "type": "string" }, "contact_id": { "type": "string", "format": "uuid", "nullable": true } } } } } } ] }, "ArchiveInput": { "type": "object", "properties": { "archived": { "type": "boolean" } }, "required": [ "archived" ], "additionalProperties": false }, "BulkArchiveInput": { "type": "object", "properties": { "archived": { "type": "boolean" }, "chat_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 200 } }, "required": [ "archived", "chat_ids" ], "additionalProperties": false }, "Retention": { "type": "object", "properties": { "retention_days": { "anyOf": [ { "type": "number", "enum": [ 30 ] }, { "type": "number", "enum": [ 60 ] }, { "type": "number", "enum": [ 90 ] }, { "type": "number", "enum": [ 120 ] } ], "nullable": true } }, "required": [ "retention_days" ], "additionalProperties": false }, "Template": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "body": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "TemplateInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "body": { "type": "string", "minLength": 1, "maxLength": 1600 } }, "required": [ "name", "body" ], "additionalProperties": false }, "Keyword": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "keyword": { "type": "string" }, "active": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "keyword_responses": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "response_body": { "type": "string" } } } } } }, "KeywordInput": { "type": "object", "properties": { "keyword": { "type": "string", "minLength": 1, "maxLength": 40 }, "active": { "type": "boolean" }, "responses": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 1600 }, "minItems": 1, "maxItems": 10 } }, "required": [ "keyword", "responses" ], "additionalProperties": false }, "BlockedContact": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "phone": { "type": "string" }, "reason": { "type": "string", "nullable": true }, "auto_blocked": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" } } }, "BlockInput": { "type": "object", "properties": { "phone": { "type": "string", "pattern": "^\\+[1-9]\\d{7,14}$" }, "reason": { "type": "string", "maxLength": 500, "nullable": true } }, "required": [ "phone" ], "additionalProperties": false }, "SpamSettings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "max_messages": { "type": "integer", "minimum": 2, "maximum": 10000 }, "window_seconds": { "type": "integer", "minimum": 10, "maximum": 86400 } }, "required": [ "enabled", "max_messages", "window_seconds" ], "additionalProperties": false }, "Automation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "trigger_keyword": { "type": "string" }, "description": { "type": "string", "nullable": true }, "active": { "type": "boolean" }, "all_numbers": { "type": "boolean" }, "intro_message": { "type": "string", "nullable": true }, "fallback_message": { "type": "string", "nullable": true }, "handoff_message": { "type": "string", "nullable": true }, "max_invalid_replies": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "AutomationDetail": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Automation" }, "steps": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationStep" } }, "phone_number_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "AutomationStep": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "position": { "type": "integer" }, "label": { "type": "string", "nullable": true }, "question": { "type": "string" }, "answer_type": { "type": "string", "enum": [ "text", "number", "date", "time", "choice" ] }, "choices": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "next_step_id": { "type": "string", "nullable": true } } } }, "next_step_id": { "type": "string", "nullable": true }, "is_final": { "type": "boolean" } } }, "AutomationInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 80 }, "trigger_keyword": { "type": "string", "minLength": 1, "maxLength": 40 }, "description": { "type": "string", "maxLength": 300, "nullable": true }, "active": { "type": "boolean", "default": false }, "all_numbers": { "type": "boolean", "default": true }, "phone_number_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 100, "default": [] }, "intro_message": { "type": "string", "maxLength": 320, "nullable": true }, "fallback_message": { "type": "string", "maxLength": 320, "nullable": true }, "handoff_message": { "type": "string", "maxLength": 320, "nullable": true }, "max_invalid_replies": { "type": "integer", "minimum": 1, "maximum": 5, "default": 2 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 80, "nullable": true }, "question": { "type": "string", "minLength": 1, "maxLength": 800 }, "answer_type": { "type": "string", "enum": [ "text", "number", "date", "time", "choice" ] }, "choices": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "next_step_id": { "type": "string", "pattern": "^(pos:\\d{1,2}|__end)$", "nullable": true } }, "required": [ "label" ], "additionalProperties": false }, "maxItems": 10, "default": [] }, "next_step_id": { "type": "string", "pattern": "^(pos:\\d{1,2}|__end)$", "nullable": true }, "is_final": { "type": "boolean", "default": false } }, "required": [ "question", "answer_type" ], "additionalProperties": false }, "minItems": 1, "maxItems": 30 } }, "required": [ "name", "trigger_keyword", "steps" ], "additionalProperties": false }, "ActiveInput": { "type": "object", "properties": { "active": { "type": "boolean" } }, "required": [ "active" ], "additionalProperties": false }, "AutomationRun": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "flow_id": { "type": "string", "format": "uuid" }, "phone": { "type": "string" }, "status": { "type": "string", "enum": [ "running", "completed", "stopped", "taken_over" ] }, "invalid_count": { "type": "integer" }, "current_step_id": { "type": "string", "format": "uuid", "nullable": true }, "chat_id": { "type": "string", "format": "uuid", "nullable": true }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time" } } }, "AutomationRunDetail": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AutomationRun" }, "answers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "label": { "type": "string", "nullable": true }, "question": { "type": "string" }, "answer": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } } } } }, "RunStatusInput": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "stopped", "taken_over" ] } }, "required": [ "status" ], "additionalProperties": false }, "TeamMember": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user_id": { "type": "string", "format": "uuid" }, "role": { "type": "string", "enum": [ "owner", "admin", "manager", "member" ] }, "title": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" } } }, "TeamInvite": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "role": { "type": "string", "enum": [ "admin", "manager", "member" ] }, "created_at": { "type": "string", "format": "date-time" } } }, "TeamInviteInput": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 255 }, "role": { "type": "string", "enum": [ "admin", "manager", "member" ], "default": "member" } }, "required": [ "email" ], "additionalProperties": false }, "TeamRoleInput": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "admin", "manager", "member" ] } }, "required": [ "role" ], "additionalProperties": false }, "DirectoryStatus": { "type": "object", "properties": { "connected": { "type": "boolean" }, "connection": { "type": "object", "nullable": true, "properties": { "tenant_id": { "type": "string" }, "access_group_id": { "type": "string", "nullable": true }, "default_role": { "type": "string", "enum": [ "admin", "manager", "member" ] }, "strict_sso": { "type": "boolean" }, "last_sync_at": { "type": "string", "format": "date-time", "nullable": true }, "last_sync_status": { "type": "string", "nullable": true } } }, "domains": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domain": { "type": "string" }, "verified_at": { "type": "string", "format": "date-time", "nullable": true } } } }, "group_roles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "group_id": { "type": "string" }, "group_name": { "type": "string" }, "role": { "type": "string", "enum": [ "admin", "manager", "member" ] } } } }, "recent_syncs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "started_at": { "type": "string", "format": "date-time" }, "finished_at": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "nullable": true }, "added": { "type": "integer" }, "updated": { "type": "integer" }, "removed": { "type": "integer" } } } } } }, "SyncOutcome": { "type": "object", "properties": { "added": { "type": "integer" }, "updated": { "type": "integer" }, "removed": { "type": "integer" }, "status": { "type": "string", "enum": [ "ok", "partial", "failed" ] }, "errors": { "type": "array", "items": { "type": "string" } } } }, "Contact": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "phone": { "type": "string" }, "email": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "avatar_url": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "ContactInput": { "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "example": "+15551234567" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "notes": { "type": "string" } } }, "Chat": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "chat_type": { "type": "string", "enum": [ "direct", "group", "team" ] }, "title": { "type": "string", "nullable": true }, "destination_phone": { "type": "string", "nullable": true }, "phone_number_id": { "type": "string", "nullable": true }, "contact_id": { "type": "string", "nullable": true }, "archived_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Set when the conversation is archived." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "Message": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "direction": { "type": "string", "enum": [ "inbound", "outbound" ] }, "status": { "type": "string", "enum": [ "queued", "sent", "delivered", "failed", "received" ] }, "body": { "type": "string", "nullable": true }, "from_phone": { "type": "string", "nullable": true }, "to_phone": { "type": "string", "nullable": true }, "error_code": { "type": "integer", "nullable": true }, "error_message": { "type": "string", "nullable": true }, "message_attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "file_name": { "type": "string", "nullable": true }, "content_type": { "type": "string", "nullable": true }, "size_bytes": { "type": "integer", "nullable": true } } } }, "created_at": { "type": "string", "format": "date-time" } } }, "SendResult": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "chat_id": { "type": "string", "format": "uuid" }, "to": { "type": "string" }, "from": { "type": "string" }, "status": { "type": "string" }, "credits_used": { "type": "integer" } } }, "Account": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "credits": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "phone_numbers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "phone_number": { "type": "string" }, "friendly_name": { "type": "string", "nullable": true }, "number_type": { "type": "string" }, "active": { "type": "boolean" } } } } } } } } }