{ "openapi": "3.0.0", "info": { "title": "SalesMessage Public API", "description": "## Introduction\nThis API documentation will start with an overview of the Salesmsg authorization methods and flows, followed by reference information about each specific endpoint.\n\n## Mock Server\nAdditionally, if you want to try the API requests out on our mock server, then you can import the endpoints and set baseUrl variable in your collection as `https://e33e4a6a-ff9d-419f-a378-ec53560c0bb7.mock.pstmn.io`\n\n## Authentication\n\nSupported authorization methods include: **Personal Access Token (PAT)** and **OAuth2**.\nWhether to use PAT or regular OAuth2 tokens highly depends on your use case.\n\n- **OAuth2** authorization type is to go for in case you want to allow other users to authenticate against SalesMessage in order for your app to use the issued token as well as utilize the SalesMessage’s functionality.\n\n- **PAT** authorization type is to go for in case you want to integrate your personal existing account with Salesmsg in order to extend your app’s functionality. PAT are managed by the user, which means that they are tied to a user account. This makes Personal Access Tokens a good choice for development, as well as automation purposes, when an application does only require a single SalesMessage account to manage organizations.\n\n### OAuth2\n\nThe first step in implementing OAuth2 is [registering an oauth application](/settings/developer/applications) and retrieving your client ID and client secret. Most people who will be implementing OAuth2 will want to find and utilize a library in the language of their choice. For those implementing OAuth2 from scratch, please see [RFC 6749](https://datatracker.ietf.org/doc/html/rfc6749) for details. After you create your application with SalesMessage, make sure that you have your `client_id` and `client_secret` handy. The next step is to figure out which OAuth2 flow is right for your purposes. Here are your options:\n\n- Authorization code grant flow\n\n- Implicit grant flow\n\n##### OAuth2 URLs\n\n| URL | Description |\n|-----------------------|------|\n| `https://app.salesmessage.com/auth/oauth` | Base authorization URL |\n| `https://api.salesmessage.com/pub/v2.3/oauth/token` | Token URL |\n\n#### 1. Authorization code grant flow\n\nThe authorization code grant flow is most suitable for **web and mobile applications**. It differs from the other grant types by requiring the application to launch a browser first to begin the integration.\n\nThe integration consists of the following steps:\n\n1. The application opens a browser to send the user to the OAuth server.\n2. The user receives the authorization prompt and approves the application request.\n3. The user is redirected back to the app with the authorization code in the query string.\n4. The application exchanges the authorization code for an access token.\n\nBelow, you can find the description of the authorization code grant flow in detail.\n\n##### Get user permission\n\nThe application sends the user to a browser to get their permission. To begin the authorization flow, construct and open a URL like:\n\n```\nhttps://app.salesmessage.com/auth/oauth\n?response_type=code\n&client_id={client_id}\n&redirect_uri={redirect_uri}\n&scope={scope}\n&state={state}\n```\n\n##### Examples:\n```\n# Read/write users\nhttps://app.salesmessage.com/auth/oauth?response_type=code&client_id=269&redirect_uri=https://example.app/callback&scope=users:read%20users:write&state=xcoiv98y2kd22vusuye3kch\n\n# Read contacts\nhttps://app.salesmessage.com/auth/oauth?response_type=code&client_id=269&redirect_uri=https://example.app/callback&scope=contacts:read&state=xcoiv98y2kd22vusuye3kch\n```\n\nHere’s each query parameter explained:\n\n| Parameter | Description |\n|-----------------------|------|\n| `Response_type` | Set to code indicating that you want an authorization code as the response. |\n| `Client_id` | The identifier for apps. You will find it on the OAuth Applications page. |\n| `Redirect_uri` | Used to redirect to after the user is granted permission or denied permission. The URI needs to have been entered in the Redirect URI field that the user specified at creating the application. |\n| `Scope` | Stands for the scopes the application is requesting, separated by URL-encoded spaces. |\n| `State` | A value included in the request, which is also returned in the token response. It can be a string of any content that you wish. A randomly generated unique value is typically used for preventing cross-site request forgery attacks. |\n\n##### Successful response\n\nIf the user approves the request, the authorization server will redirect the browser back to the redirect_uri specified by the OAuth application, adding a code and state to the query string.\n\nThe user will be redirected back to an URL such as:\n\n`https://example.app/callback?code=g0ZGZmNjVmOWIjNTk2NTk4ZTYyZGI3&state=xcoiv98y2kd22vusuye3kch`\n\nWhere:\n\n| Parameter | Description |\n|-----------------------|------|\n| `Code` | An authorization code that you can exchange for an access token within 10 minutes. After that, the code expires. |\n| `State` | A value included in the request, which is also returned in the token response. It can be a string of any content that you wish. A randomly generated unique value is typically used for preventing cross-site request forgery attacks. |\n\n##### Exchange the authorization code for an access token\n\nIn case the user approves the request, the OAuth app is ready to exchange the authorization code for an access token. It goes by making a POST request to the 'https://app.salesmessage.com/app/auth/token' endpoint.\n\nThe body of this POST request must contain the following parameters encoded in `application/x-www-form-urlencoded`:\n\n```\nPOST `https://api.salesmessage.com/pub/v2.3/oauth/token`\n\nContent-Type: application/x-www-form-urlencoded\n\n`grant_type`=authorization_code\n\n&`code`=\n\n&`client_id`=\n\n&`client_secret`=\n\n&`redirect_uri`=\n```\n\nWhere:\n\n| Parameter | Description |\n|-----------------------|------|\n| `Grant_type` | Must be set to authorization_code. |\n| `Code` | The authorization code returned from the previous request. |\n| `Client_id` | The identifier for the app. Find it on the OAuth Applications page. |\n| `Client_secret` | The secret of the app. Find it on the OAuth Applications page. |\n| `Redirect_uri` | Used for validation only (there is no actual redirection). The value of the parameter must exactly match the value of `redirect_uri` supplied when requesting the authorization code. |\n\nThe token endpoint will verify all the parameters in the request, **ensuring the code hasn’t expired** and that **the client ID matches the client secret**. If everything checks out, it will generate an access token and return it in the response.\n\n```\nHTTP/1.1 200 OK\nContent-Type: application/json\n{\n\"token_type\": \"Bearer\",\n\"expires_in\": 31536000,\n\"access_token\":\"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3\",\n\"refresh_token\":\"IwOGYzYTlmM2YxOTQ5MGE3YmNmMDFkNTVk\"\n}\n```\n\nWhen the access token expires, use the refresh token to get a new access token. For information about using refresh tokens, see the section below.\n\n##### Request a refreshed access token\n\nAccess tokens are deliberately set to expire after a short time, after which new tokens may be granted by supplying the refresh token originally obtained during the authorization code exchange.\n\nTo refresh the token, a POST request must be sent with the following body parameters encoded in `application/x-www-form-urlencoded`:\n\n```\nPOST https://api.salesmessage.com/pub/v2.3/oauth/token/refresh\nContent-Type: application/x-www-form-urlencoded\ngrant_type=refresh_token\n&client_id=\n&client_secret=\n&refresh_token=\n&scope=public-api\n```\n\nWhere:\n\n| Parameter | Description |\n|-----------------------|------|\n| `Grant_type` | Must be set to `refresh_token` |\n| `Refresh_token` | The refresh token returned from the authorization code exchange. |\n\n### 2. Implicit grant flow\n\nThis flow is meant for apps that don’t use a server, such as **client-side JavaScript apps or mobile apps**.\n\nTo get a user access token using the implicit grant flow, navigate a user to `https://api.salesmessage.com/pub/v2.3/auth/oauth` with the following query parameters that are appropriate for your application:\n\n| Parameter | Description |\n|-----------------------|------|\n| `client_id` | Your app’s registered client ID. |\n| `force_verify` | Set to true to force the user to re-authorize your app’s access to their resources. The default is `false`. |\n| `redirect_uri` | Your app’s registered redirect URI. The access token is sent to this URI. |\n| `response_type` | Must be set to token. |\n| `scope` | Stands for the scopes the application is requesting, separated by URL-encoded spaces. |\n| `state` | A value included in the request, which is also returned in the token response. It can be a string of any content that you wish. A randomly generated unique value is typically used for preventing cross-site request forgery attacks. |\n\nBelow find an example of the URI that you’ll navigate to in your web browser control:\n\n```\nhttps://api.salesmessage.com/pub/v2.3/auth/oauth\n?response_type=token\n&client_id=hof5gwx0su6owfnys0yan9c87zr6t\n&redirect_uri=http://localhost:3000\n&scope=channel%3Amanage%3Apolls+channel%3Aread%3Apolls\n&state=c3ab8aa609ea11e793ae92361f002671\n```\n\nIf the user is logged into Salemsg, Salemsg asks them to authorize your application. In case they’re not logged in, Salemsg asks them to log in first. Then, the user is prompted to authorize your application.\n\nAs soon as the user authorizes your application, the server sends the access token to your redirect URI in the fragment portion of the URI (see the `access_token parameter`):\n\n```\nhttp://localhost:3000/\n#access_token=73d0f8mkabpbmjp921asv2jaidwxn\n&scope=channel%3Amanage%3Apolls+channel%3Aread%3Apolls\n&state=c3ab8aa609ea11e793ae92361f002671\n&token_type=bearer\n```\n\nIn case the user didn’t authorize your application, the server sends the error code and description to your redirect URI (see the `error` and `error_description` parameters).\n\n```\nhttp://localhost:3000/\n?error=access_denied\n&error_description=The+user+denied+you+access\n&state=c3ab8aa609ea11e793ae92361f002671\n```\n\n### PAT: Personal Access Tokens\n\nPersonal Access Tokens (PAT) are an alternative to regular OAuth tokens. Technically, it allows access to our API just like an OAuth token. However, it is tied to the user who creates the request, meaning that they are allowed to directly call the SalesMessage APIs.\nTo create a new Personal Access Token or revoke an existing one, go to the [Personal Access Tokens tab](/settings/developer/access-tokens) in the Settings page. You can request as many as you like, and revoke them at any time.\nYour PAT functions like a password, so it should not be hard coded into any scripts. Store your PAT in a safe space.\n\n## HTTP status codes\n\nUse the following set of HTTP response status codes:\n\n| STATUS | DESCRIPTION |\n|----|------------------------|\n| 200 | The request was a success. |\n| 400 | There was something wrong with incoming data from Salesmsg. Provide an error response body to clarify what went wrong. |\n| 401 |\tSalesmsg sent an OAuth2 access token that isn’t valid. |\n| 403 | Access to this method is forbidden. |\n| 404 | \tSalesmsg is trying to reach a URL that doesn’t exist.|\n| 500 | \tThere was an error in your application logic. |\n| 503 | Your service is not available at the moment, but Salesmsg should try again later. |\n\nEach endpoint of our API returns responses in a JSON format.\n\n## Rate Limits\nThe global rate limit for our API is **60 requests per minute**. If you exceed this, all API calls for the next 60 seconds will be blocked, receiving a HTTP 429 response.", "version": "v2.3" }, "servers": [ { "url": "https://api.salesmessage.com/pub/v2.3" } ], "paths": { "/contacts/opt-in/{contact}": { "put": { "tags": [ "Contacts" ], "summary": "Opt-in contact", "description": "REQUIRED SCOPES ['contacts:write']
An opt-in contact means a contact being enabled for reaching out. In case a contact is currently opt-out, i.e. disabled, this request makes this contact available for communication.

As a result, the current user becomes allowed to send messages to the contact, which is also reflected with a note on the current user’s side bar.", "operationId": "Opt-in contact", "parameters": [ { "name": "contact", "in": "path", "description": "Contact id", "required": true, "schema": { "type": "integer", "example": "1" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResource" } } } }, "401": { "description": "Contact is hard opt'd out", "content": { "application/json": { "schema": { "properties": { "status": { "title": "status", "type": "string" }, "message": { "title": "message", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/opt-out/{contact}": { "put": { "tags": [ "Contacts" ], "summary": "Opt-out contact", "description": "REQUIRED SCOPES ['contacts:write']
An opt-out contact means a contact being disabled for reaching out. In case a contact is currently opt-in, i.e. enabled, this request makes this contact unavailable for communication.

As a result, the current user cannot send messages to the contact from the application, which is also reflected with the following note on the current user’s side bar:

`This contact has been opted-out and will not receive messages from local and tall-free numbers.`

At the same time, the contact themselves can write to the user.", "operationId": "Opt-out contact", "parameters": [ { "name": "contact", "in": "path", "description": "Contact id", "required": true, "schema": { "type": "integer", "example": "1" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResource" } } } } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/users/devices": { "post": { "tags": [ "Users" ], "summary": "Add push token for user device", "description": "REQUIRED SCOPES [‘users:write’]
This API endpoint request adds a token that is responsible for receiving push notifications when logged in so that the user’s device is capable of receiving pushes.

The POST request is sent as the user logs into the mobile application.

As a result, the user can receive notifications each time a message arrives to them.", "operationId": "Add push token for user device", "parameters": [ { "name": "type", "in": "query", "description": "Device type", "required": true, "schema": { "type": "string", "enum": [ "apple", "android" ], "example": "apple" } }, { "name": "token", "in": "query", "description": "Push token", "required": true, "schema": { "type": "string", "example": "token" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDeviceResource" } } } } }, "security": [ { "apiAuth": [ "users:write" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Users" ], "summary": "Delete push token for user device", "description": "REQUIRED SCOPES [‘users:write’]
This API endpoint request removes the token that is responsible for receiving push notifications when logged out from the application. The user’s device becomes incapable of receiving pushes.

The `DELETE` request is sent as the user logs out the mobile application.

As a result, the user can no more receive notifications each time a message arrives to them.", "operationId": "Delete push token for user device", "parameters": [ { "name": "push_token", "in": "query", "description": "Push token", "required": true, "schema": { "type": "string", "example": "token" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "title": "Status", "type": "string" }, "message": { "title": "Message", "type": "string" } }, "type": "object" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "properties": { "status": { "title": "Status", "type": "string" }, "message": { "title": "Message", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "users:write" ] } ], "x-versions": [ "public" ] } }, "/attachments/upload-info": { "get": { "tags": [ "Attachments" ], "summary": "Get attachments size-limits", "description": "REQUIRED SCOPES ['attachments:read']
Get attachments size-limits", "operationId": "Get attachments size-limits", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "size_limit": { "type": "array", "items": { "properties": { "default": { "type": "integer" }, "video": { "type": "integer" }, "vcard": { "type": "integer" }, "image": { "type": "integer" }, "audio": { "type": "integer" } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "attachments:read" ] } ], "x-versions": [ "public" ] } }, "/attachments/download/link": { "post": { "tags": [ "Attachments" ], "summary": "Download selected attachments by link", "description": "REQUIRED SCOPES ['attachments:write']
Download selected attachments by link", "operationId": "Download selected attachments by link", "parameters": [ { "name": "attachment_ids[]", "in": "query", "description": "The IDs of the Attachments", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } } ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "properties": { "link": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "message": { "title": "message", "type": "string" } }, "type": "object" } } } }, "404": { "description": "Attachment Not Found" } }, "security": [ { "apiAuth": [ "attachments:write" ] } ], "x-versions": [ "public" ] } }, "/attachments/download": { "post": { "tags": [ "Attachments" ], "summary": "Download selected attachments", "description": "REQUIRED SCOPES ['attachments:write']
Download selected attachments", "operationId": "Download selected attachments", "parameters": [ { "name": "attachment_ids[]", "in": "query", "description": "The IDs of the Attachments", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } } ], "responses": { "200": { "description": "OK", "content": { "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "message": { "title": "message", "type": "string" } }, "type": "object" } } } }, "404": { "description": "Attachment Not Found" } }, "security": [ { "apiAuth": [ "attachments:write" ] } ], "x-versions": [ "public" ] } }, "/attachments/convert": { "post": { "tags": [ "Attachments" ], "summary": "Convert attachment file", "description": "REQUIRED SCOPES ['attachments:write']
Convert attachment file", "operationId": "Convert attachment file", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "file": { "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentResource" } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "attachments:write" ] } ], "x-versions": [ "public" ] } }, "/attachments": { "delete": { "tags": [ "Attachments" ], "summary": "Delete selected attachments", "description": "REQUIRED SCOPES ['attachments:write']
Delete selected attachments", "operationId": "Delete selected attachments", "parameters": [ { "name": "attachment_ids[]", "in": "query", "description": "The IDs of the Attachments", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "attachments:write" ] } ], "x-versions": [ "public" ] } }, "/attachments/list": { "get": { "tags": [ "Attachments" ], "summary": "Get all attachments", "description": "REQUIRED SCOPES ['attachments:read']
Get all attachments with pagination and filtering options", "operationId": "Get all attachments", "parameters": [ { "name": "term", "in": "query", "description": "Search term to filter attachments", "required": false, "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "description": "Number of attachments per page", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "type", "in": "query", "description": "Filter attachments by type", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "attachments": { "description": "List of attachments sorted by type", "type": "array", "items": { "$ref": "#/components/schemas/AttachmentResource" } }, "space_used": { "description": "Total space used by attachments in megabytes", "type": "integer" }, "page": { "description": "Current page number", "type": "integer" }, "per_page": { "description": "Number of items per page", "type": "integer" }, "total": { "description": "Total number of attachments", "type": "integer" } }, "type": "object" } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "attachments:read" ] } ], "x-versions": [ "public" ] } }, "/attachments/preview": { "get": { "tags": [ "Attachments" ], "summary": "Get preview file", "description": "REQUIRED SCOPES ['attachments:read']
Get preview file", "operationId": "Get preview file", "parameters": [ { "name": "urls[]", "in": "query", "description": "Short Urls", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentResource" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "properties": { "message": { "title": "message", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "attachments:read" ] } ], "x-versions": [ "public" ] } }, "/attachments/recently": { "get": { "tags": [ "Attachments" ], "summary": "Get Recently attachments", "description": "REQUIRED SCOPES ['attachments:read']
Get Recently attachments", "operationId": "Get Recently attachments", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentResource" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "attachments:read" ] } ], "x-versions": [ "public" ] } }, "/attachments/search": { "get": { "tags": [ "Attachments" ], "summary": "Search attachments", "description": "REQUIRED SCOPES ['attachments:read']
Search attachments", "operationId": "3806c432dda133ab5479289f8b4da43c", "parameters": [ { "name": "limit", "in": "query", "description": "Number of attachments to return", "required": false, "schema": { "type": "integer", "default": 100 } }, { "name": "is_aircall", "in": "query", "description": "Filter for Aircall attachments", "required": false, "schema": { "type": "boolean" } }, { "name": "term", "in": "query", "description": "Search term", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentResource" } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "attachments:read" ] } ], "x-versions": [ "public" ] } }, "/attachments/{attachment}": { "post": { "tags": [ "Attachments" ], "summary": "Update an attachment", "description": "REQUIRED SCOPES ['attachments:write']
Update an attachment", "operationId": "2452d163726761418ee4b40422b2d058", "parameters": [ { "name": "attachment", "in": "path", "description": "ID of the attachment to update", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "description": "New name for the attachment", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentResource" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Attachment not found" }, "422": { "description": "Validation error" } }, "security": [ { "apiAuth": [ "attachments:write" ] } ], "x-versions": [ "public" ] } }, "/attachments/upload": { "post": { "tags": [ "Attachments" ], "summary": "Upload attachments", "description": "REQUIRED SCOPES ['attachments:write']
Upload attachment", "operationId": "Upload attachment", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "files[]": { "type": "array", "items": { "type": "string", "format": "binary" } } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentResource" } } } }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "properties": { "files.0": { "type": "string", "example": "We currently only allow: .mp4,.mov,.quicktime,.vcard,.csv,.pdf,.doc,.docx,.xlsx,.jpg,.jpeg,.png,.gif,.vcf,.mp3" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "attachments:write" ] } ], "x-versions": [ "public" ] } }, "/oauth/token": { "post": { "tags": [ "Authorization" ], "summary": "Request access token", "description": "Before you can successfully request a SalesMessage API, you must obtain an access token that grants access to the API.

The `code` your application receives at your Redirect URI is a temporary authorization code that is used to obtain an access token to call the API.

If the token is not redeemed in the alotted time, the user will need to go through the login and authorization process again.", "operationId": "Request access token", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "grant_type", "code", "client_id", "client_secret", "redirect_uri" ], "properties": { "grant_type": { "description": "Must be set to `authorization_code`.", "type": "string", "enum": [ "authorization_code" ], "example": "authorization_code" }, "code": { "description": "The authorization code returned from the Get the User’s Permission request.", "type": "string", "example": "" }, "client_id": { "description": "The client_id is the identifier for the app. Find it on the OAuth Applications page.", "type": "string", "example": "" }, "client_secret": { "description": "The client_secret is the secret of the app. Find it on the OAuth Applications page.", "type": "string", "example": "" }, "redirect_uri": { "description": "This parameter is used for validation only (there is no actual redirection). The value of this parameter must exactly match the value of `redirect_uri` supplied when requesting the authorization code.", "type": "string", "example": "" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "token_type": { "type": "string", "format": "text", "example": "Bearer" }, "expires_in": { "type": "string", "format": "text", "example": "31536000" }, "access_token": { "type": "string", "format": "text", "example": "ouath token string" }, "refresh_token": { "type": "string", "format": "text", "example": "ouath token string" } }, "type": "object" } } } } }, "x-versions": [ "public" ] } }, "/oauth/token/refresh": { "post": { "tags": [ "Authorization" ], "summary": "Refresh access token", "description": "Access tokens are short lived. This was made deliberately for security.

This API endpoint is used to exchange a refresh token for an access token when the access token received from the Authorize user API has expired. You will need the client id and the secret which can be found on the OAuth Applications page.", "operationId": "Refresh access token", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "grant_type", "client_id", "client_secret", "refresh_token" ], "properties": { "grant_type": { "description": "Must be set to `refresh_token`.", "type": "string", "enum": [ "refresh_token" ] }, "client_id": { "description": "The client_id is the identifier for the app. Find it on the OAuth Applications page.", "type": "string", "example": "" }, "client_secret": { "description": "The client_id is the secret of the app. Find it on the OAuth Applications page.", "type": "string", "example": "" }, "refresh_token": { "description": "The refresh token to refresh.", "type": "string", "example": "" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "token_type": { "type": "string", "format": "text", "example": "Bearer" }, "expires_in": { "type": "string", "format": "text", "example": "31536000" }, "access_token": { "type": "string", "format": "text", "example": "ouath token string" }, "refresh_token": { "type": "string", "format": "text", "example": "ouath token string" } }, "type": "object" } } } } }, "x-versions": [ "public" ] } }, "/oauth/personal-token/refresh": { "post": { "tags": [ "Authorization" ], "summary": "Refresh personal access token", "description": "With this endpoint API, you can extend the Personal Access Token for one hour, with the option to extend it later. Note this endpoint accepts a `Bearer authentication token` in the headers.", "operationId": "Refresh personal access token", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "token_type": { "type": "string", "format": "text", "example": "Bearer" }, "expires_in": { "type": "string", "format": "text", "example": "31536000" }, "access_token": { "type": "string", "format": "text", "example": "personal access token" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ], "x-versions": [ "public" ] } }, "/billing/auto-recharge": { "get": { "tags": [ "Billing" ], "summary": "Get auto recharge configuration for the authenticated user", "description": "REQUIRED SCOPES ['billing:read']
Get auto recharge configuration for the authenticated user", "operationId": "501ea23fdad8144b81896ff70c356981", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "id": { "type": "integer" }, "organization_id": { "type": "integer" }, "is_active": { "type": "boolean" }, "amount": { "type": "integer" }, "amount_in_credits": { "type": "integer" }, "threshold": { "type": "integer" }, "threshold_in_credits": { "type": "integer" }, "source": { "type": "string" }, "backup": { "type": "string" }, "failure": { "type": "integer" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "billing:read" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/filters/all": { "get": { "tags": [ "Broadcasts" ], "summary": "Get all broadcasts filters", "description": "REQUIRED SCOPES ['broadcasts:read']
Get all broadcasts filters", "operationId": "ae846912d99cf0499930fa737d4332a4", "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "broadcasts:read" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/all": { "post": { "tags": [ "Broadcasts" ], "summary": "Get all broadcasts", "description": "REQUIRED SCOPES ['broadcasts:write']
Get all broadcasts", "operationId": "c21f184096e3c95a0db0f19fd55a18c9", "parameters": [ { "name": "sortBy", "in": "query", "description": "Sort by", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page of a collection to return.", "schema": { "type": "integer", "default": "1" } }, { "name": "search", "in": "query", "description": "The string to search for..", "schema": { "type": "string" } }, { "name": "length", "in": "query", "description": "The number of items to return per page.", "schema": { "type": "integer", "default": "10" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AllBroadcast" } } } } } }, "security": [ { "apiAuth": [ "broadcasts:write" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/{broadcast}/{status}": { "put": { "tags": [ "Broadcasts" ], "summary": "Change status of a broadcast", "description": "REQUIRED SCOPES ['broadcasts:write']
Change status of a broadcast", "operationId": "f8e28663e859aad037a9b0dbc5b0011c", "parameters": [ { "name": "broadcast", "in": "path", "description": "ID of the broadcast", "required": true, "schema": { "type": "integer" } }, { "name": "status", "in": "path", "description": "New status for the broadcast", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Broadcast" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Broadcast not found" }, "422": { "description": "Validation error" } }, "security": [ { "apiAuth": [ "broadcasts:write" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/contacts/{broadcast}": { "get": { "tags": [ "Broadcasts" ], "summary": "Get contacts broadcasts", "description": "REQUIRED SCOPES ['broadcasts:read']
Get contacts broadcasts", "operationId": "37762d82ea57d76fbe96216a6f2ccda6", "parameters": [ { "name": "broadcast", "in": "path", "description": "The ID of the Broadcast", "required": true, "schema": { "type": "integer", "example": "" } }, { "name": "filter", "in": "query", "description": "Filter", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page of a collection to return.", "schema": { "type": "integer", "default": "1" } }, { "name": "length", "in": "query", "description": "The number of items to return per page.", "schema": { "type": "integer", "default": "10" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResource" } } } } }, "security": [ { "apiAuth": [ "broadcasts:read" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/contacts/{broadcast}/export": { "get": { "tags": [ "Broadcasts" ], "summary": "Export broadcast contacts", "description": "REQUIRED SCOPES ['broadcasts:read']
Export broadcast contacts", "operationId": "2701dca53ec4707ae574fb093a53ec8e", "parameters": [ { "name": "broadcast", "in": "path", "description": "The ID of the Broadcast", "required": true, "schema": { "type": "integer", "example": "" } }, { "name": "filter", "in": "query", "description": "Filter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "url": { "type": "string", "example": "https://app.salesmessage.com/export/contacts.csv" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "broadcasts:read" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/count-estimated-credits": { "post": { "tags": [ "Broadcasts" ], "summary": "Count Estimated Credits", "description": "REQUIRED SCOPES ['broadcasts:write']", "operationId": "f7ac39f4eaf8b1df65385acdb1356f71", "requestBody": { "content": { "application/json": { "schema": { "properties": { "segments_count": { "type": "integer" }, "type": { "type": "string" }, "filtersList": { "type": "array", "items": { "properties": { "0": { "type": "array", "items": { "properties": { "filters": { "type": "array", "items": { "properties": { "0": { "type": "array", "items": { "properties": { "key": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "count": { "type": "integer" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "broadcasts:write" ] } ], "x-versions": [ "public" ] } }, "/broadcasts": { "get": { "tags": [ "Broadcasts" ], "summary": "Get all broadcasts", "description": "REQUIRED SCOPES ['broadcasts:read']
Get all broadcasts", "operationId": "ad31ab5acba74d3f17b93d7d9a9640fd", "parameters": [ { "name": "sortBy", "in": "query", "description": "Sort by", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page of a collection to return.", "schema": { "type": "integer", "default": "1" } }, { "name": "search", "in": "query", "description": "The string to search for..", "schema": { "type": "string" } }, { "name": "length", "in": "query", "description": "The number of items to return per page.", "schema": { "type": "integer", "default": "10" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Broadcast" } } } } } }, "security": [ { "apiAuth": [ "broadcasts:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Broadcasts" ], "summary": "Create broadcast", "description": "REQUIRED SCOPES ['broadcasts:write']
Create broadcast", "operationId": "21945ac1d29a00472a63818433e61ff6", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "number_id", "package_count", "is_send_now" ], "properties": { "name": { "description": "Name", "type": "string", "example": "Test Broadcast" }, "number_id": { "description": "The ID of the Number", "type": "integer", "example": 1 }, "message": { "description": "Message", "type": "string", "example": "Broadcast Message" }, "media_url": { "description": "The url of the media", "type": "array", "items": { "type": "string", "example": "https://test.com/test.png" } }, "send_at": { "description": "Date of send (For Scheduled Broadcasts). UTC", "type": "string", "format": "date", "example": null }, "package_count": { "description": "Count of package", "type": "integer", "example": 10 }, "is_draft": { "description": "This is draft?", "type": "boolean", "example": false }, "numbers_check_type": { "description": "Indicates if we need to check contacts number and which type of check is needed", "type": "integer", "example": null, "nullable": true }, "send_now": { "description": "Is broadcast should be send now?", "type": "boolean", "example": true }, "timezone": { "description": "Timezone Name", "type": "string", "example": "America/New_York" }, "schedule": { "description": "Days for the broadcast to run", "properties": { "days": { "type": "array", "items": { "type": "string" }, "example": "[]" }, "time": { "type": "string", "example": "09:00:00" } }, "type": "object" }, "restrict_hours": { "description": "Restrict Sending Hours", "properties": { "start": { "type": "string", "example": "09:00:00" }, "stop": { "type": "string", "example": "18:00:00" }, "action": { "type": "string", "example": "continue|skip" } }, "type": "object" }, "assignee": { "description": "Assignee", "properties": { "type": { "type": "string", "example": "default|member|contact_owner|unassigned" }, "member_id": { "type": "integer", "example": 1, "nullable": true } }, "type": "object" }, "filters": { "properties": { "filtersListGroups": { "properties": { "tags": { "type": "array", "items": { "type": "integer" }, "example": "[]" }, "contacts": { "type": "array", "items": { "type": "integer" }, "example": "[]" }, "segments": { "type": "array", "items": { "type": "integer", "example": 3 } }, "advanced": { "type": "array", "items": { "type": "integer" }, "example": "[]" } }, "type": "object" } }, "type": "object" }, "chatbot": { "description": "Chatbot configuration for handling replies", "properties": { "id": { "description": "Chatbot ID", "type": "integer", "example": 1 } }, "type": "object" }, "enable_quiet_hours": { "description": "Is enable quiet hours сheck", "type": "boolean", "example": true } }, "type": "object" } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Broadcast" } } } }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" }, "code": { "title": "error", "type": "string" }, "amount": { "title": "error", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" }, "code": { "title": "error", "type": "string" }, "amount": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "broadcasts:write" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/schedule": { "get": { "tags": [ "Broadcasts" ], "summary": "Get broadcast by start and finish date", "description": "REQUIRED SCOPES ['broadcasts:read']
Get broadcast by start and finish date", "operationId": "a4779626691841741d85fc7fe368c370", "parameters": [ { "name": "packages", "in": "query", "description": "Packages", "required": true, "schema": { "type": "integer" } }, { "name": "start_date", "in": "query", "description": "Start date", "schema": { "type": "date" } }, { "name": "schedule", "in": "query", "description": "Days for the broadcast to run", "schema": { "type": "date" } }, { "name": "package_count", "in": "query", "description": "Count of package", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "broadcasts:read" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/{id}": { "get": { "tags": [ "Broadcasts" ], "summary": "Get broadcast", "description": "REQUIRED SCOPES ['broadcasts:read']
Get broadcast", "operationId": "3deec00de52fad74b986294c14c4872f", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the Broadcast", "required": true, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Broadcast" } } } } }, "security": [ { "apiAuth": [ "broadcasts:read" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Broadcasts" ], "summary": "Delete broadcast", "description": "REQUIRED SCOPES ['broadcasts:write']
Delete broadcast", "operationId": "2b0b4ba323e79d7c0a628db73b3d8d6f", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the Broadcast", "required": true, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "properties": { "status": { "title": "status", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "broadcasts:write" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/failed/{broadcastId}": { "get": { "tags": [ "Broadcasts" ], "summary": "Get failed broadcasts", "description": "REQUIRED SCOPES ['broadcasts:read']
Get failed broadcasts", "operationId": "8c19cde49aa5f23b7c9fcdc0013fd3ef", "parameters": [ { "name": "broadcastId", "in": "path", "description": "The ID of the Broadcast", "required": true, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FailedMessages" } } } } } }, "security": [ { "apiAuth": [ "broadcasts:read" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/fields": { "post": { "tags": [ "Broadcasts" ], "summary": "Update broadcast fields settings", "description": "REQUIRED SCOPES ['broadcasts:write']
Update broadcast fields settings", "operationId": "a6267e0f61fefb79584be1640f592d84", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "broadcast_fields", "type" ], "properties": { "broadcast_fields": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "broadcastFields": { "type": "object", "additionalProperties": true } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "422": { "description": "Validation error" } }, "security": [ { "apiAuth": [ "broadcasts:write" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/filters": { "get": { "tags": [ "Broadcasts" ], "summary": "Get all broadcasts filters", "description": "REQUIRED SCOPES ['broadcasts:read']
Get all broadcasts filters", "operationId": "07182fb74ea6b1dc933cbfec2721b809", "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "broadcasts:read" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/recurring/{templateBroadcast}/active": { "put": { "tags": [ "Broadcasts Recurring" ], "summary": "Activate recurring template", "description": "REQUIRED SCOPES ['broadcasts-recurring:write']
Activate recurring template", "operationId": "b5a220e12e1ffce0add3e39b14b15a7a", "parameters": [ { "name": "templateBroadcast", "in": "path", "description": "The ID of the Recurring Template Broadcast", "required": true, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "broadcasts-recurring:write" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/recurring/{templateBroadcast}/delete": { "delete": { "tags": [ "Broadcasts Recurring" ], "summary": "Delete recurring template", "description": "REQUIRED SCOPES ['broadcasts-recurring:write']
Delete recurring template", "operationId": "b83436049b45132f761ee9159851197d", "parameters": [ { "name": "templateBroadcast", "in": "path", "description": "The ID of the Recurring Template Broadcast", "required": true, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "broadcasts-recurring:write" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/recurring/filters": { "get": { "tags": [ "Broadcasts Recurring" ], "summary": "Get all recurring broadcasts filters", "description": "REQUIRED SCOPES ['broadcasts-recurring:read']
Get all recurring broadcasts filters", "operationId": "927c4e303dad9220d62adf467a83c939", "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "broadcasts-recurring:read" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/recurring/{templateBroadcast}/finish": { "put": { "tags": [ "Broadcasts Recurring" ], "summary": "Finish recurring template", "description": "REQUIRED SCOPES ['broadcasts-recurring:write']
Finish recurring template", "operationId": "d856608e87c9682b21f02ed3954bdcf9", "parameters": [ { "name": "templateBroadcast", "in": "path", "description": "The ID of the Recurring Template Broadcast", "required": true, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "broadcasts-recurring:write" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/recurring/{templateBroadcast}/inactive": { "put": { "tags": [ "Broadcasts Recurring" ], "summary": "Inactivate recurring template", "description": "REQUIRED SCOPES ['broadcasts-recurring:write']
Inactivate recurring template", "operationId": "a8230c94e48f6ff2d43420d83fd0f6fe", "parameters": [ { "name": "templateBroadcast", "in": "path", "description": "The ID of the Recurring Template Broadcast", "required": true, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "broadcasts-recurring:write" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/recurring": { "get": { "tags": [ "Broadcasts Recurring" ], "summary": "Get all recurring templates", "description": "REQUIRED SCOPES ['broadcasts-recurring:read']
Get all recurring templates", "operationId": "f2570bd97c327a32cf811a57566306ed", "parameters": [ { "name": "page", "in": "query", "description": "The page of a collection to return.", "schema": { "type": "integer", "default": "1" } }, { "name": "search", "in": "query", "description": "The string to search for..", "schema": { "type": "string" } }, { "name": "length", "in": "query", "description": "The number of items to return per page.", "schema": { "type": "integer", "default": "10" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "broadcasts-recurring:read" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/recurring/{templateBroadcast}/rename": { "put": { "tags": [ "Broadcasts Recurring" ], "summary": "Rename recurring template", "description": "REQUIRED SCOPES ['broadcasts-recurring:write']
Rename recurring template", "operationId": "f97a1ea9f589f4bf617e6eb9c1983088", "parameters": [ { "name": "templateBroadcast", "in": "path", "description": "The ID of the Recurring Template Broadcast", "required": true, "schema": { "type": "integer", "example": "" } }, { "name": "name", "in": "query", "description": "Name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "broadcasts-recurring:write" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/recurring/{broadcast}/stop-all-future": { "put": { "tags": [ "Broadcasts Recurring" ], "summary": "Stop all future recurring broadcasts", "description": "REQUIRED SCOPES ['broadcasts-recurring:write']
Stop all future recurring broadcasts", "operationId": "f078c330f414e772a176fa8e58900532", "parameters": [ { "name": "broadcast", "in": "path", "description": "ID of the broadcast", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Broadcast" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Broadcast not found" } }, "security": [ { "apiAuth": [ "broadcasts-recurring:write" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/recurring/{templateBroadcastId}/details": { "get": { "tags": [ "Broadcasts Recurring" ], "summary": "Get broadcasts list related to recurring template", "description": "REQUIRED SCOPES ['broadcasts-recurring:read']
Get broadcasts list related to recurring template", "operationId": "7683842240728540cd270a30d829b7e0", "parameters": [ { "name": "templateBroadcastId", "in": "path", "description": "The ID of the Recurring Template Broadcast", "required": true, "schema": { "type": "integer", "example": "" } }, { "name": "page", "in": "query", "description": "The page of a collection to return.", "schema": { "type": "integer", "default": "1" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "broadcasts-recurring:read" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/test": { "post": { "tags": [ "Broadcasts" ], "summary": "Broadcast test", "description": "REQUIRED SCOPES ['broadcasts:write']
Broadcast test", "operationId": "fe4fb27b83dafaf13a6d9410ccbd3727", "parameters": [ { "name": "number", "in": "query", "description": "Number", "required": true, "schema": { "type": "string" } }, { "name": "number_id", "in": "query", "description": "The ID of the Number", "required": true, "schema": { "type": "integer" } }, { "name": "message", "in": "query", "description": "Message", "schema": { "type": "string" } }, { "name": "media_url[]", "in": "query", "description": "The url of the media", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "broadcasts:write" ] } ], "x-versions": [ "public" ] } }, "/broadcasts/{broadcastId}": { "put": { "tags": [ "Broadcasts" ], "summary": "Update broadcast", "description": "REQUIRED SCOPES ['broadcasts:write']
Update broadcast", "operationId": "ec48a421cefe20ad00e67c8e36451ac3", "parameters": [ { "name": "broadcastId", "in": "path", "description": "The ID of the Broadcast", "required": true, "schema": { "type": "integer", "example": "" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "id", "number_id", "package_count" ], "properties": { "id": { "description": "The ID of the Broadcast", "type": "integer", "example": 1 }, "name": { "description": "Name", "type": "string", "example": "Test Broadcast" }, "number_id": { "description": "The ID of the Number", "type": "integer", "example": 1 }, "message": { "description": "Message", "type": "string", "example": "Broadcast Message" }, "media_url": { "description": "The url of the media", "type": "array", "items": { "type": "string", "example": "https://test.com/test.png" } }, "send_at": { "description": "Date of send (For Scheduled Broadcasts). UTC", "type": "string", "format": "date", "example": null }, "package_count": { "description": "Count of package", "type": "integer", "example": 10 }, "is_cloned": { "description": "This is cloned?", "type": "boolean", "example": false }, "is_draft": { "description": "This is draft?", "type": "boolean", "example": false }, "is_rvm": { "description": "This is Ringless Voicemail?", "type": "boolean", "example": false }, "numbers_check_type": { "description": "Indicates if we need to check contacts number and which type of check is needed", "type": "integer", "example": null, "nullable": true }, "send_now": { "description": "Is broadcast should be send now?", "type": "boolean", "example": true }, "timezone": { "description": "Timezone Name", "type": "string", "example": "America/New_York" }, "schedule": { "description": "Days for the broadcast to run", "properties": { "days": { "type": "array", "items": { "type": "string" }, "example": "[]" }, "time": { "type": "string", "example": "09:00:00" } }, "type": "object" }, "restrict_hours": { "description": "Restrict Sending Hours", "properties": { "start": { "type": "string", "example": "09:00:00" }, "stop": { "type": "string", "example": "18:00:00" }, "action": { "type": "string", "example": "continue|skip" } }, "type": "object" }, "assignee": { "description": "Assignee", "properties": { "type": { "type": "string", "example": "default|member|contact_owner|unassigned" }, "member_id": { "type": "integer", "example": 1, "nullable": true } }, "type": "object" }, "filters": { "properties": { "filtersListGroups": { "properties": { "tags": { "type": "array", "items": { "type": "integer" }, "example": "[]" }, "contacts": { "type": "array", "items": { "type": "integer" }, "example": "[]" }, "segments": { "type": "array", "items": { "type": "integer", "example": 3 } }, "advanced": { "type": "array", "items": { "type": "integer" }, "example": "[]" } }, "type": "object" } }, "type": "object" }, "chatbot": { "description": "Chatbot configuration for handling replies", "properties": { "id": { "description": "Chatbot ID", "type": "integer", "example": 1 } }, "type": "object" }, "enable_quiet_hours": { "description": "Is enable quiet hours сheck", "type": "boolean", "example": true } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Broadcast" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" }, "code": { "title": "code", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "broadcasts:write" ] } ], "x-versions": [ "public" ] } }, "/canned-messages": { "get": { "tags": [ "Saved Replies" ], "summary": "Get user saved replies", "description": "REQUIRED SCOPES ['saved-replies:read']
You can use this API endpoint to get the list of the available saved replies. The request returnes a JSON array of saved replies.

In addition, it is allowed to:
  • Specify the number of saved replies to fetch per page
  • Specify the page number
  • Set the limit of saved replies to be fetched per page (if the limit is not set, the default limit will be considered)
  • Filter by title and text of saved replies
", "operationId": "Get user saved replies", "parameters": [ { "name": "integration_id", "in": "query", "description": "Integration id", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "search", "in": "query", "description": "Filter by title, message", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "length", "in": "query", "description": "Results per page", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "page", "in": "query", "description": "Page", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "contact_id", "in": "query", "description": "Contact id", "required": false, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CannedMessageResource" } } } } } }, "security": [ { "apiAuth": [ "saved-replies:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Saved Replies" ], "summary": "Create saved reply", "description": "REQUIRED SCOPES ['saved-replies:write']
You can use this API endpoint to create a saved reply.

The properties that you need to put into your request include:
  • Contact id with which the new saved reply should be mapped
  • The content URL for media for the saved reply if needed.
  • Set public key to either true or false (if the key is set to false, the saved reply is private and only visible to the user who created it. If the key is set to true, the saved reply will be visible to all users across the system)
  • Title string for the saved reply
", "operationId": "Create saved reply", "parameters": [ { "name": "title", "in": "query", "description": "Title", "required": true, "schema": { "type": "string", "example": "" } }, { "name": "message", "in": "query", "description": "Message", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "public", "in": "query", "description": "Public", "required": true, "schema": { "type": "boolean", "example": "true" } }, { "name": "integration_id", "in": "query", "description": "Interation id", "required": false, "schema": { "type": "integer", "example": "" } }, { "name": "media_url", "in": "query", "description": "Url for media", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "contact_id", "in": "query", "description": "Contact id", "required": false, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CannedMessageResource" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "error": { "title": "Error message", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "saved-replies:write" ] } ], "x-versions": [ "public" ] } }, "/canned-messages/{cannedMessage}": { "get": { "tags": [ "Saved Replies" ], "summary": "Get saved reply", "description": "REQUIRED SCOPES ['saved-replies:read']
You can use this API endpoint to get a single saved reply by the saved reply id.

As a result of this API request, a saved reply is obtained from the list of all available saved replies.", "operationId": "Get saved reply", "parameters": [ { "name": "cannedMessage", "in": "path", "description": "Canned message id", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CannedMessageResource" } } } } }, "security": [ { "apiAuth": [ "saved-replies:read" ] } ], "x-versions": [ "public" ] }, "put": { "tags": [ "Saved Replies" ], "summary": "Update saved reply", "description": "REQUIRED SCOPES ['saved-replies:write']
Through this API request you are allowed to update a saved reply. The endpoint updates the specified saved reply by setting the values of the properties.

Properties that can be modified for saved replies include:
  • Contact id with which the saved reply is mapped
  • Content URLs for media
  • Public key switcher (to choose whether to make the saved reply private or visible to all the users)

Any parameters not provided will be left unchanged.

", "operationId": "Update saved reply", "parameters": [ { "name": "cannedMessage", "in": "path", "description": "Canned message id", "required": true, "schema": { "type": "string", "example": "" } }, { "name": "title", "in": "query", "description": "Title", "required": true, "schema": { "type": "string", "example": "" } }, { "name": "message", "in": "query", "description": "Message", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "public", "in": "query", "description": "Public", "required": true, "schema": { "type": "boolean", "example": "true" } }, { "name": "integration_id", "in": "query", "description": "Integration id", "required": false, "schema": { "type": "integer", "example": "" } }, { "name": "media_url", "in": "query", "description": "Media url", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "contact_id", "in": "query", "description": "Contact id", "required": false, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CannedMessageResource" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "error": { "title": "Error message", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "saved-replies:write" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Saved Replies" ], "summary": "Delete saved reply", "description": "REQUIRED SCOPES ['saved-replies:write']
You can use this API endpoint to delete a saved reply by its id.

As a result, through the request, any identified saved reply with its corresponding properties will automatically be removed.", "operationId": "Delete saved reply", "parameters": [ { "name": "cannedMessage", "in": "path", "description": "Canned message id", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": "[]" } } } }, "security": [ { "apiAuth": [ "saved-replies:write" ] } ], "x-versions": [ "public" ] } }, "/canned-messages/{cannedMessage}/favorite": { "patch": { "tags": [ "Saved Replies" ], "summary": "Toggle favorite", "description": "REQUIRED SCOPES ['saved-replies:write']
You can use this API endpoint to toggle favorite for reply.", "operationId": "Toggle favorite", "parameters": [ { "name": "cannedMessage", "in": "path", "description": "Canned Message ID", "required": true, "schema": { "type": "integer", "example": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "favorite" ], "properties": { "favorite": { "title": "Is Favorite", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CannedMessageResource" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "error": { "title": "Error message", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "saved-replies:write" ] } ], "x-versions": [ "public" ] } }, "/canned-messages/search": { "get": { "tags": [ "Saved Replies" ], "summary": "Search for saved replies", "description": "REQUIRED SCOPES ['saved-replies:read']
This API endpoint enables you to search for saved replies matching a query. The search is based on the сontact id.

In order to easily find the saved reply you need, it is allowed to specify the number of results per page and filter saved replies by title.

The request returns a list of saved replies containing a specific search term.", "operationId": "Search for saved replies", "parameters": [ { "name": "integration_id", "in": "query", "description": "Integration id", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "search", "in": "query", "description": "Filter by title, message", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "length", "in": "query", "description": "Results per page", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "page", "in": "query", "description": "Page", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "contact_id", "in": "query", "description": "Contact id", "required": false, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/CannedMessageResource" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "saved-replies:read" ] } ], "x-versions": [ "public" ] } }, "/compliance/toll-free/{profile}/resubmit": { "post": { "tags": [ "TollFree" ], "summary": "Resubmit Toll Free verification", "description": "REQUIRED SCOPES ['toll-free:write']
Resubmit verification for a Toll Free number profile", "operationId": "5c5808d10e8b739cdeb5f813c1561424", "parameters": [ { "name": "profile", "in": "path", "description": "ID of the toll-free profile", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "number_id": { "description": "ID of the number (optional)", "type": "integer", "example": 1 } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "ok": { "type": "string", "example": "ok" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "Failed to Re-submit Toll Free Verification" } }, "type": "object" } } } } }, "x-versions": [ "public" ] } }, "/contacts/{contact}": { "get": { "tags": [ "Contacts" ], "summary": "Get contact by id", "description": "REQUIRED SCOPES ['contacts:read']
The Get contact by id endpoint returns all the information and all fields for a contact by its id for a given account. Additionally, the endpoint can be used to get the id of a contact.", "operationId": "Get contact by id", "parameters": [ { "name": "contact", "in": "path", "description": "ID of contact", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResource" } } } } }, "security": [ { "apiAuth": [ "contacts:read" ] } ], "x-versions": [ "public" ] }, "put": { "tags": [ "Contacts" ], "summary": "Update contact", "description": "REQUIRED SCOPES ['contacts:write']
This endpoint is used to update an existing contact within the system. It updates the properties specified in the request.

In case you've been updating contact records in an external database, the endpoint will help sync those updates to your system. You can use the update contact endpoint to complete the sync and avoid making manual updates.", "operationId": "Update contact", "parameters": [ { "name": "contact", "in": "path", "description": "Contact id", "required": true, "schema": { "type": "integer", "example": "1" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "contact": { "description": "Contact id", "type": "string" }, "number": { "description": "Number", "type": "string" }, "integration_id": { "description": "Integration id", "type": "integer" }, "first_name": { "description": "First name", "type": "string" }, "last_name": { "description": "Last name", "type": "string" }, "email": { "description": "Email", "type": "string" }, "contact_integration_id": { "description": "Contact integration id", "type": "string" }, "customFields": { "description": "Custom fields", "type": "object", "additionalProperties": { "type": "array", "items": { "properties": { "type": { "type": "string" } }, "type": "object" } } } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResource" } } } } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Contacts" ], "summary": "Delete contact", "description": "REQUIRED SCOPES ['contacts:write']
This endpoint deletes one or more existing contacts from a user’s contact block.

If a contact with the same id interacts with the current user again, the contact will be added back into the user’s interface.", "operationId": "Delete contact", "parameters": [ { "name": "contact", "in": "path", "description": "Contact id", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] }, "patch": { "tags": [ "Contacts" ], "summary": "Update contact attribues", "description": "REQUIRED SCOPES ['contacts:write']
Through this API request, you are able to change the values set within the attributes of the contact. Attributes that can be changed include: photo URL, phone number, country, country calling code, national number, and typeted number.", "operationId": "d48dae669928cf02d7649a31de8d8d19", "parameters": [ { "name": "contact", "in": "path", "description": "The ID of the Contact", "required": true, "schema": { "type": "integer", "example": "" } }, { "name": "attribute", "in": "query", "description": "Attribute", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Value", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactResource" } } } } } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/bulk": { "put": { "tags": [ "Contacts" ], "summary": "Bulk to contact", "description": "REQUIRED SCOPES ['contacts:write']
Bulk to contact", "operationId": "Bulk to contact", "requestBody": { "content": { "application/json": { "schema": { "properties": { "contacts": { "description": "The IDs of the Contacts", "type": "array", "items": { "type": "integer", "example": 1 } }, "bulk_all": { "description": "Bulk All", "type": "boolean", "default": false }, "team_id": { "description": "Team id", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/opt-out/bulk": { "put": { "tags": [ "Contacts" ], "summary": "Bulk opt-out to contact", "description": "REQUIRED SCOPES ['contacts:write']
Bulk opt-out to contact", "operationId": "Bulk opt-out to contact", "requestBody": { "content": { "application/json": { "schema": { "properties": { "contacts": { "description": "The IDs of the Contacts", "type": "array", "items": { "type": "integer", "example": 1 } }, "bulk_all": { "description": "Bulk All", "type": "boolean", "default": false }, "team_id": { "description": "Team id", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts": { "get": { "tags": [ "Contacts" ], "summary": "Get user's contacts", "description": "REQUIRED SCOPES ['contacts:read']
For a given user, returns all contacts that have been created in the account. A paginated list of contacts will be returned to you.

The number of contacts per page can be changed. It’s set to 10 by defalt and can be switched to a maximum of 100 contacts per page.", "operationId": "Get users contacts", "parameters": [ { "name": "search", "in": "query", "description": "Filter by first_name, last_name, email, number, formatted_number, tag label", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "length", "in": "query", "description": "Results per page", "required": false, "schema": { "type": "string", "example": "10" } }, { "name": "page", "in": "query", "description": "Page", "required": false, "schema": { "type": "string", "example": "1" } }, { "name": "sortBy", "in": "query", "description": "Sort by field (first_name, last_name, email, number, formatted_number, tag label, etc)", "required": false, "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sorting order", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "filtersList", "in": "query", "description": "List of filters to apply", "required": false, "schema": { "type": "array", "items": { "properties": { "filters": { "type": "array", "items": { "properties": { "key": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "format": "query" } } }, "type": "object", "format": "query" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactResource" } } }, "type": "object" } } } } }, "deprecated": true, "security": [ { "apiAuth": [ "contacts:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Contacts" ], "summary": "Create contact", "description": "REQUIRED SCOPES ['contacts:write']
This endpoint is used to create a new contact. The new contact will be assigned a unique id which can be used to look it up later.

Additionally, you can configure integration with a 3rd party application to perform a one-time sync of new contacts from an external system into yours.

For instance, you can easily integrate with HubSpot, ActiveCampaign, Pipedrive, etc..", "operationId": "Create contact", "parameters": [ { "name": "number", "in": "query", "description": "Number", "required": true, "schema": { "type": "string", "example": "" } }, { "name": "integration_id", "in": "query", "description": "Integration id", "required": false, "schema": { "type": "integer", "example": "" } }, { "name": "first_name", "in": "query", "description": "First name", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "last_name", "in": "query", "description": "Last name", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "email", "in": "query", "description": "Email", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "color_index", "in": "query", "description": "Color index", "required": false, "schema": { "type": "integer", "example": "" } }, { "name": "contact_integration_id", "in": "query", "description": "Contact integration id", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "phone_type", "in": "query", "description": "Phone type (phone, etc)", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "owner_id", "in": "query", "description": "Owner id", "required": false, "schema": { "type": "integer", "example": "" } }, { "name": "source", "in": "query", "description": "Source", "required": false, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResource" } } } } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Contacts" ], "summary": "Delete contacts", "description": "REQUIRED SCOPES ['contacts:write']
Delete contacts", "operationId": "7ed996085981b82d50e291b907ac9889", "parameters": [ { "name": "ids[]", "in": "query", "description": "The IDs of the Contacts", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "bulk_all", "in": "query", "description": "Bulk All", "schema": { "type": "integer", "default": 0, "maximum": 1, "minimum": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": "[]" } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/tags": { "post": { "tags": [ "Contacts" ], "summary": "Attach tags to contact", "description": "REQUIRED SCOPES ['contacts:write']
Add tags to contact", "operationId": "Attach tags to contact", "requestBody": { "content": { "application/json": { "schema": { "properties": { "contact_ids": { "description": "The IDs of the Contacts", "type": "array", "items": { "type": "integer", "example": 1 } }, "bulk_all": { "description": "Bulk All", "type": "boolean", "default": false }, "team_id": { "description": "Team id", "type": "integer" }, "tags": { "description": "The IDs of the Tags", "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns appliead tags instance.", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "owner_id": { "type": "integer", "example": 1 }, "organization_id": { "type": "integer", "example": 1 }, "label": { "type": "string", "example": "Test tag" }, "name": { "type": "string", "example": "test-tag" }, "type": { "type": "string", "example": "organization" }, "classname": { "type": "string", "example": "light" }, "created_at": { "type": "string", "example": "2022-09-27T12:11:50.000000Z" }, "updated_at": { "type": "string", "example": "2022-09-27T12:11:50.000000Z" } }, "type": "object" } } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/tags/remove": { "delete": { "tags": [ "Contacts" ], "summary": "Remove bulk tags", "description": "REQUIRED SCOPES ['contacts:write']
This endpoint allows for removing tag array in bulk. Tags with the given tag ids get erased from contacts with given ids.", "operationId": "810c481779d645c328d05a2be5f9b659", "parameters": [ { "name": "contact_ids", "in": "query", "description": "The IDs of the Contacts", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "tags", "in": "query", "description": "The IDs of the Tags", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "remove_all", "in": "query", "description": "Remove All", "schema": { "type": "boolean" } }, { "name": "conversation_filter", "in": "query", "description": "Remove All", "schema": { "type": "string" } }, { "name": "team_id", "in": "query", "description": "Team id", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "contacts": { "type": "array", "items": { "type": "integer" } }, "tags": { "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "404": { "description": "Organization Not Found" } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/tags/{tag}": { "get": { "tags": [ "Contacts" ], "summary": "Get contacts by tag", "description": "REQUIRED SCOPES ['contacts:read']
Get paginated contacts which have provided tag", "operationId": "cb9d2594f42d3a39eabe6e7d8133aa2e", "parameters": [ { "name": "tag", "in": "path", "description": "The ID of the Tag", "required": true, "schema": { "type": "integer", "example": "" } }, { "name": "page", "in": "query", "description": "The page of a collection to return.", "schema": { "type": "integer", "default": "1" } }, { "name": "search", "in": "query", "description": "The string to search for..", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The number of items to return per page.", "schema": { "type": "integer", "default": "20" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResource" } } } } }, "security": [ { "apiAuth": [ "contacts:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/block/{contact}": { "post": { "tags": [ "Contacts" ], "summary": "Block contact", "description": "REQUIRED SCOPES ['contacts:write']
The request blocks an existing contact with a given id from the contact list.", "operationId": "252ff5a6b8c08e96f71d2cb640c48177", "parameters": [ { "name": "contact", "in": "path", "description": "The ID of the Contact", "required": true, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResource" } } } } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/unblock/{contact}": { "post": { "tags": [ "Contacts" ], "summary": "Unblock contact", "description": "REQUIRED SCOPES ['contacts:write']
The request allows for unblocking a contact by the blocked contact id and adds it back to the contact list.", "operationId": "00e747d0813ccc820c6255127d0bbd26", "parameters": [ { "name": "contact", "in": "path", "description": "The ID of the Contact", "required": true, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResource" } } } } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/fields": { "post": { "tags": [ "Contacts" ], "summary": "Set the list of columns for Contacts table", "description": "REQUIRED SCOPES ['contacts:write']
Set the list of contact fields to display on Contacts page for current user", "operationId": "4a11802062d1ea9ca8bc51c574def9aa", "parameters": [ { "name": "contact_fields[]", "in": "query", "description": "The List of contact fields", "required": true, "schema": { "type": "array", "items": { "type": "string", "example": "name" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "contact_fields": { "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer" }, "organization_id": { "type": "integer" }, "active_fields": { "type": "array", "items": { "properties": { "id": { "title": "ID", "type": "integer" }, "user_id": { "title": "User Id", "type": "integer" }, "organization_id": { "title": "Organization Id", "type": "integer" }, "active_fields": { "title": "Active Fields JSON", "type": "string" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/{contact}/conversations": { "get": { "tags": [ "Contacts" ], "summary": "Get conversation by contact", "description": "REQUIRED SCOPES ['contacts:read']
Get conversation by contact", "operationId": "8107605cefa2cd280b37ec39cc0c9b79", "parameters": [ { "name": "contact", "in": "path", "description": "The ID of the Contact", "required": true, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationResource" } } } } }, "security": [ { "apiAuth": [ "contacts:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/{contact}/conversation-history/messages": { "get": { "tags": [ "Contacts" ], "summary": "Get conversation history messages for a contact", "description": "REQUIRED SCOPES ['contacts:read']", "operationId": "82474f12da99cb9410ccea89994b09ed", "parameters": [ { "name": "contact", "in": "path", "description": "ID of the contact", "required": true, "schema": { "type": "integer" } }, { "name": "with_activity_logs", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Contact not found" } }, "security": [ { "apiAuth": [ "contacts:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/custom-fields/{contact}": { "get": { "tags": [ "Contacts" ], "summary": "Get contact's custom fields", "description": "REQUIRED SCOPES ['contacts:read']
This request fetches properties of all the fields of a particular contact matching the required id, including custom fields. The endpoint offers the mechanism of creating and adding any custom field, such as city, to the system.

Each contact has four fields by defaut:
  • First name
  • Last name
  • Email
  • Phone number
", "operationId": "Get contacts custom fields", "parameters": [ { "name": "contact", "in": "path", "description": "ID of contact", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Age" }, "field_key": { "type": "string", "example": "custom.age" }, "visiable": { "type": "integer", "example": 0 }, "type": { "type": "string", "example": "number" }, "value": { "properties": { "type": { "type": "string", "example": "number" }, "value": { "type": "string", "example": "30" } }, "type": "object" } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "contacts:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/{contact}/custom-fields": { "put": { "tags": [ "Contacts" ], "summary": "Update contact`s custom field", "description": "REQUIRED SCOPES ['contacts:write']
This request allows for updating properties of each custom field separately by contact id and a particular field’s key. As a result, the endpoint returns a contact’s fields already updated.

So as we call all the custom fields again, we will see this custom field updated.

*Note.* For Custom field of the date type, the format is `YYYY-MM-DD`.", "operationId": "Update contact`s custom field", "parameters": [ { "name": "contact", "in": "path", "description": "ID of contact", "required": true, "schema": { "type": "integer" } }, { "name": "custom_field_key", "in": "query", "description": "Custom Field Key", "required": true, "schema": { "type": "string", "example": "custom.email" } }, { "name": "value", "in": "query", "description": "Value", "required": true, "schema": { "type": "string", "example": "email@example.com" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResource" } } } } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/export": { "get": { "tags": [ "Contacts" ], "summary": "Export contacts", "description": "REQUIRED SCOPES ['contacts:read']
This API endpoint request returns a list of all the user’s contacts as a link to the CSV file for download.", "operationId": "878f28d33dd5a79cc7b1386aa8deb203", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "url": { "type": "string" } }, "type": "object" } } } } } }, "security": [ { "apiAuth": [ "contacts:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/filter": { "post": { "tags": [ "Contacts" ], "summary": "Filter contacts based on provided criteria", "description": "REQUIRED SCOPES ['contacts:write']", "operationId": "be08eaa3313032e729b2549b4922437d", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "type": "object", "additionalProperties": [ { "type": "array", "items": { "type": "string" }, "property": null } ] } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "object", "additionalProperties": [ { "type": "boolean", "property": null } ] } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/filters": { "get": { "tags": [ "Contacts" ], "summary": "Get contact filters", "description": "REQUIRED SCOPES ['contacts:read']
This request returnes a list of filters that belong to the Contacts section by default and are used there for search.", "operationId": "c2b9fe31b2121424b8ea6a22f55faf3c", "parameters": [ { "name": "withValues", "in": "query", "description": "Show values for contact filters", "required": false, "schema": { "type": "boolean" } }, { "name": "skipValues[]", "in": "query", "description": "Do not display values for passed filters keys. Works only when query param withValues equals true", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "withCustomFields", "in": "query", "description": "Show custom fields filter", "required": false, "schema": { "type": "boolean" } }, { "name": "workflowSource", "in": "query", "description": "Workflow Source", "required": false, "schema": { "type": "string" } }, { "name": "withWorkflowFields", "in": "query", "description": "Show workflow list filter", "required": false, "schema": { "type": "boolean" } }, { "name": "withIntegrationList", "in": "query", "description": "Show integration list filter", "required": false, "schema": { "type": "boolean" } }, { "name": "withFullHubSpotList", "in": "query", "description": "Show HubSpot list filter", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "filters": { "type": "array", "items": { "type": "object" } }, "operators": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "contacts:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/filters/values/{fieldKey}": { "get": { "tags": [ "Contacts" ], "summary": "Get contact filter values", "description": "REQUIRED SCOPES ['contacts:read']
This request returnes a list of filter values by filter key", "operationId": "3aa67b650ab2c1de1529efafdbb0edd9", "parameters": [ { "name": "fieldKey", "in": "path", "description": "Field key", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Filter with key not found." }, "status": { "type": "integer", "example": 404 } }, "type": "object" } } } }, "422": { "description": "Forbidden", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Filter with key does not support values." }, "status": { "type": "integer", "example": 422 } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "contacts:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/filters/selected-values/{fieldKey}": { "get": { "tags": [ "Contacts" ], "summary": "Get contact filter selected values", "description": "REQUIRED SCOPES ['contacts:read']
This request returnes a list of selected filter values by filter key", "operationId": "741e281cadaff427caf59c841d96c6d9", "parameters": [ { "name": "fieldKey", "in": "path", "description": "Field key", "required": true, "schema": { "type": "string" } }, { "name": "keys[]", "in": "query", "description": "Selected filter values keys", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Filter with key not found." }, "status": { "type": "integer", "example": 404 } }, "type": "object" } } } }, "422": { "description": "Forbidden", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Filter with key does not support values." }, "status": { "type": "integer", "example": 422 } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "contacts:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/filters/regions": { "get": { "tags": [ "Contacts" ], "summary": "Get regions for filter", "description": "REQUIRED SCOPES ['contacts:read']
This request returnes a list of default states that are used for filtering and search in the Contacts section.", "operationId": "2b00578252542153a69d33580a4954a4", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "security": [ { "apiAuth": [ "contacts:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/filters/time-zones": { "get": { "tags": [ "Contacts" ], "summary": "Get time zones for filter", "description": "REQUIRED SCOPES ['contacts:read']
This request returnes a list of world time zones that are used for filtering and search in the Contacts section.", "operationId": "90e6d845f4863eaf8e629b670e1c20f6", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "key": { "type": "string", "example": "Newfoundland" }, "label": { "type": "string", "example": "UTC -03:30 Newfoundland" } }, "type": "object" } } } } } }, "security": [ { "apiAuth": [ "contacts:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/filters/opt-in-statuses": { "get": { "tags": [ "Contacts" ], "summary": "Get Opt-In statuses for filter", "description": "REQUIRED SCOPES ['contacts:read']
Get Opt-In statuses for filter", "operationId": "2cf9e82865dc6b2081168877fe414cc9", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "key": { "type": "string", "example": "single" }, "label": { "type": "string", "example": "Single" } }, "type": "object" } } } } } }, "security": [ { "apiAuth": [ "contacts:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/filters/count": { "get": { "tags": [ "Contacts" ], "summary": "Get filtered contact count", "description": "REQUIRED SCOPES ['contacts:read']
Fetches the exact count of contacts in a filtered contact package.", "operationId": "4be574832edcdd8544a699ecd1e292b4", "parameters": [ { "name": "package_count", "in": "query", "description": "Package Count", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "count": { "type": "integer" }, "invalid_count": { "type": "integer" }, "invalid_breakdown": { "properties": { "invalid_reason": { "type": "integer" }, "blocked": { "type": "integer" }, "opted_out": { "type": "integer" }, "not_allowed": { "type": "integer" } }, "type": "object" }, "packages": { "type": "integer" }, "is_valid": { "type": "boolean" } }, "type": "object" } } } } }, "deprecated": true, "security": [ { "apiAuth": [ "contacts:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Contacts" ], "summary": "Get filtered contact count", "description": "REQUIRED SCOPES ['contacts:write']
Fetches the exact count of contacts in a filtered contact package.", "operationId": "b9d81d1ec0fcfe5e06dfc0833550f0ee", "parameters": [ { "name": "package_count", "in": "query", "description": "Package Count", "required": true, "schema": { "type": "integer" } }, { "name": "number_id", "in": "query", "description": "Number id", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "filtersList": { "type": "array", "items": { "properties": { "0": { "type": "array", "items": { "properties": { "filters": { "type": "array", "items": { "properties": { "0": { "type": "array", "items": { "properties": { "key": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "count": { "type": "integer" }, "invalid_count": { "type": "integer" }, "invalid_breakdown": { "properties": { "invalid_reason": { "type": "integer" }, "blocked": { "type": "integer" }, "opted_out": { "type": "integer" }, "not_allowed": { "type": "integer" } }, "type": "object" }, "packages": { "type": "integer" }, "is_valid": { "type": "boolean" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/filters/skipped/count": { "post": { "tags": [ "Contacts" ], "summary": "Get filtered contact count", "description": "REQUIRED SCOPES ['contacts:write']
Fetches the exact count of contacts in a filtered contact package.", "operationId": "d351f98cd91009fd0b55e645d807ec5a", "parameters": [ { "name": "package_count", "in": "query", "description": "Package Count", "required": true, "schema": { "type": "integer" } }, { "name": "number_id", "in": "query", "description": "Number id", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "filtersList": { "type": "array", "items": { "properties": { "0": { "type": "array", "items": { "properties": { "filters": { "type": "array", "items": { "properties": { "0": { "type": "array", "items": { "properties": { "key": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "count": { "type": "integer" }, "invalid_breakdown": { "properties": { "invalid_reason": { "type": "integer" }, "blocked": { "type": "integer" }, "opted_out": { "type": "integer" }, "not_allowed": { "type": "integer" } }, "type": "object" }, "packages": { "type": "integer" }, "is_valid": { "type": "boolean" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/import/upload": { "post": { "tags": [ "Contact Import" ], "summary": "Upload file with contacts", "description": "REQUIRED SCOPES ['contact-imports:write']
Upload file with contacts. See example and file format here: https://help.salesmessage.com/en/articles/3192286-import-your-contacts", "operationId": "bbb779228517b46e522a1598484f19fb", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "firstRow": { "type": "array", "items": { "type": "string" } }, "previewRows": { "type": "array", "items": { "type": "string" } }, "options": { "type": "array", "items": { "properties": { "key": { "title": "Key", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "type": "object" } }, "autoDetectedRowOptions": { "type": "array", "items": { "properties": { "email": { "title": "Email", "type": "string" }, "number": { "title": "Number", "type": "string" } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "contact-imports:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/import/list": { "post": { "tags": [ "Contact Import" ], "summary": "Update contacts imports", "description": "REQUIRED SCOPES ['contact-imports:write']
Update contacts imports", "operationId": "a5815b5a51b8fb1dcb61714c2477c6b2", "requestBody": { "content": { "application/json": { "schema": { "required": [ "list" ], "properties": { "list": { "description": "Contact list", "type": "string", "example": "" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "firstRow": { "type": "array", "items": { "type": "string" } }, "previewRows": { "type": "array", "items": { "type": "string" } }, "options": { "type": "array", "items": { "properties": { "key": { "title": "Key", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "type": "object" } }, "autoDetectedRowOptions": { "type": "array", "items": { "properties": { "email": { "title": "Email", "type": "string" }, "number": { "title": "Number", "type": "string" } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "contact-imports:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/import/{contactImport}": { "delete": { "tags": [ "Contact Import" ], "summary": "Delete contacts import", "description": "REQUIRED SCOPES ['contact-imports:write']
Delete contacts import", "operationId": "3b80ad06ec703503ec8f0d42ca7456bd", "parameters": [ { "name": "contactImport", "in": "path", "description": "The ID of the Contact Import", "required": true, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": "[]" } } } }, "security": [ { "apiAuth": [ "contact-imports:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/import/download/{contactImport}": { "get": { "tags": [ "Contact Import" ], "summary": "Download contact import list as CSV", "description": "REQUIRED SCOPES ['contact-imports:read']
Download contact import list as CSV", "operationId": "b75c71dd999157ebc788b5b426ea4fbe", "parameters": [ { "name": "contactImport", "in": "path", "description": "ID of the contact import", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "headers": { "Content-Type": { "description": "text/csv", "schema": { "type": "string" } }, "Content-Disposition": { "description": "attachment; filename", "schema": { "type": "string" } }, "Content-Length": { "description": "Size of the file in bytes", "schema": { "type": "integer" } } } }, "404": { "description": "No list found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "No list found" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "contact-imports:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/import/finish/{contactImport}": { "post": { "tags": [ "Contact Import" ], "summary": "Finish a contact import process", "description": "REQUIRED SCOPES ['contact-imports:write']
Finish a contact import process", "operationId": "ffe490751bc6c04d466d1f3683c02312", "parameters": [ { "name": "contactImport", "in": "path", "description": "ID of the contact import", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Me" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Contact import not found" } }, "security": [ { "apiAuth": [ "contact-imports:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/import": { "get": { "tags": [ "Contact Import" ], "summary": "Get list of contact imports", "description": "REQUIRED SCOPES ['contact-imports:read']
Get list of contact imports", "operationId": "a5b723962b37109a8edb9839e30b0e0d", "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactImportResource" } }, "meta": { "properties": { "current_page": { "type": "integer" }, "from": { "type": "integer" }, "last_page": { "type": "integer" }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "to": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "contact-imports:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/import/progress/{contactImport}": { "get": { "tags": [ "Contact Import" ], "summary": "Get contact contacts import progress", "description": "REQUIRED SCOPES ['contact-imports:read']
Get contact contacts import progress", "operationId": "4b073239b0dd512a2e8578b14c16aecf", "parameters": [ { "name": "contactImport", "in": "path", "description": "The ID of the Contact Import", "required": true, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "id": { "type": "integer" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "contact-imports:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/import/request/review/{contactImport}": { "post": { "tags": [ "Contact Import" ], "summary": "Request review for a contact import", "description": "REQUIRED SCOPES ['contact-imports:write']
Request review for a contact import", "operationId": "9b0ac268be19297ea048caa95fd461e8", "parameters": [ { "name": "contactImport", "in": "path", "description": "ID of the contact import", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "mapping": { "description": "Field mapping for the import", "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Contact import not found" } }, "security": [ { "apiAuth": [ "contact-imports:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/import/start/{contactImport}": { "post": { "tags": [ "Contact Import" ], "summary": "Start a contact import process", "description": "REQUIRED SCOPES ['contact-imports:write']
Start a contact import process", "operationId": "ed9b210433cf39d8085959b7fde37adb", "parameters": [ { "name": "contactImport", "in": "path", "description": "ID of the contact import", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "mapping": { "description": "Field mapping for the import", "type": "array", "items": { "type": "string" } }, "tags": { "description": "Tags to apply to imported contacts", "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "import_id": { "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "security": [ { "apiAuth": [ "contact-imports:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/import/status": { "get": { "tags": [ "Contact Import" ], "summary": "Get contacts import status", "description": "REQUIRED SCOPES ['contact-imports:read']
Get contacts import status", "operationId": "8d19fecd8b8c2a037fd252c14d1db2cc", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "allowed": { "type": "boolean" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "contact-imports:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/{contact}/link": { "post": { "tags": [ "Contacts", "Integrations" ], "summary": "Link a contact to an integration", "description": "REQUIRED SCOPES ['contacts:write', 'integrations:write']", "operationId": "01dfc1fcaac9e900311ac71fa61ed389", "parameters": [ { "name": "contact", "in": "path", "description": "ID of the contact", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "integration_id", "contact_integration_id" ], "properties": { "integration_id": { "type": "integer" }, "contact_integration_id": { "type": "string" }, "phone_type": { "type": "string" }, "update_contact": { "type": "boolean" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "number": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResource" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Contact not found" } }, "security": [ { "apiAuth": [ "contacts:write", "integrations:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/list": { "post": { "tags": [ "Contacts" ], "summary": "Get list of contacts", "description": "REQUIRED SCOPES ['contacts:write']", "operationId": "1b18f0c1c8e78e7fada42b37246fa019", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "useShortResponse": { "type": "boolean" }, "page": { "type": "integer" }, "length": { "type": "integer" }, "sortBy": { "type": "string" }, "sortOrder": { "type": "string", "enum": [ "asc", "desc" ] }, "search": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactResource" } }, "meta": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/by-ids": { "post": { "tags": [ "Contacts" ], "summary": "Get organization contacts by IDs", "description": "REQUIRED SCOPES ['contacts:write']", "operationId": "a7da5cfe9d14d450d9177622a496108d", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "ids": { "description": "Contact IDs", "type": "array", "items": { "type": "int", "example": "1" } }, "team_id": { "description": "Team ID", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "List of contact objects", "content": { "application/json": { "schema": { "properties": { "data": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/merge/duplicate/resolve": { "post": { "tags": [ "Contacts" ], "summary": "Resolve duplicate contacts", "description": "REQUIRED SCOPES ['contacts:write']", "operationId": "55a9d86207919d2de92e317cbe804e3a", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "main_contact_id", "secondary_contact_id" ], "properties": { "main_contact_id": { "description": "ID of the primary contact to keep", "type": "integer" }, "secondary_contact_id": { "description": "ID of the secondary contact to merge", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "contact": { "$ref": "#/components/schemas/ContactResource" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Contact not found" }, "422": { "description": "Validation error" } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/merge/all-count": { "get": { "tags": [ "Contacts" ], "summary": "Get count of duplicate and unlinked contacts", "description": "REQUIRED SCOPES ['contacts:read']", "operationId": "d18a9556d934ba6602bda43fc5a203b6", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "duplicate_count": { "description": "Number of duplicate contacts", "type": "integer" }, "unlinked_count": { "description": "Number of unlinked contacts", "type": "integer" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "contacts:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/merge/duplicate": { "get": { "tags": [ "Contacts" ], "summary": "Get list of duplicate contacts", "description": "REQUIRED SCOPES ['contacts:read']", "operationId": "a99ddbe7a8b35c77c5272b569da5d739", "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer" } }, { "name": "length", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer" } }, { "name": "useShortResponse", "in": "query", "description": "Use Short Response", "required": false, "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Search String", "required": false, "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Sort by field (name, label, etc)", "required": false, "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sorting order", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactResource" } }, "meta": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "contacts:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/merge/unlinked": { "get": { "tags": [ "Contacts" ], "summary": "Get list of unlinked contacts", "description": "REQUIRED SCOPES ['contacts:read']", "operationId": "4e16413488104fd1da18164ef22dc45d", "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer" } }, { "name": "length", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer" } }, { "name": "useShortResponse", "in": "query", "description": "Use Short Response", "required": false, "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Search String", "required": false, "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Sort by field (name, label, etc)", "required": false, "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sorting order", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactResource" } }, "meta": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "contacts:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/merge/duplicate/pair": { "get": { "tags": [ "Contacts" ], "summary": "Get a pair of duplicate contacts", "description": "REQUIRED SCOPES ['contacts:read']", "operationId": "9546351a2f258070ed3828b2c725df23", "parameters": [ { "name": "number", "in": "query", "description": "Phone number to check for duplicates", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Offset for pagination", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactResource" } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "422": { "description": "Validation error" } }, "security": [ { "apiAuth": [ "contacts:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/note/{contact}/create": { "post": { "tags": [ "Contacts" ], "summary": "Create contact note", "description": "REQUIRED SCOPES ['contacts:write']
This request enables you to create a string containing a note for a contact indicated by the contact id. The note will be attached to the corresponding section.", "operationId": "cdcbcb4b55f9ad0124e3b9dc99ae91eb", "parameters": [ { "name": "contact", "in": "path", "description": "The ID of the Contact", "required": true, "schema": { "type": "integer", "example": "" } }, { "name": "text", "in": "query", "description": "Package Count", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppContactNoteResource" } } } } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/note/{note}": { "delete": { "tags": [ "Contacts" ], "summary": "Remove note", "description": "REQUIRED SCOPES ['contacts:write']
This request enables you to permanently remove an existing note indicated by the id of the note. ", "operationId": "957c8d7593f42b2a007d4568979561b5", "parameters": [ { "name": "note", "in": "path", "description": "The ID of the Note", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Note successfully deleted" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] }, "patch": { "tags": [ "Contacts" ], "summary": "Update note", "description": "REQUIRED SCOPES ['contacts:write']
This request enables you to change the value of an existing note’s property with any text provided. The update is applied to the note with a given note id.", "operationId": "24369d58f78a5f05e06ca0f16197aae8", "parameters": [ { "name": "note", "in": "path", "description": "The ID of the Note", "required": true, "schema": { "type": "string", "example": "" } }, { "name": "text", "in": "query", "description": "Package Count", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppContactNoteResource" } } } } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/opt-in/request/{conversation}": { "post": { "tags": [ "Contacts" ], "summary": "Send opt-in request to conversation`s contact", "description": "REQUIRED SCOPES ['contacts:write']
This endpoint enables an opt-in request feature within your application in the settings.

As soon as the feature becomes enabled by the user, this will require every contact to confirm their phone number in order to start a conversation with the user. This endpoint will make it possibe to make a similar request from the conversation window through the `Send confirmation` button.", "operationId": "Send opt-in request to conversation`s contact", "parameters": [ { "name": "conversation", "in": "path", "description": "Conversation id", "required": true, "schema": { "type": "integer", "example": "1" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "contact": { "$ref": "#/components/schemas/ContactResource" }, "message": { "$ref": "#/components/schemas/MessageResource" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/opt-out": { "put": { "tags": [ "Contacts" ], "summary": "Make contact opt-out", "description": "REQUIRED SCOPES ['contacts:write']
Make contact opt-out", "operationId": "156bc0e0b58b929c349cb1e8ffe53669", "requestBody": { "content": { "application/json": { "schema": { "properties": { "contacts": { "description": "The IDs of the Contacts", "type": "array", "items": { "type": "integer", "example": 1 } }, "opt_outs": { "properties": { "toll_free": { "type": "boolean", "example": false } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResource" } } } } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/bulk-check": { "post": { "tags": [ "Contacts" ], "summary": "Bulk check contact phone numbers", "description": "REQUIRED SCOPES ['contacts:write']", "operationId": "00b88004b4915aed7aa4994890427c6a", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "contact_ids": { "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "success" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "422": { "description": "Validation error" } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/lookup/statistics": { "post": { "tags": [ "Contacts" ], "summary": "Get phone check statistics", "description": "REQUIRED SCOPES ['contacts:write']", "operationId": "a23d7a4f3ae625afe79916aff760bf11", "parameters": [ { "name": "bulk_all", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "contact_ids", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "all_count": { "type": "integer" }, "unchecked_count": { "type": "integer" }, "landline_count": { "type": "integer" }, "checked_count": { "type": "integer" }, "voip_count": { "type": "integer" }, "mobile_count": { "type": "integer" }, "undefined_count": { "type": "integer" }, "invalid_count": { "type": "integer" }, "valid_count": { "type": "integer" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/search": { "get": { "tags": [ "Contacts" ], "summary": "Search contact", "description": "REQUIRED SCOPES ['contacts:read']
Use this request to retrieve the contacts matching a term to search for provided in the query parameters.

In addition, you are allowed to specify the maximum number of messages that you want returned from this call.", "operationId": "4bd9b7c17c28edcb57407d1102858a17", "parameters": [ { "name": "limit", "in": "query", "description": "The maximum number of messages that you want returned from this call.", "schema": { "type": "integer", "default": 50 } }, { "name": "term", "in": "query", "description": "The string to search for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/ContactResource" } }, "total": { "type": "integer" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "contacts:read" ] } ], "x-versions": [ "public" ] } }, "/contacts/{contact}/tags": { "post": { "tags": [ "Contacts" ], "summary": "Add tags to contact", "description": "REQUIRED SCOPES ['contacts:write']
This API request attaches a tag or multiple tags provided by tag ids to contacts with given ids.", "operationId": "Add tags to contact", "parameters": [ { "name": "contact", "in": "path", "description": "Contact id", "required": true, "schema": { "type": "integer", "example": "1" } } ], "requestBody": { "description": "Pass tags", "required": true, "content": { "application/json": { "schema": { "properties": { "tags": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "text", "example": "1" } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResource" } } } } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/tag-count": { "post": { "tags": [ "Contacts" ], "summary": "Get contact counts by tags", "description": "REQUIRED SCOPES ['contacts:write']", "operationId": "22f1fe7178699f843e6915a2d989cb26", "parameters": [ { "name": "tags", "in": "query", "description": "Comma-separated list of tag IDs", "required": true, "schema": { "type": "string" } }, { "name": "exclude_opt_outs", "in": "query", "description": "Exclude opt-out contacts", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": [ { "type": "integer" } ] } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/{contact}/fields": { "patch": { "tags": [ "Contacts" ], "summary": "Update contact fields", "description": "REQUIRED SCOPES ['contacts:write']", "operationId": "47de4a56754979c49168d2012a476457", "parameters": [ { "name": "contact", "in": "path", "description": "ID of the contact", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "number": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "owner_id": { "type": "integer" }, "custom_fields": { "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResource" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Contact not found" }, "422": { "description": "Validation error" } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/validate-number": { "post": { "tags": [ "Contacts" ], "summary": "Validate contact phone number", "description": "REQUIRED SCOPES ['contacts:write']", "operationId": "038464cd67b39e49161d939a6b454e56", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "number" ], "properties": { "number": { "type": "string", "example": "+14155552671" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "boolean" }, "example": true } } }, "422": { "description": "Validation error" } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/contacts/validation": { "post": { "tags": [ "Contacts" ], "summary": "Validate contact data", "description": "REQUIRED SCOPES ['contacts:write']", "operationId": "77b8a2ccf0047bf78a9173cd3f702a36", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "email": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful validation", "content": { "application/json": { "schema": { "type": "string" }, "example": "OK" } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "contacts:write" ] } ], "x-versions": [ "public" ] } }, "/conversations/{conversation}/close": { "put": { "tags": [ "Conversations" ], "summary": "Close conversation", "description": "REQUIRED SCOPES ['conversations:write']
This endpoint closes the conversation for all the participants of the current Team. The conversation with all the messages will still be visible within the Closed Conversations tab.

The `closed_at` field becomes set with current time.

Together, this endpoint allows for reopening the conversation.Thus, it returns the closed conversation including the contact, owner, and recent message.", "operationId": "Close conversation", "parameters": [ { "name": "conversation", "in": "path", "description": "Conversation id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationResource" } } } } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/conversations/batch/close": { "delete": { "tags": [ "Conversations" ], "summary": "Close all failed conversations", "description": "REQUIRED SCOPES ['conversations:write']
Close all failed conversations", "operationId": "4c3e10e8406f5f5f82e563d21c27081f", "parameters": [ { "name": "team_id", "in": "query", "description": "The ID of the Team", "schema": { "type": "integer" } }, { "name": "team_type", "in": "query", "description": "The type of the Team", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationResource" } } } } } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/conversations/batch-queue/close": { "put": { "tags": [ "Conversations" ], "summary": "Close conversations for the given team/inbox", "description": "REQUIRED SCOPES ['conversations:write']
Close conversations for the given team/inbox", "operationId": "1c6316bbddd9d6ca1780f92e3530f539", "requestBody": { "content": { "application/json": { "schema": { "required": [ "team_id" ], "properties": { "team_id": { "description": "The ID of the Team", "type": "integer", "example": 1 }, "conversation_filter": { "description": "Type of conversation filter", "type": "string", "example": "open" }, "ids": { "description": "The IDs of Conversations", "type": "array", "items": { "type": "integer", "example": 1 } }, "delete_all": { "description": "Delete all flag", "type": "boolean", "example": false } }, "type": "object" } } } }, "responses": { "204": { "description": "Response" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/conversations/downgrade-statistic": { "get": { "tags": [ "Conversations" ], "summary": "Get statistics for downgrade plan", "description": "REQUIRED SCOPES ['conversations:read']", "operationId": "Get statistics for downgrade plan", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "conversation_closed_count": { "description": "Number of closed conversations", "type": "integer" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "conversations:read" ] } ], "x-versions": [ "public" ] } }, "/conversations/{conversation}/export": { "get": { "tags": [ "Conversations" ], "summary": "Export conversation messages", "description": "REQUIRED SCOPES ['conversations:read']", "operationId": "Export conversation messages", "parameters": [ { "name": "conversation", "in": "path", "description": "ID of the conversation to export", "required": true, "schema": { "type": "integer" } }, { "name": "format", "in": "query", "description": "Export format", "required": true, "schema": { "type": "string", "enum": [ "csv", "pdf" ], "example": "csv" } }, { "name": "include_notes", "in": "query", "description": "Whether to include notes in the export", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "url": { "description": "URL to download the exported file", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Conversation not found" }, "422": { "description": "Validation error" } }, "security": [ { "apiAuth": [ "conversations:read" ] } ], "x-versions": [ "public" ] } }, "/conversations/favorite": { "post": { "tags": [ "Conversations" ], "summary": "Mark a conversation as favorite or unfavorite", "description": "REQUIRED SCOPES ['conversations:write']", "operationId": "Mark a conversation as favorite or unfavorite", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "conversation_id", "favorite" ], "properties": { "conversation_id": { "description": "ID of the conversation", "type": "integer" }, "favorite": { "description": "True to mark as favorite, false to unmark", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "type": { "type": "string", "example": "status" }, "message": { "type": "string", "example": "Successfully updated." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Conversation not found" } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/conversations/batch-queue/favorite": { "put": { "tags": [ "Conversations" ], "summary": "make favorite conversations for the given team/inbox", "description": "REQUIRED SCOPES ['conversations:write']
make favorite conversations for the given team/inbox", "operationId": "6a2a5c5e19e7d183fbaee6c5615609ca", "requestBody": { "content": { "application/json": { "schema": { "required": [ "team_id" ], "properties": { "team_id": { "description": "The ID of the Team", "type": "integer", "example": 1 }, "ids": { "description": "The IDs of Conversations", "type": "array", "items": { "type": "integer", "example": 1 } }, "all": { "type": "boolean", "example": false }, "favorite": { "type": "boolean", "example": false }, "conversation_filter": { "type": "string", "example": "open" } }, "type": "object" } } } }, "responses": { "200": { "description": "Response" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/conversations/find-by-contacts": { "get": { "tags": [ "Conversations" ], "summary": "Find a conversation by contacts", "description": "REQUIRED SCOPES ['conversations:read']", "operationId": "Find a conversation by contacts", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "contacts" ], "properties": { "contacts": { "type": "array", "items": { "type": "integer" } }, "team_id": { "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationResource" } } } }, "204": { "description": "No conversation found" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "422": { "description": "Validation error" } }, "security": [ { "apiAuth": [ "conversations:read" ] } ], "x-versions": [ "public" ] } }, "/conversations/teams/number": { "post": { "tags": [ "Conversations" ], "summary": "Get By Contact Conversation Related Number", "description": "REQUIRED SCOPES ['conversations:write']
Get By Contact Conversation Related Number", "operationId": "82c2b8abe2c52e2731742a85970ad96c", "requestBody": { "content": { "application/json": { "schema": { "properties": { "team_id": { "type": "integer" }, "team_type": { "type": "integer" }, "contacts": { "type": "array", "items": {} } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberResource" } } } } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/conversations": { "get": { "tags": [ "Conversations" ], "summary": "Get user`s conversations", "description": "REQUIRED SCOPES ['conversations:read']
Retrieves the list of all the conversations of a specific contact id.

List can be limited. Returned conversations can be initially ordered:
  • By filter
  • By time of the last event
  • By query
  • Excluding conversation by id

Every conversation in the list returns with a specific contact id, owner, and recent message.

", "operationId": "Get user`s conversations", "parameters": [ { "name": "filter", "in": "query", "description": "Filter (assigned,unassigned only if current user is on team)", "required": true, "schema": { "type": "string", "enum": [ "open", "closed", "unread", "assigned", "unassigned", "outbound", "optout", "nocalls" ], "example": "open" } }, { "name": "limit", "in": "query", "description": "Limit", "required": true, "schema": { "type": "integer", "example": "10" } }, { "name": "offset", "in": "query", "description": "Offset", "required": false, "schema": { "type": "integer", "example": "" } }, { "name": "before", "in": "query", "description": "Last message before", "required": false, "schema": { "type": "string", "format": "date", "example": "" } }, { "name": "after", "in": "query", "description": "Last message after", "required": false, "schema": { "type": "string", "format": "date", "example": "" } }, { "name": "exclude", "in": "query", "description": "Exclude conversation by id", "required": false, "schema": { "type": "integer", "example": "" } }, { "name": "query", "in": "query", "description": "Contact first_name, last_name, email, number", "required": false, "schema": { "type": "string", "minLength": 1, "example": "" } }, { "name": "grouped_response", "in": "query", "description": "Is return grouped response", "required": false, "schema": { "type": "boolean", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationResource" } } } } } }, "security": [ { "apiAuth": [ "conversations:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Conversations" ], "summary": "Start a new conversation", "description": "REQUIRED SCOPES ['conversations:write']
Starts a conversation with a specific contact. When the first message is sent to or received from a contact, a new conversation is created automatically.

In case a contact id is given, the endpoint returns a new conversation with them. In case team id is provided, the endpoint returns a new conversation in a shared inbox.", "operationId": "Start a new conversation", "parameters": [ { "name": "contact_id", "in": "query", "description": "Contact ID", "required": true, "schema": { "type": "integer", "example": "1" } }, { "name": "team_id", "in": "query", "description": "Team ID", "required": false, "schema": { "type": "integer", "example": "0" } }, { "name": "number_id", "in": "query", "description": "Number ID", "required": false, "schema": { "type": "integer", "example": "0" } }, { "name": "smart_option", "in": "query", "description": "'scaler' or 'local_presence'", "required": false, "schema": { "type": "string", "example": "" } } ], "responses": { "422": { "description": "Unprocessable entity" }, "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "id": { "type": "integer" }, "inbox_id": { "type": "integer" }, "contact_id": { "type": "integer" }, "user_id": { "type": "integer" }, "last_message_at": { "type": "string" }, "last_read_at": { "type": "string" }, "started_at": { "type": "string" }, "closed_at": { "type": "string" }, "contact": { "properties": { "id": { "type": "integer" }, "owner_id": { "type": "integer" }, "color": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "full_name": { "type": "string" }, "email": { "type": "string" }, "photo_url": { "type": "string" }, "number": { "type": "string" }, "country": { "type": "string" }, "country_calling_code": { "type": "string" }, "national_number": { "type": "string" }, "formatted_number": { "type": "string" }, "opt_out": { "type": "string" }, "opt_out_at": { "type": "string" }, "opt_in_request_at": { "type": "string" }, "opt_in_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "integration_vendor_id": { "type": "string" }, "prevent_autolink": { "type": "boolean" }, "integration": { "properties": { "id": { "type": "integer" }, "key": { "type": "string" }, "name": { "type": "string" }, "photo_url": { "type": "string" } }, "type": "object" }, "tags": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/ContactTagResource" } } } }, "type": "object" }, "owner": { "properties": { "id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "full_name": { "type": "string" }, "photo_url": { "type": "string" }, "email": { "type": "string" } }, "type": "object" }, "recent_message": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "body": { "type": "string" }, "user_id": { "type": "integer" }, "type": { "type": "string" }, "sent_at": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/conversations/filters/list": { "get": { "tags": [ "Conversations" ], "summary": "Get list of available conversation filters", "description": "REQUIRED SCOPES ['conversations:read']", "operationId": "Get list of available conversation filters", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object" } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "conversations:read" ] } ], "x-versions": [ "public" ] } }, "/conversations/orders/list": { "get": { "tags": [ "Conversations" ], "summary": "Get list of available conversation order types", "description": "REQUIRED SCOPES ['conversations:read']", "operationId": "Get list of available conversation order types", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "key": { "type": "string" }, "label": { "type": "string" } }, "type": "object" } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "conversations:read" ] } ], "x-versions": [ "public" ] } }, "/conversations/{conversation}/need_response": { "put": { "tags": [ "Conversations" ], "summary": "Mark/unmark conversation as Needs Response", "description": "REQUIRED SCOPES ['conversations:write']
This endpoint changes the status of Needs Response in a given conversation.", "operationId": "Mark/unmark conversation as Needs Response", "parameters": [ { "name": "conversation", "in": "path", "description": "ID of conversation", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "need_response": { "description": "Needs Response flag", "type": "boolean", "example": false } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationResource" } } } } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/conversations/batch-queue/need_response": { "put": { "tags": [ "Conversations" ], "summary": "Bulk mark/unmark conversations as Needs Response", "description": "REQUIRED SCOPES ['conversations:write']
Bulk mark/unmark conversations as Needs Response", "operationId": "af112ae66d677ec3cfae87685bb4a389", "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "description": "The IDs of Conversations", "type": "array", "items": { "type": "integer", "example": 1 } }, "need_response": { "description": "Needs Response flag", "type": "boolean", "example": false } }, "type": "object" } } } }, "responses": { "200": { "description": "OK" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/conversations/{conversation}/open": { "put": { "tags": [ "Conversations" ], "summary": "Open conversation", "description": "REQUIRED SCOPES ['conversations:write']", "operationId": "Open conversation", "parameters": [ { "name": "conversation", "in": "path", "description": "Conversation id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationResource" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "message": { "title": "Error Message", "type": "string" }, "conversation_id": { "title": "Conversation ID", "type": "integer" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/conversations/batch-queue/open": { "put": { "tags": [ "Conversations" ], "summary": "make open conversations for the given team/inbox", "description": "REQUIRED SCOPES ['conversations:write']
make open conversations for the given team/inbox", "operationId": "a8d935c1165ba9b4e01f181dd4dcdcee", "requestBody": { "content": { "application/json": { "schema": { "required": [ "team_id" ], "properties": { "team_id": { "description": "The ID of the Team", "type": "integer", "example": 1 }, "ids": { "description": "The IDs of Conversations", "type": "array", "items": { "type": "integer", "example": 1 } }, "conversation_filter": { "description": "Type of conversation filter", "type": "string", "example": "open" }, "open_all": { "type": "boolean", "example": false } }, "type": "object" } } } }, "responses": { "200": { "description": "Response" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/conversations/{conversation}/read": { "put": { "tags": [ "Conversations" ], "summary": "Mark conversation as read", "description": "REQUIRED SCOPES [‘conversations:write’]
This endpoint changes the status of incoming messages in a given conversation to read by the current user.

If you’ve read a message, the endpoint sets the `last_read_at` field with current time and the message becomes grouped with all the other read messages.", "operationId": "Mark conversation as read", "parameters": [ { "name": "conversation", "in": "path", "description": "ID of conversation", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationResource" } } } } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/conversations/batch-queue/read": { "put": { "tags": [ "Conversations" ], "summary": "read conversations for the given team/inbox", "description": "REQUIRED SCOPES ['conversations:write']
read conversations for the given team/inbox", "operationId": "a96e9248ea2fb19d3581fda14516ae34", "requestBody": { "content": { "application/json": { "schema": { "required": [ "team_id" ], "properties": { "team_id": { "description": "The ID of the Team", "type": "integer", "example": 1 }, "ids": { "description": "The IDs of Conversations", "type": "array", "items": { "type": "integer", "example": 1 } }, "read_all": { "description": "Read all flag", "type": "boolean", "example": false }, "conversation_filter": { "type": "string", "example": "open" } }, "type": "object" } } } }, "responses": { "200": { "description": "Response" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/conversations/{conversation}/reassign": { "post": { "tags": [ "Conversations" ], "summary": "Assign conversation to user", "description": "REQUIRED SCOPES ['conversations:write']
Allows you to assign a conversation to a specific user who is the right person to provide a response.

Blank `User ID` field sets a conversation to `Unassigned`.", "operationId": "Assign conversation to user", "parameters": [ { "name": "conversation", "in": "path", "description": "Conversation id", "required": true, "schema": { "type": "integer", "example": "1" } }, { "name": "user_id", "in": "query", "description": "User ID", "required": false, "schema": { "type": "integer", "minimum": 1, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationResource" } } } } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/conversations/batch-queue/reassign": { "put": { "tags": [ "Conversations" ], "summary": "Bulk Assign conversation to users", "description": "REQUIRED SCOPES ['conversations:write']", "operationId": "Bulk Assign conversation to users", "requestBody": { "content": { "application/json": { "schema": { "required": [ "team_id" ], "properties": { "team_id": { "description": "The ID of the Team", "type": "integer", "example": 1 }, "conversations_ids": { "description": "The IDs of Conversations", "type": "array", "items": { "type": "integer", "example": 1 } }, "members_ids": { "description": "The IDs of Members", "type": "array", "items": { "type": "integer", "example": 1 } }, "reassign_all": { "description": "Reassign all flag", "type": "boolean", "example": false }, "conversation_filter": { "type": "string", "example": "open" } }, "type": "object" } } } }, "responses": { "200": { "description": "Ok" } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/conversations/search": { "get": { "tags": [ "Conversations" ], "summary": "Search active conversations", "description": "REQUIRED SCOPES ['conversations:read']
Returns active conversations filtered by contacts and teams, with pagination.", "operationId": "Search active conversations", "parameters": [ { "name": "contacts", "in": "query", "description": "Contact IDs", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "teams", "in": "query", "description": "Team IDs", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "per_page", "in": "query", "description": "Results per page", "required": false, "schema": { "type": "integer", "example": "50" } }, { "name": "page", "in": "query", "description": "Page", "required": false, "schema": { "type": "string", "example": "1" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "results": { "title": "Search Results", "type": "array", "items": { "$ref": "#/components/schemas/ConversationResource" }, "nullable": true }, "total": { "description": "Total count of matching conversations (before pagination)", "type": "integer", "nullable": true }, "errors": { "description": "Error messages; null on success", "type": "array", "items": { "type": "string" }, "nullable": true } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "conversations:read" ] } ], "x-versions": [ "public" ] } }, "/conversations/{conversation}": { "get": { "tags": [ "Conversations" ], "summary": "Get conversation by id", "description": "REQUIRED SCOPES ['conversations:read']
Returns detailed information about a particular existing conversation by a given conversation id. Information box includes:
  • Information about contact
  • Information about owner (conversation creator)
  • The user the conversation is assigned to
  • Latest message details, including content
  • Conversation status
  • Last seen date
  • Conversation creation date
  • Latest message date
  • Team name
", "operationId": "Get conversation by id", "parameters": [ { "name": "conversation", "in": "path", "description": "ID of conversation", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationResource" } } } } }, "security": [ { "apiAuth": [ "conversations:read" ] } ], "x-versions": [ "public" ] }, "put": { "tags": [ "Conversations" ], "summary": "Update conversation", "description": "REQUIRED SCOPES ['conversations:write']
Update conversation", "operationId": "5e808988b09bed1352985c6091ff497a", "parameters": [ { "name": "conversation", "in": "path", "description": "The ID of the Conversation", "required": true, "schema": { "type": "string", "example": "" } }, { "name": "name", "in": "query", "description": "Conversation name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationResource" } } } } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/conversations/{conversation}/switch": { "post": { "tags": [ "Conversations" ], "summary": "Switch conversation", "description": "REQUIRED SCOPES ['conversations:write']
Switch conversation", "operationId": "ea4319b6e9ac1d183980809946f971c1", "parameters": [ { "name": "conversation", "in": "path", "description": "The ID of the Conversation", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "id": { "type": "integer" }, "filter": { "type": "string" }, "unread": { "type": "integer" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/conversations/{conversation}/unread": { "put": { "tags": [ "Conversations" ], "summary": "Mark conversation as unread", "description": "REQUIRED SCOPES ['conversations:write']
If you read a message, but want to take some time before addressing it, the message can be marked as unread.

This endpoint changes the status of messages in a given conversation to unread by the current user. Marking a message as unread displays the bold dot mark on the conversation in the conversation sidebar.

The message becomes grouped with all the other unread messages as the last_read_at field is set as empty.", "operationId": "Mark conversation as unread", "parameters": [ { "name": "conversation", "in": "path", "description": "Conversation id", "required": true, "schema": { "type": "integer", "example": "1" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationResource" } } } } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/conversations/batch-queue/unread": { "put": { "tags": [ "Conversations" ], "summary": "make unread conversations for the given team/inbox", "description": "REQUIRED SCOPES ['conversations:write']
make unread conversations for the given team/inbox", "operationId": "0894070eeeb9f50302f08dfd97dbcb63", "requestBody": { "content": { "application/json": { "schema": { "required": [ "team_id" ], "properties": { "team_id": { "description": "The ID of the Team", "type": "integer", "example": 1 }, "ids": { "description": "The IDs of Conversations", "type": "array", "items": { "type": "integer", "example": 1 } }, "unread_all": { "type": "boolean", "example": false }, "conversation_filter": { "type": "string", "example": "open" } }, "type": "object" } } } }, "responses": { "200": { "description": "Response" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/conversions": { "get": { "tags": [ "Conversions" ], "summary": "Get list conversions", "description": "REQUIRED SCOPES ['conversions:read']
Get list conversions", "operationId": "9af85187968f95c98770013c3dd7eca9", "parameters": [ { "name": "sortOrder", "in": "query", "description": "Sorting order", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "sortBy", "in": "query", "description": "Sort by field...", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page", "required": false, "schema": { "type": "integer" } }, { "name": "length", "in": "query", "description": "Results per page", "required": false, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "description": "Filter by...", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConversionResource" } } } } } }, "security": [ { "apiAuth": [ "conversions:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Conversions" ], "summary": "Create conversion", "description": "REQUIRED SCOPES ['conversions:write']
Create conversion", "operationId": "8b0de00c95f5b441c83b3d2bfeb34bcd", "parameters": [ { "name": "name", "in": "query", "description": "Conversion name", "required": true, "schema": { "type": "string" } }, { "name": "conversion_url", "in": "query", "description": "Conversion url", "required": true, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "Currency", "required": true, "schema": { "type": "string" } }, { "name": "conversion_attribution", "in": "query", "description": "Conversion attribution", "required": true, "schema": { "type": "integer" } }, { "name": "default_value", "in": "query", "description": "Conversion default value", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversionResource" } } } } }, "security": [ { "apiAuth": [ "conversions:write" ] } ], "x-versions": [ "public" ] } }, "/custom-fields/field": { "post": { "tags": [ "Custom Fields" ], "summary": "Create custom field", "description": "REQUIRED SCOPES ['custom-fields:write']
In addition to the 4 fields available by default (First name, Last name, Phone Number, Email address), this API endpoint allows for creating and adding a new custom field to the ones that already exist.

As a result, each user in the system can now narrow down the search among their contacts and individualize messages.

To create a new custom field for your contacts, you have two things to select: Field Name which is a recognizable title for your custom property (i.e `Birthday`) and Field Type.

The values that are allowed for Field Types include:
  • Text
  • URL
  • Date
  • Number

As a result, inside the conversation window, on the user contact card, there’s new data available for view. You can choose whethe to show custom information on the user contact card or not.

", "operationId": "Create custom field", "parameters": [ { "name": "name", "in": "query", "description": "Field name", "required": true, "schema": { "type": "string", "example": "First Name" } }, { "name": "type", "in": "query", "description": "Type", "required": true, "schema": { "type": "string", "enum": [ "text", "url", "date", "number", "datetime" ], "example": "text" } }, { "name": "visible", "in": "query", "description": "Show in сonversations", "required": true, "schema": { "type": "boolean", "example": "true" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "title": "Text Status", "type": "string" }, "data": { "$ref": "#/components/schemas/CustomFieldResource" } }, "type": "object" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "properties": { "status": { "title": "Text Status", "type": "string" }, "code": { "title": "Error Code", "type": "string" }, "message": { "title": "Error Message", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "custom-fields:write" ] } ], "x-versions": [ "public" ] } }, "/custom-fields/types": { "get": { "tags": [ "Custom Fields" ], "summary": "Get available custom field types", "description": "REQUIRED SCOPES ['custom-fields:read']
Get available custom field types", "operationId": "e1644b291625d9eb7391b4f644225963", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "types": { "description": "List of available custom field types", "type": "array", "items": { "type": "string" } } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "custom-fields:read" ] } ], "x-versions": [ "public" ] } }, "/custom-fields/field/{customField}": { "put": { "tags": [ "Custom Fields" ], "summary": "Update custom field", "description": "REQUIRED SCOPES ['custom-fields:write']
This API request allows for modifying data for a specific custom field by id specified in path.

Properties that you can update are the name of a specific custom field and value type of a specific custom field (text, URL, date, number).

Additionally, you can update the feature that shows or does not show specific custom fields in сonversations.", "operationId": "Update custom field", "parameters": [ { "name": "customField", "in": "path", "description": "Custom field id", "required": true, "schema": { "type": "integer", "example": "1" } }, { "name": "name", "in": "query", "description": "Field name", "required": true, "schema": { "type": "string", "example": "First Name" } }, { "name": "type", "in": "query", "description": "Type", "required": true, "schema": { "type": "string", "enum": [ "text", "url", "date", "number" ], "example": "text" } }, { "name": "visible", "in": "query", "description": "Show in сonversations", "required": true, "schema": { "type": "boolean", "example": "true" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "title": "Status Text", "type": "string" }, "data": { "$ref": "#/components/schemas/CustomFieldResource" } }, "type": "object" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "properties": { "status": { "title": "Text Status", "type": "string" }, "code": { "title": "Error Code", "type": "string" }, "message": { "title": "Error Message", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "custom-fields:write" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Custom Fields" ], "summary": "Delete custom field", "description": "REQUIRED SCOPES ['custom-fields:write']
Through this API endpoint, any custom field subresource can easily be removed from all the contacts to which it was applied.

The request deletes a custom field by id with the corresponding values. Deleting a custom field will also delete all of the values across all contact cards that have been set for that custom field.", "operationId": "Delete custom field", "parameters": [ { "name": "customField", "in": "path", "description": "Custom field id", "required": true, "schema": { "type": "integer", "example": "1" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "title": "Status Text", "type": "string" }, "data": { "$ref": "#/components/schemas/CustomFieldResource" } }, "type": "object" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "properties": { "status": { "title": "Text Status", "type": "string" }, "code": { "title": "Error Code", "type": "string" }, "message": { "title": "Error Message", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "custom-fields:write" ] } ], "x-versions": [ "public" ] } }, "/custom-fields/fields": { "get": { "tags": [ "Custom Fields" ], "summary": "Get custom fields", "description": "REQUIRED SCOPES ['custom-fields:read']
This API request returns the entire collection of custom fields that are available for use in a user`s account.

The response will contain the names and values of all the custom fields. Choose the number of results per page that you wish to view.

I addition, the endpoint allows for setting a search filter by field name.", "operationId": "Get custom fields", "parameters": [ { "name": "search", "in": "query", "description": "Filter by name", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "length", "in": "query", "description": "Results per page", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "page", "in": "query", "description": "Page", "required": false, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "title": "List", "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldResource" } } }, "type": "object" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "properties": { "code": { "title": "code", "type": "integer" }, "message": { "title": "message", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "custom-fields:read" ] } ], "x-versions": [ "public" ] } }, "/custom-fields/{customField}": { "get": { "tags": [ "Custom Fields" ], "summary": "Get custom field", "description": "REQUIRED SCOPES ['custom-fields:read']
This API request retrieves information for a single specific custom field. Getting one specific custom field will require you to input unique id of the custom field.

As a result, you view the name of the field and all its unique properties.", "operationId": "Get custom field", "parameters": [ { "name": "customField", "in": "path", "description": "Custom field id", "required": true, "schema": { "type": "integer", "example": "1" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldResource" } } } } }, "security": [ { "apiAuth": [ "custom-fields:read" ] } ], "x-versions": [ "public" ] } }, "/followup": { "post": { "tags": [ "Follow Up" ], "summary": "Update foolow up text", "description": "REQUIRED SCOPES ['follow-ups:write']
Update foolow up text", "operationId": "322ae8880bb0eca0e8ff01995bbb8c7d", "requestBody": { "content": { "application/json": { "schema": { "properties": { "team_id": { "description": "Team ID", "type": "integer" }, "message": { "description": "Message", "type": "string" }, "is_active": { "description": "Activate", "type": "boolean" }, "media_url": { "description": "Media", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Not Found" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "follow-ups:write" ] } ], "x-versions": [ "public" ] } }, "/groups": { "get": { "tags": [ "Groups" ], "summary": "List groups", "description": "REQUIRED SCOPES ['groups:read']
Retrieve a list of groups based on query parameters", "operationId": "d14527812e023f0a968c85f1edac62c1", "parameters": [ { "name": "search", "in": "query", "description": "Search term to filter groups by name or description", "required": false, "schema": { "type": "string" } }, { "name": "length", "in": "query", "description": "Number of groups to return per page", "required": false, "schema": { "type": "integer", "default": 20 } }, { "name": "page", "in": "query", "description": "Page number to retrieve", "required": false, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupResource" } } } } } }, "x-versions": [ "public" ] }, "post": { "tags": [ "Groups" ], "summary": "Create a new group", "description": "REQUIRED SCOPES ['groups:write']
Creates a new group with specified details and member associations.", "operationId": "createGroup", "requestBody": { "description": "Data needed to create a new group", "required": true, "content": { "application/json": { "schema": { "required": [ "name", "members" ], "properties": { "name": { "type": "string", "example": "New Group" }, "description": { "type": "string", "example": "A description of the new group", "nullable": true }, "members": { "type": "array", "items": { "type": "integer" }, "example": [ 1, 2, 3 ] } }, "type": "object" } } } }, "responses": { "200": { "description": "Group created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupResource" } } } } }, "x-versions": [ "public" ] } }, "/groups/create-integration-group": { "post": { "tags": [ "Groups" ], "summary": "Create a new integration group", "description": "REQUIRED SCOPES ['groups:write']
Creates a new integration group and attaches all users of the organization to it.", "operationId": "db4fec66e8ddbac6b9396f1e48737bea", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "integration_team_id" ], "properties": { "integration_team_id": { "description": "The ID of the integration team", "type": "integer", "example": 1 } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupResource" } } } } }, "security": [ { "bearerAuth": [] } ], "x-versions": [ "public" ] } }, "/groups/client-mapping/{organization}": { "delete": { "tags": [ "Groups" ], "summary": "Remove client team mapping", "description": "REQUIRED SCOPES ['groups:write']
Remove client team mapping", "operationId": "4676fac28c166881b49d55154b01ce7e", "parameters": [ { "name": "organization", "in": "path", "description": "The ID of the Organization", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Response" } }, "security": [ { "apiAuth": [ "groups:write" ] } ], "x-versions": [ "public" ] } }, "/groups/{group_id}": { "delete": { "tags": [ "Groups" ], "summary": "Delete a group", "description": "REQUIRED SCOPES ['groups:write']
Delete a specific group", "operationId": "cf89a1b9cfec6ae5bbfcbd0c982f9209", "parameters": [ { "name": "group_id", "in": "path", "description": "ID of the group to delete", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "Group deleted successfully" } }, "x-versions": [ "public" ] } }, "/groups/import-integration-teams": { "get": { "tags": [ "Groups" ], "summary": "Import integration teams", "description": "REQUIRED SCOPES ['groups:read']
Imports integration teams from HubSpot", "operationId": "importIntegrationTeams", "responses": { "200": { "description": "Success response", "content": { "application/json": { "schema": { "properties": { "success": { "type": "string", "example": "Integration teams imported successfully" } }, "type": "object" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "message": { "type": "string", "example": "Can't import integration teams" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "groups:read" ] } ], "x-versions": [ "public" ] } }, "/groups/integration-teams": { "get": { "tags": [ "Groups" ], "summary": "Get groups integrations teams", "description": "REQUIRED SCOPES ['groups:read']
Get groups integrations teams", "operationId": "3d40d029c65497d8df190e0eb97d2a3b", "parameters": [ { "name": "organization", "in": "query", "description": "The ID of the Organization", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" } } } } } }, "security": [ { "apiAuth": [ "groups:read" ] } ], "x-versions": [ "public" ] } }, "/groups/map-client/{organization}": { "put": { "tags": [ "Groups" ], "summary": "Map client to teams", "description": "REQUIRED SCOPES ['groups:write']
Map client to teams", "operationId": "9fc76f5f1c0a7ce8201df630a3b11f27", "parameters": [ { "name": "organization", "in": "path", "description": "The ID of the Organization", "required": true, "schema": { "type": "integer" } }, { "name": "integration_team_ids[]", "in": "query", "description": "The IDs of the Teams", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "info": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "groups:write" ] } ], "x-versions": [ "public" ] } }, "/groups/refresh-integration-team-contacts/{group}": { "get": { "tags": [ "Groups" ], "summary": "Refresh integration team contacts", "description": "REQUIRED SCOPES ['groups:read']
Refresh integration team contacts", "operationId": "b98addce7791939bdc2670a0aa8ff6b7", "parameters": [ { "name": "group", "in": "path", "description": "Group ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "type": "string", "example": "success" } }, "type": "object" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "message": { "type": "string", "example": "User Integration Not Found" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "message": { "type": "string", "example": "Can`t refresh Teams Contacts" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "groups:read" ] } ], "x-versions": [ "public" ] } }, "/groups/refresh-integration-teams-contacts/{organizationId}": { "get": { "tags": [ "Groups" ], "summary": "Refresh teams contacts", "description": "REQUIRED SCOPES ['groups:read']
Refresh teams contacts", "operationId": "291395edd41716f79d87226fcf1ad943", "parameters": [ { "name": "organizationId", "in": "path", "description": "The ID of the organization", "required": true, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "groups:read" ] } ], "x-versions": [ "public" ] } }, "/groups/refresh-integration-teams": { "get": { "tags": [ "Groups" ], "summary": "Refresh integration teams", "description": "REQUIRED SCOPES ['groups:read']
Refresh integration teams", "operationId": "4b1bc0610bd379c66d19b5048f64380f", "parameters": [ { "name": "integration_team_id", "in": "query", "description": "Describes team, wich members should be updated after syncing with integration", "required": false, "schema": { "type": "integer", "example": 11 } }, { "name": "client_id", "in": "query", "description": "client id", "required": false, "schema": { "type": "integer", "example": 11 } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "groups:read" ] } ], "x-versions": [ "public" ] } }, "/groups/update": { "put": { "tags": [ "Groups" ], "summary": "Update a group", "description": "REQUIRED SCOPES ['groups:write']
Update details of a specific group", "operationId": "updateGroup", "requestBody": { "description": "Updated group details", "required": true, "content": { "application/json": { "schema": { "properties": { "group_id": { "type": "integer", "example": "1" }, "name": { "type": "string", "example": "Updated Group Name" }, "description": { "type": "string", "example": "Updated group description" }, "members": { "type": "array", "items": { "type": "integer" }, "example": [ 1, 2, 3 ] } }, "type": "object" } } } }, "responses": { "200": { "description": "Group updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupResource" } } } } }, "x-versions": [ "public" ] } }, "/keywords": { "get": { "tags": [ "Keywords" ], "summary": "Search keywords", "description": "REQUIRED SCOPES ['keywords:read']
Search keywords", "operationId": "d303eff4a621f97d0b16876190b93f7a", "parameters": [ { "name": "limit", "in": "query", "description": "The number of items to return per page.", "schema": { "type": "integer", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KeywordResource" } } } } } }, "security": [ { "apiAuth": [ "keywords:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Keywords" ], "summary": "Create keyword", "description": "REQUIRED SCOPES ['keywords:write']
Create keyword", "operationId": "b1ccff9332c8124754b5e06c90b661fa", "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "description": "Name", "type": "string" }, "is_active": { "description": "Activate", "type": "boolean" }, "message": { "description": "Message", "type": "string" }, "numbers": { "description": "Days", "type": "array", "items": { "type": "integer" } }, "title": { "description": "Title", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeywordResource" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "status": { "title": "status", "type": "string" }, "errors": { "title": "errors", "type": "array", "items": { "type": "string" } }, "error": { "title": "error", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "keywords:write" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Keywords" ], "summary": "Delete bulk keywords", "description": "REQUIRED SCOPES ['keywords:write']
Delete bulk keywords", "operationId": "c6274b3fd49e610b781cc9e2c062779b", "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "description": "Ids", "type": "array", "items": { "type": "integer" } }, "bulk_all": { "description": "Bulk All", "type": "boolean", "default": false } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "action": { "type": "string" }, "ids": { "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "ids": { "title": "ids", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "keywords:write" ] } ], "x-versions": [ "public" ] } }, "/keywords/{keyword}": { "get": { "tags": [ "Keywords" ], "summary": "Get keyword", "description": "REQUIRED SCOPES ['keywords:read']
Get keyword by ID", "operationId": "d100ef3abce6aff01ad0f005435e0451", "parameters": [ { "name": "keyword", "in": "path", "description": "The ID of the keyword", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeywordResource" } } } } }, "security": [ { "apiAuth": [ "keywords:read" ] } ], "x-versions": [ "public" ] }, "put": { "tags": [ "Keywords" ], "summary": "Update keyword", "description": "REQUIRED SCOPES ['keywords:write']
Update keyword", "operationId": "35f446b9ac231bf80a8cb780a3c14a15", "parameters": [ { "name": "keyword", "in": "path", "description": "The ID of the keyword", "required": true, "schema": { "type": "string", "example": "" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "description": "Name", "type": "string" }, "is_active": { "description": "Activate", "type": "boolean" }, "message": { "description": "Message", "type": "string" }, "numbers": { "description": "Days", "type": "array", "items": { "type": "integer" } }, "title": { "description": "Title", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeywordResource" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "status": { "title": "status", "type": "string" }, "errors": { "title": "errors", "type": "array", "items": { "type": "string" } }, "error": { "title": "error", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "keywords:write" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Keywords" ], "summary": "Delete keyword", "description": "REQUIRED SCOPES ['keywords:write']
Delete keyword", "operationId": "457d92b7d330389182272e97a2576225", "parameters": [ { "name": "keyword", "in": "path", "description": "The ID of the keyword", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "apiAuth": [ "keywords:write" ] } ], "x-versions": [ "public" ] } }, "/keywords/mandated": { "get": { "tags": [ "Keywords" ], "summary": "Get mandated keywords", "description": "REQUIRED SCOPES ['keywords:read']
Get mandated keywords", "operationId": "b9b5eafa32d3876ff233d8ed2407683a", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "apiAuth": [ "keywords:read" ] } ], "x-versions": [ "public" ] } }, "/keywords/{keyword}/stats": { "get": { "tags": [ "Keywords" ], "summary": "Get keyword stats", "description": "REQUIRED SCOPES ['keywords:read']
Get keyword stats", "operationId": "70c9926e0cafcd354f4796473d762307", "parameters": [ { "name": "keyword", "in": "path", "description": "The ID of the keyword", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "security": [ { "apiAuth": [ "keywords:read" ] } ], "x-versions": [ "public" ] } }, "/keywords/{keyword}/contacts": { "get": { "tags": [ "Keywords" ], "summary": "Get keyword contacts", "description": "REQUIRED SCOPES ['keywords:read']
Get keyword contacts", "operationId": "256bbd53965ad2b1d2fa7baf7d5160ca", "parameters": [ { "name": "keyword", "in": "path", "description": "The ID of the keyword", "required": true, "schema": { "type": "string", "example": "" } }, { "name": "page", "in": "query", "description": "The page of a collection to return.", "schema": { "type": "integer", "default": "1" } }, { "name": "limit", "in": "query", "description": "The number of items to return per page.", "schema": { "type": "integer", "default": "10" } }, { "name": "term", "in": "query", "description": "Search term", "required": false, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "Filter", "required": false, "schema": { "type": "string", "enum": [ "subscribed", "opted_out" ] } }, { "name": "from", "in": "query", "description": "Start date for the statistics range (YYYY-MM-DD)", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Start date for the statistics range (YYYY-MM-DD)", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactResource" } } } } } }, "security": [ { "apiAuth": [ "keywords:read" ] } ], "x-versions": [ "public" ] } }, "/keywords/subscribe/toggle/{keyword}/{contact}": { "put": { "tags": [ "Keywords" ], "summary": "Delete bulk keywords", "description": "REQUIRED SCOPES ['keywords:write']
Delete bulk keywords", "operationId": "0a5b377033e2acae8a9ef9821fc9aca7", "parameters": [ { "name": "keyword", "in": "path", "description": "The ID of the keyword", "required": true, "schema": { "type": "string", "example": "" } }, { "name": "contact", "in": "path", "description": "The ID of the contact", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "apiAuth": [ "keywords:write" ] } ], "x-versions": [ "public" ] } }, "/keywords/toggle/{keyword}": { "put": { "tags": [ "Keywords" ], "summary": "Toggle keyword", "description": "REQUIRED SCOPES ['keywords:write']
Toggle keyword", "operationId": "8e9ee418248870630900caf939df43ee", "parameters": [ { "name": "keyword", "in": "path", "description": "The ID of the keyword", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeywordResource" } } } } }, "security": [ { "apiAuth": [ "keywords:write" ] } ], "x-versions": [ "public" ] } }, "/messages/{message}": { "put": { "tags": [ "Messages" ], "summary": "Update a message", "description": "REQUIRED SCOPES ['messages:write']", "operationId": "417276360aa8d9da655e9d2180693159", "parameters": [ { "name": "message", "in": "path", "description": "ID of the message to update", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "body": { "description": "New body of the message", "type": "string" }, "media_url": { "description": "Media URL for MMS", "type": "string" }, "send_at": { "description": "New scheduled time for the message", "type": "string", "format": "date-time" }, "stop_on_response": { "type": "boolean" }, "is_contact_timezone": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Message updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResource" } } } }, "404": { "description": "Message not found" }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "messages:write" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Messages" ], "summary": "Delete scheduled message", "description": "REQUIRED SCOPES ['messages:write']
Delete scheduled message by id", "operationId": "400e7296e26419727e6a5a60087127f7", "parameters": [ { "name": "message", "in": "path", "description": "The ID of the Message", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "messages:write" ] } ], "x-versions": [ "public" ] } }, "/messages/draft": { "get": { "tags": [ "Messages" ], "summary": "Get list of draft messages", "description": "REQUIRED SCOPES ['messages:read']", "operationId": "a4758d6bcdaa9ba0f0a85d22670c2bf5", "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer", "default": 15 } }, { "name": "inbox_type", "in": "query", "description": "Inbox Type", "required": true, "schema": { "type": "integer" } }, { "name": "inbox_id", "in": "query", "description": "ID of Inbox", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MessageResource" } }, "meta": { "properties": { "current_page": { "type": "integer" }, "from": { "type": "integer" }, "last_page": { "type": "integer" }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "to": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "messages:read" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Messages" ], "summary": "Delete a draft message", "description": "REQUIRED SCOPES ['messages:write']", "operationId": "fe412796e0d1656356d28dc7397fd7f5", "parameters": [ { "name": "conversation_id", "in": "query", "description": "ID of the conversation", "required": true, "schema": { "type": "string" } }, { "name": "inbox_id", "in": "query", "description": "ID of the inbox", "required": true, "schema": { "type": "integer" } }, { "name": "inbox_type", "in": "query", "description": "Type of the inbox", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "deleted" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Draft message not found" } }, "security": [ { "apiAuth": [ "messages:write" ] } ], "x-versions": [ "public" ] } }, "/messages/draft/{conversationId}": { "get": { "tags": [ "Messages" ], "summary": "Get a draft message for a specific conversation", "description": "REQUIRED SCOPES ['messages:read']", "operationId": "5599e6bb75f0604876b708916f81d80f", "parameters": [ { "name": "conversationId", "in": "path", "description": "ID of the conversation", "required": true, "schema": { "type": "string" } }, { "name": "inbox_type", "in": "query", "description": "Type of the inbox", "required": true, "schema": { "type": "integer" } }, { "name": "inbox_id", "in": "query", "description": "ID of the inbox", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResource" } } } }, "204": { "description": "No draft message found", "content": { "application/json": { "schema": { "type": "null" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "messages:read" ] } ], "x-versions": [ "public" ] } }, "/messages/files/upload": { "post": { "tags": [ "Messages" ], "summary": "Upload files", "description": "REQUIRED SCOPES [‘messages:write’]
This endpoint allows for uploading files by public API for the contact.

The types of messages available for the contacts include texts, images, url links, files, vcards, .pdf and more. Additionally, there’s an ability to include up to five image files, attachments, hyperlinks to book appointments, send gifs, and emojis just like regular texting.

Any uploaded file turners into a short hyperlink which leads to the original file to view the attachment.", "operationId": "Upload files", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "files[]": { "type": "array", "items": { "type": "string", "format": "binary" } } }, "type": "object" } } } }, "responses": { "200": { "description": "JSON Outbound Message", "content": { "application/json": { "schema": { "properties": { "urls": { "type": "array", "items": { "properties": { "url": { "type": "string" }, "content_type": { "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "properties": { "files.0": { "type": "array", "items": { "type": "string", "example": "We currently only allow: image/jpeg, image/gif, image/png, image/bmp, text/vcard" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "messages:write" ] } ], "x-versions": [ "public" ] } }, "/messages/forward": { "post": { "tags": [ "Messages" ], "summary": "Forward a message to multiple contacts", "description": "REQUIRED SCOPES ['messages:write']", "operationId": "dcecd8bb6d16892f0a4ed4baac321ea6", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "inbox_id": { "description": "ID of the inbox (team)", "type": "integer" }, "message_id": { "description": "ID of the message to forward", "type": "integer" }, "list_of_contacts": { "description": "Array of contact IDs to forward the message to", "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Message forwarded successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Successfully sent" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "messages:write" ] } ], "x-versions": [ "public" ] } }, "/messages/last-outbound": { "get": { "tags": [ "Messages" ], "summary": "Get last outbound messages", "description": "REQUIRED SCOPES ['messages:read']", "operationId": "Get last outbound messages", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": {} } } } } }, "security": [ { "apiAuth": [ "messages:read" ] } ], "x-versions": [ "public" ] } }, "/messages/contacts": { "get": { "tags": [ "Messages" ], "summary": "Get messages by contacts", "description": "REQUIRED SCOPES ['messages:read']
Returns an array of messages found by Contact ID and Inbox ID. If multiple Contact IDs are provided, this endpoint will search for group conversations with these IDs.", "operationId": "57a1c157d0fcdbbde20097864dc45d98", "parameters": [ { "name": "contacts[]", "in": "query", "description": "Contacts", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "team_id", "in": "query", "description": "Team ID", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "The number of items to return per page.", "schema": { "type": "integer", "default": "20" } }, { "name": "before", "in": "query", "description": "Before", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageResource" } } } } } }, "security": [ { "apiAuth": [ "messages:read" ] } ], "x-versions": [ "public" ] } }, "/messages/{conversation}": { "get": { "tags": [ "Messages" ], "summary": "Get user conversation", "description": "REQUIRED SCOPES ['messages:read']
This API endpoint returns a paginated list of current user conversations including the latest messages. Will return most recent messages first.

The request is used to fetch thread message information by `conversation_id`.", "operationId": "Get user conversation", "parameters": [ { "name": "conversation", "in": "path", "description": "ID of conversation", "required": true, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "Limit", "required": true, "schema": { "type": "integer", "example": "10" } }, { "name": "before", "in": "query", "description": "Where message id is less than", "required": false, "schema": { "type": "integer", "example": "" } }, { "name": "grouped_response", "in": "query", "description": "Is return grouped response", "required": false, "schema": { "type": "boolean", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageResource" } } } } } }, "security": [ { "apiAuth": [ "messages:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Messages" ], "summary": "Send SMS by conversation", "description": "REQUIRED SCOPES ['messages:write']
Send SMS message via API. This API endpoint allows for sending an SMS by conversation that belongs to an authenticated account.

Messages are sent on behalf of a user, may include attachments. Actual links included in text messages will be sent as clickable hyperlinks.", "operationId": "Send SMS by conversation", "parameters": [ { "name": "conversation", "in": "path", "description": "Conversation id", "required": true, "schema": { "type": "integer", "example": "1" } }, { "name": "message", "in": "query", "description": "Message", "required": true, "schema": { "type": "string", "format": "textarea" } }, { "name": "send_at", "in": "query", "description": "Send At", "required": false, "schema": { "type": "string", "format": "date", "example": "2023-05-25T17:30:15Z" } }, { "name": "media_url[][url]", "in": "query", "description": "Url for media", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string", "example": "https://example.com/image.png" } } }, { "name": "enable_quiet_hours", "in": "query", "description": "Is enable quiet hours сheck", "required": false, "schema": { "type": "boolean", "example": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResource" } } } } }, "security": [ { "apiAuth": [ "messages:write" ] } ], "x-versions": [ "public" ] } }, "/messages/{conversation}/paginated": { "get": { "tags": [ "Messages" ], "summary": "Get paginated list of messages for a conversation", "description": "REQUIRED SCOPES ['messages:read']", "operationId": "bd659d4fd1353dc03ad883e4e3d44086", "parameters": [ { "name": "conversation", "in": "path", "description": "ID of the conversation", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Number of messages per page", "required": true, "schema": { "type": "integer", "default": 15 } }, { "name": "page", "in": "query", "description": "Page number", "required": true, "schema": { "type": "integer", "default": 1 } }, { "name": "with_activity_logs", "in": "query", "description": "Include activity logs", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "only_scheduled", "in": "query", "description": "Only return scheduled messages", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "message_id", "in": "query", "description": "Message ID", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MessageResource" } }, "meta": { "properties": { "current_page": { "type": "integer" }, "from": { "type": "integer" }, "last_page": { "type": "integer" }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "to": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Conversation not found" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "messages:read" ] } ], "x-versions": [ "public" ] } }, "/messages/contacts/{contact}/teams/{team}": { "get": { "tags": [ "Messages" ], "summary": "Get messages by contact and team", "description": "REQUIRED SCOPES ['messages:read']", "operationId": "7402d2f9f9378fe3ecd2cd754472f752", "parameters": [ { "name": "contact", "in": "path", "description": "ID of the contact", "required": true, "schema": { "type": "integer" } }, { "name": "team", "in": "path", "description": "ID of the team", "required": true, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "Number of messages to return", "required": false, "schema": { "type": "integer", "default": 10 } }, { "name": "before", "in": "query", "description": "Return messages before this message ID", "required": false, "schema": { "type": "integer" } }, { "name": "after", "in": "query", "description": "Return messages after this message ID", "required": false, "schema": { "type": "integer" } }, { "name": "beforeOrEqual", "in": "query", "description": "Return messages before or equal this message ID", "required": false, "schema": { "type": "integer" } }, { "name": "afterOrEqual", "in": "query", "description": "Return messages after or equal this message ID", "required": false, "schema": { "type": "integer" } }, { "name": "offsetAfter", "in": "query", "description": "Set messages offset", "required": false, "schema": { "type": "integer" } }, { "name": "grouped_response", "in": "query", "description": "Whether to return a grouped response", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MessageResource" } }, "meta": { "properties": { "conversation_id": { "type": "integer" }, "has_more": { "type": "boolean" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Contact, team, or conversation not found" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "messages:read" ] } ], "x-versions": [ "public" ] } }, "/conversations/{conversation}/messages/mark-read": { "patch": { "tags": [ "Conversations" ], "summary": "Mark specific messages as read in a conversation", "description": "REQUIRED SCOPES ['conversations:write']", "operationId": "Mark specific messages as read in a conversation", "parameters": [ { "name": "conversation", "in": "path", "description": "ID of the conversation", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "description": "Array of message IDs to mark as read", "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "responses": { "204": { "description": "Messages marked as read successfully" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Conversation not found" }, "422": { "description": "Validation error" } }, "security": [ { "apiAuth": [ "conversations:write" ] } ], "x-versions": [ "public" ] } }, "/messages/{message}/media/download": { "get": { "tags": [ "Messages" ], "summary": "Download message media", "description": "REQUIRED SCOPES ['messages:read']
Download message media", "operationId": "Download message media", "responses": { "200": { "description": "OK", "content": { "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "message": { "title": "message", "type": "string" } }, "type": "object" } } } }, "404": { "description": "Attachment Not Found" } }, "security": [ { "apiAuth": [ "messages:read" ] } ], "x-versions": [ "public" ] } }, "/messages/{message}/media/retry": { "post": { "tags": [ "Messages" ], "summary": "Retry to send media", "description": "REQUIRED SCOPES ['messages:write']
Retry to send media", "operationId": "5c91d9b71e3380473dcb7242d487aa96", "parameters": [ { "name": "message", "in": "path", "description": "The ID of the Message", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Processing." } }, "type": "object" } } } }, "403": { "description": "No media or media delivered", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "This action is unauthorized." }, "status": { "type": "integer", "example": 403 } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "messages:write" ] } ], "x-versions": [ "public" ] } }, "/messages/{message}/retry": { "post": { "tags": [ "Messages" ], "summary": "Retry to send the message", "description": "REQUIRED SCOPES ['messages:write']
Retry to send the message", "operationId": "cef8261986ddb63d0bd2d8e6d81cb72f", "parameters": [ { "name": "message", "in": "path", "description": "The ID of the Message", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResource" } } } } }, "security": [ { "apiAuth": [ "messages:write" ] } ], "x-versions": [ "public" ] } }, "/messages/scheduled": { "get": { "tags": [ "Messages" ], "summary": "Get scheduled message", "description": "REQUIRED SCOPES ['messages:read']
Get scheduled message by id", "operationId": "6a979e7448e7dd9b26fd42fc09b2db6d", "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "term", "in": "query", "description": "Search text", "required": false, "schema": { "type": "string", "example": "test" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "current_page": { "type": "integer", "example": 1 }, "data": { "type": "array", "items": { "type": "object" } }, "first_page_url": { "type": "string", "example": "https://url?page=1" }, "last_page_url": { "type": "string", "example": "https://url?page=5" }, "last_page": { "type": "integer", "example": 5 }, "per_page": { "type": "integer", "example": 10 }, "total": { "type": "integer", "example": 45 } }, "type": "object" } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "messages:read" ] } ], "x-versions": [ "public" ] } }, "/messages/{conversation}/scheduled/count": { "get": { "tags": [ "Messages" ], "summary": "Get Count Scheduled Message By Conversation", "description": "REQUIRED SCOPES ['messages:read']
Count Scheduled Message By Conversation", "operationId": "b449d686d92389f4ecf6dbef837ecfcc", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "count": { "type": "integer", "example": 1 }, "ids": { "title": "Value Data", "type": "array", "items": { "properties": { "": { "type": "integer", "example": 1 } }, "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "messages:read" ] } ], "x-versions": [ "public" ] } }, "/messages": { "post": { "tags": [ "Messages" ], "summary": "Send SMS by number", "description": "REQUIRED SCOPES [‘messages:write’]
Using the given endpoint, you can send an SMS message via API by phone number.

As a result, instead of team’s id and conversation’s id, it is allowed to indicate the user’s phone number in order to send them a message.", "operationId": "Send SMS by number", "parameters": [ { "name": "number", "in": "query", "description": "Number", "required": true, "schema": { "type": "string", "example": "+12025550018" } }, { "name": "team_id", "in": "query", "description": "Team ID", "required": true, "schema": { "type": "integer", "minimum": 1, "example": 1 } }, { "name": "message", "in": "query", "description": "Message", "required": true, "schema": { "type": "string", "format": "textarea" } }, { "name": "send_at", "in": "query", "description": "Send At", "required": false, "schema": { "type": "string", "format": "date-time" }, "example": "2023-05-25T17:30:15Z" }, { "name": "media_url[][url]", "in": "query", "description": "Url for media", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string", "example": "https://example.com/image.png" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResource" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "message": { "title": "message", "type": "string" } }, "type": "object" } } } }, "404": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "status": { "type": "integer", "example": 404 }, "message": { "type": "string", "example": "Unauthorized action." } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "messages:write" ] } ], "x-versions": [ "public" ] } }, "/users/message-signature": { "get": { "tags": [ "Users" ], "summary": "Get user's message signature", "description": "REQUIRED SCOPES ['users:read']
Get user's message signature", "operationId": "79e4979b9e62f207a04520cd6e70ecb5", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "title": "ID", "type": "integer" }, "user_id": { "title": "User ID", "type": "integer" }, "signature": { "title": "Signature", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" } }, "type": "object" } } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "apiAuth": [ "users:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Users" ], "summary": "Create or update a message signature", "description": "REQUIRED SCOPES ['users:write']
Create or update a message signature", "operationId": "d07d68640184141c18444cbb1b791bfa", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "signature": { "description": "The message signature text", "type": "string" }, "is_active": { "description": "Whether the signature is active", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "id": { "title": "ID", "type": "integer" }, "user_id": { "title": "User ID", "type": "integer" }, "signature": { "title": "Signature", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "apiAuth": [ "users:write" ] } ], "x-versions": [ "public" ] } }, "/messages/{message}/mentions/{taggingUser}/activate": { "post": { "tags": [ "Messages" ], "summary": "Activate mentioned users", "description": "REQUIRED SCOPES ['messages:write']
Activate mentioned users", "operationId": "c29b6f0ca3ba6bf5d57b44c5e0a70126", "parameters": [ { "name": "message", "in": "path", "description": "The ID of the Message", "required": true, "schema": { "type": "string", "example": "" } }, { "name": "taggingUser", "in": "path", "description": "The ID of the taggingUser", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResource" } } } } }, "security": [ { "apiAuth": [ "messages:write" ] } ], "x-versions": [ "public" ] } }, "/messages/{message}/mentions/{taggingUser}/cancel": { "post": { "tags": [ "Messages" ], "summary": "Mentioned user got it", "description": "REQUIRED SCOPES ['messages:write']
Mentioned user got it", "operationId": "5b674bbe10947a0613536903030c8c9b", "parameters": [ { "name": "message", "in": "path", "description": "The ID of the Message", "required": true, "schema": { "type": "string", "example": "" } }, { "name": "taggingUser", "in": "path", "description": "The ID of the taggingUser", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResource" } } } } }, "security": [ { "apiAuth": [ "messages:write" ] } ], "x-versions": [ "public" ] } }, "/messages/{message}/mentions/{taggingUser}/got-it": { "post": { "tags": [ "Messages" ], "summary": "Deactivate mentioned users", "description": "REQUIRED SCOPES ['messages:write']
Deactivate mentioned users", "operationId": "779fe2bfd20efd331510235f4b7e7411", "parameters": [ { "name": "message", "in": "path", "description": "The ID of the Message", "required": true, "schema": { "type": "string", "example": "" } }, { "name": "taggingUser", "in": "path", "description": "The ID of the taggingUser", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResource" } } } }, "404": { "description": "Not Found" }, "403": { "description": "Incorrect Organization", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "message": { "title": "message", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "messages:write" ] } ], "x-versions": [ "public" ] } }, "/messages/{message}/transcript": { "get": { "tags": [ "Messages" ], "summary": "Get a specific message for transcript", "description": "REQUIRED SCOPES ['messages:read']", "operationId": "8ed81a3c4448381788fb7851c13b89fd", "parameters": [ { "name": "message", "in": "path", "description": "ID of the message", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResource" } } } }, "404": { "description": "Message not found" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "messages:read" ] } ], "x-versions": [ "public" ] } }, "/messages/{message}/transcript/manual": { "post": { "tags": [ "Messages" ], "summary": "Manually initiate transcription for a call message", "description": "REQUIRED SCOPES ['messages:write']", "operationId": "2ad1b3e86a558d3ec139c7554fbbc335", "parameters": [ { "name": "message", "in": "path", "description": "ID of the message", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Transcription initiated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResource" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "reason": { "type": "string", "example": "Incorrect message." } }, "type": "object" } } } }, "404": { "description": "Message not found" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "messages:write" ] } ], "x-versions": [ "public" ] } }, "/messages/{message}/transcript/retry": { "post": { "tags": [ "Messages" ], "summary": "Retry transcription for a message", "description": "REQUIRED SCOPES ['messages:write']", "operationId": "e06404c3c906629548a50c12092b8d64", "parameters": [ { "name": "message", "in": "path", "description": "ID of the message", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Transcription retry initiated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "reason": { "type": "string", "example": "There are no attempts for the transcription." } }, "type": "object" } } } }, "404": { "description": "Message not found" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "messages:write" ] } ], "x-versions": [ "public" ] } }, "/async/messages/{conversation}": { "post": { "tags": [ "Messages" ], "summary": "Send async SMS by conversation", "description": "REQUIRED SCOPES ['messages:write']
Send async SMS message via API. This API endpoint allows for sending an SMS by conversation that belongs to an authenticated account.

Messages are sent on behalf of a user, may include attachments. Actual links included in text messages will be sent as clickable hyperlinks.", "operationId": "Send async SMS by conversation", "parameters": [ { "name": "conversation", "in": "path", "description": "Conversation id", "required": true, "schema": { "type": "integer", "example": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "description": "Message", "type": "string", "format": "textarea", "example": "Test message" }, "send_at": { "description": "Send At", "type": "string", "format": "date-time", "example": "2023-05-25T17:30:15Z" }, "media_url": { "description": "Url for media", "type": "array", "format": "array", "items": { "type": "string" }, "example": [ { "url": "https://example.com/image1.png" }, { "url": "https://example.com/image2.png" } ] }, "mute_period": { "description": "Conversation mute period (In hours)", "type": "integer", "minimum": "0", "example": "0" }, "lock_period": { "description": "Conversation lock period (In hours)", "type": "integer", "minimum": "0", "example": "0" }, "enable_quiet_hours": { "description": "Is enable quiet hours сheck", "type": "boolean", "example": true }, "enable_realtime_updates": { "type": "boolean", "description": "Emit realtime (WebSocket) updates for this message, so the Salesmsg inbox conversation list refreshes immediately instead of on the next reply or manual open. Disabled by default: for high-volume sending every message produces an extra realtime event, so enable it only when live inbox updates are needed.", "default": false, "example": true } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "uuid": { "description": "Message UUID", "type": "string", "example": "1111a111-11a1-11a1-1b11-11aa1aa11a11" }, "message": { "description": "Success message", "type": "string", "example": "The message was successfully processed" }, "code": { "description": "Code", "type": "integer", "example": "200" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Unauthorized" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "error": { "title": "Error", "type": "string", "example": "Message body should not be empty." }, "code": { "title": "Code", "type": "integer", "example": "422" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "messages:write" ] } ], "x-versions": [ "public" ] } }, "/async/messages": { "post": { "tags": [ "Messages" ], "summary": "Send async SMS by number", "description": "REQUIRED SCOPES [‘messages:write’]
Using the given endpoint, you can send async SMS message via API by phone number.

As a result, instead of team’s id and conversation’s id, it is allowed to indicate the user’s phone number in order to send them a message.", "operationId": "Send async SMS by number", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "number", "team_id", "message" ], "properties": { "number": { "description": "Number", "type": "string", "format": "string", "example": "+12025550018" }, "team_id": { "description": "Team ID", "type": "integer", "minimum": "1", "example": "1" }, "message": { "description": "Message", "type": "string", "format": "textarea", "example": "Test message" }, "sending_options": { "properties": { "smart_option": { "description": "'scaler' or 'local_presence'", "type": "string" }, "number_id": { "description": "Explicit number to send from (non-smart routing)", "type": "integer" }, "send_from": { "description": "Use 'sending_options_rcs' to send from RCS inbox", "type": "string", "enum": [ "sending_options_rcs" ] }, "team_id": { "description": "RCS team/inbox id when send_from is sending_options_rcs", "type": "integer" } }, "type": "object" }, "send_at": { "description": "Send At", "type": "string", "format": "date-time", "example": "2023-05-25T17:30:15Z" }, "media_url": { "description": "Url for media", "type": "array", "format": "array", "items": { "type": "string" }, "example": [ { "url": "https://example.com/image1.png" }, { "url": "https://example.com/image2.png" } ] }, "mute_period": { "description": "Conversation mute period (In hours)", "type": "integer", "minimum": "0", "example": "0" }, "lock_period": { "description": "Conversation lock period (In hours)", "type": "integer", "minimum": "0", "example": "0" }, "enable_quiet_hours": { "description": "Is enable quiet hours сheck", "type": "boolean", "example": true }, "enable_realtime_updates": { "type": "boolean", "description": "Emit realtime (WebSocket) updates for this message, so the Salesmsg inbox conversation list refreshes immediately instead of on the next reply or manual open. Disabled by default: for high-volume sending every message produces an extra realtime event, so enable it only when live inbox updates are needed.", "default": false, "example": true } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "uuid": { "description": "Message UUID", "type": "string", "example": "1111a111-11a1-11a1-1b11-11aa1aa11a11" }, "message": { "description": "Success message", "type": "string", "example": "The message was successfully processed" }, "code": { "description": "Code", "type": "integer", "example": "200" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Unauthorized" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "error": { "title": "Error", "type": "string", "example": "Invalid number" }, "code": { "title": "Code", "type": "integer", "example": "422" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "messages:write" ] } ], "x-versions": [ "public" ] } }, "/numbers/{number}/assign-inbox/{team}": { "post": { "tags": [ "Numbers" ], "summary": "Assign the number to the inbox", "description": "REQUIRED SCOPES ['numbers:write']
Assign the number to the inbox", "operationId": "1841948b86fc235526fc49047cc3be80", "parameters": [ { "name": "number", "in": "path", "description": "The ID of the Number", "required": true, "schema": { "type": "string", "example": "" } }, { "name": "team", "in": "path", "description": "The ID of the Team", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberResource" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "number": { "title": "number", "type": "string" }, "inbox": { "title": "inbox", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "numbers:write" ] } ], "x-versions": [ "public" ] } }, "/numbers/assign-inbox/{team}": { "post": { "tags": [ "Numbers" ], "summary": "Assign numbers to the inbox", "description": "REQUIRED SCOPES ['numbers:write']
Assign numbers to the inbox", "operationId": "58ca9ddeeeb1e3519e3487c4f633a3e4", "parameters": [ { "name": "team", "in": "path", "description": "The ID of the Team", "required": true, "schema": { "type": "string", "example": "" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "numberIds" ], "properties": { "numberIds": { "description": "The IDs of the Numbers", "type": "array", "items": { "type": "integer", "example": 1 } } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NumberResource" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "number": { "title": "number", "type": "string" }, "inbox": { "title": "inbox", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "numbers:write" ] } ], "x-versions": [ "public" ] } }, "/numbers/{number}/call_forwarding": { "post": { "tags": [ "Numbers" ], "summary": "Set call forwarding", "description": "REQUIRED SCOPES ['numbers:write']
Set call forwarding", "operationId": "a3eb4a5002a8a6f47e7c11a580fd248d", "parameters": [ { "name": "number", "in": "path", "description": "The ID of the Number", "required": true, "schema": { "type": "string", "example": "" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "is_active", "number" ], "properties": { "number": { "description": "Phone number", "type": "string", "example": "" }, "is_active": { "description": "Is active", "type": "boolean", "example": true }, "extension": { "description": "Extension", "type": "integer", "example": null, "nullable": true }, "is_call_whisper": { "description": "Play short message before the call", "type": "boolean", "example": false }, "call_whisper": { "description": "A short message that plays before the call", "type": "string", "example": null, "nullable": true }, "is_screening": { "description": "When enabled, you will be prompted to accept the call when answering the forwarded call", "type": "boolean", "example": false } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberResource" } } } } }, "security": [ { "apiAuth": [ "numbers:write" ] } ], "x-versions": [ "public" ] } }, "/numbers/landline/document/create": { "post": { "tags": [ "Numbers Landline" ], "summary": "Create landline document", "description": "REQUIRED SCOPES ['numbers-landline:write']
Create landline document", "operationId": "a8c5853a0251498f31c92b8ea1f782a4", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "phone" ], "properties": { "phone": { "description": "Phone", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "number": { "$ref": "#/components/schemas/NumberResource" }, "document": { "title": "Document", "type": "string" } }, "type": "object" } } } }, "404": { "description": "Number Not Found" }, "500": { "description": "Incorrect Number", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" }, "raw_error": { "title": "raw_error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "numbers-landline:write" ] } ], "x-versions": [ "public" ] } }, "/numbers/landline/create": { "post": { "tags": [ "Numbers Landline" ], "summary": "Create landline number", "description": "REQUIRED SCOPES ['numbers-landline:write']
Create landline number", "operationId": "5d8f8f78aef747c327d62e26775b6359", "requestBody": { "content": { "application/json": { "schema": { "properties": { "phone": { "description": "Phone", "type": "string" }, "friendly_name": { "description": "Friendly name", "type": "string" }, "street": { "description": "Street", "type": "string" }, "city": { "description": "City", "type": "string" }, "state": { "description": "State", "type": "string" }, "zip": { "description": "Activate", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberResource" } } } }, "500": { "description": "Incorrect Number", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" }, "raw_error": { "title": "raw_error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "numbers-landline:write" ] } ], "x-versions": [ "public" ] } }, "/numbers/landline/fetch": { "get": { "tags": [ "Numbers Landline" ], "summary": "Get landline numbers", "description": "REQUIRED SCOPES ['numbers-landline:read']
Get landline numbers", "operationId": "c1f2cc1c34611c99e2011d7885f822d1", "parameters": [ { "name": "phone", "in": "query", "description": "Phone", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "type": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "numbers-landline:read" ] } ], "x-versions": [ "public" ] } }, "/numbers/landline/delete": { "delete": { "tags": [ "Numbers Landline" ], "summary": "Delete landline", "description": "REQUIRED SCOPES ['numbers-landline:write']
Delete landline", "operationId": "338b10e876108312dadf3b6c1d10aec3", "parameters": [ { "name": "phone", "in": "query", "description": "Phone", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberResource" } } } } }, "security": [ { "apiAuth": [ "numbers-landline:write" ] } ], "x-versions": [ "public" ] } }, "/numbers/landline/team/create": { "post": { "tags": [ "Numbers Landline" ], "summary": "Create inbox", "description": "REQUIRED SCOPES ['numbers-landline:write']
Create inbox", "operationId": "85724cfd2dc633d118708857d22c6bc2", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "phone", "name" ], "properties": { "phone": { "description": "Phone", "type": "string" }, "name": { "description": "Inbox Name", "type": "string" }, "members": { "title": "Member IDs", "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamResource" } } } } }, "security": [ { "apiAuth": [ "numbers-landline:write" ] } ], "x-versions": [ "public" ] } }, "/numbers/landline/inbox/update": { "post": { "tags": [ "Numbers Landline" ], "summary": "Update inbox", "description": "REQUIRED SCOPES ['numbers-landline:write']
Update inbox", "operationId": "d7d94c74c6905d0bd3883ef79dbcb945", "requestBody": { "content": { "application/json": { "schema": { "properties": { "landline_phone": { "description": "Phone", "type": "string" }, "phone_to_replace": { "description": "Phone to replace", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberResource" } } } } }, "security": [ { "apiAuth": [ "numbers-landline:write" ] } ], "x-versions": [ "public" ] } }, "/numbers/landline/verify/request": { "post": { "tags": [ "Numbers Landline" ], "summary": "Request landline verification", "description": "REQUIRED SCOPES ['numbers-landline:write']
Request landline verification", "operationId": "76d577e320834965704cbbd737e53a1a", "requestBody": { "content": { "application/json": { "schema": { "properties": { "phone": { "description": "Phone", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "number": { "$ref": "#/components/schemas/NumberResource" }, "verification_code": { "title": "Verification code", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "numbers-landline:write" ] } ], "x-versions": [ "public" ] } }, "/numbers": { "get": { "tags": [ "Numbers" ], "summary": "Get numbers", "description": "REQUIRED SCOPES ['numbers:read']
Get numbers", "operationId": "9a45b26fa83b36cc903d6d9dcf2363ee", "parameters": [ { "name": "query", "in": "query", "description": "Search by number", "required": false, "schema": { "type": "string", "minLength": 1, "example": "" } }, { "name": "ids[]", "in": "query", "description": "The IDs of Numbers", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "limit", "in": "query", "description": "Results per page", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "example": 10 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "numbers:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Numbers" ], "summary": "Create number", "description": "REQUIRED SCOPES ['numbers:write']
Create number", "operationId": "47e792300b6fd74c63277c90ebf7cb2e", "parameters": [ { "name": "number", "in": "query", "description": "Number", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberResource" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "message": { "title": "message", "type": "string" } }, "type": "object" } } } }, "500": { "description": "Invalid Number", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "numbers:write" ] } ], "x-versions": [ "public" ] } }, "/numbers/lookup": { "get": { "tags": [ "Numbers" ], "summary": "Lookup a phone number", "description": "REQUIRED SCOPES ['numbers:read']
Lookup a phone number using the lookup tool", "operationId": "a83e36e8b25b22b3fac8f0e98dad9755", "parameters": [ { "name": "number", "in": "query", "description": "Number", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "number": { "title": "Number", "type": "string" }, "formatted_number": { "title": "Formatted number", "type": "string" }, "country": { "title": "Country", "type": "string" }, "carrier": { "title": "Carrier", "type": "string" }, "type": { "title": "Type", "type": "string" } }, "type": "object" } } } }, "500": { "description": "Incorrect Number", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "numbers:read" ] } ], "x-versions": [ "public" ] } }, "/numbers/get-from-pool": { "get": { "tags": [ "Numbers" ], "summary": "Search for unused numbers in the number pool", "description": "REQUIRED SCOPES ['numbers:read']
Search for unused numbers in the number pool", "operationId": "d99c8f11330c556160bf3852879a5423", "parameters": [ { "name": "state", "in": "query", "description": "State code to search for numbers", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limit the number of results", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "number": { "type": "string" }, "formatted": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" } }, "type": "object" } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "422": { "description": "Validation error" } }, "security": [ { "apiAuth": [ "numbers:read" ] } ], "x-versions": [ "public" ] } }, "/numbers/pft": { "post": { "tags": [ "Numbers" ], "summary": "Save PFT number", "description": "REQUIRED SCOPES ['numbers:write']
Save PFT number", "operationId": "e422630d0ca2a0b75f1b68423d440280", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "pft_number": { "type": "string", "example": "+1234567890" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "pft_number": { "$ref": "#/components/schemas/NumberResource" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "message": { "type": "array", "items": { "type": "string" } }, "is_require_pft_number": { "type": "boolean" }, "is_pft_trial_flow": { "type": "boolean" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "numbers:write" ] } ], "x-versions": [ "public" ] } }, "/numbers/{number}/release": { "delete": { "tags": [ "Numbers" ], "summary": "Release the number", "description": "REQUIRED SCOPES ['numbers:write']
Release the number", "operationId": "76f9d931016a2dbce14337da63e0c57f", "parameters": [ { "name": "number", "in": "path", "description": "The ID of the Number", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "title": "Status", "type": "string" }, "message": { "title": "Message", "type": "string" } }, "type": "object" } } } }, "500": { "description": "Invalid Number", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "numbers:write" ] } ], "x-versions": [ "public" ] } }, "/numbers/search": { "post": { "tags": [ "Numbers" ], "summary": "Search numbers", "description": "REQUIRED SCOPES ['numbers:write']
Search numbers", "operationId": "ad77095783f135ec4c7d6dd89379ea58", "parameters": [ { "name": "country", "in": "query", "description": "Country code (Alpha-2 code)", "required": true, "schema": { "type": "string", "example": "US" } }, { "name": "search", "in": "query", "description": "The string to search for..", "required": true, "schema": { "type": "string" } }, { "name": "toll_free", "in": "query", "description": "Toll free.", "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "description": "Results limit", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "example": 12 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NumberResource" } } } } } }, "security": [ { "apiAuth": [ "numbers:write" ] } ], "x-versions": [ "public" ] } }, "/numbers/shortcodes": { "get": { "tags": [ "Numbers" ], "summary": "Get shortcodes", "description": "REQUIRED SCOPES ['numbers:read']
Get shortcodes", "operationId": "003032df13ebd9bb3a075fe9304cc2ae", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberResource" } } } } }, "security": [ { "apiAuth": [ "numbers:read" ] } ], "x-versions": [ "public" ] } }, "/numbers/{number}/unassign-from-inbox": { "post": { "tags": [ "Numbers" ], "summary": "Unassign the number from the inbox", "description": "REQUIRED SCOPES ['numbers:write']
Unassign the number from the inbox", "operationId": "96ed41e145e4e470b321a449cdf39ca8", "parameters": [ { "name": "number", "in": "path", "description": "The ID of the Number", "required": true, "schema": { "type": "string", "example": "" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "reassign_number_id": { "description": "This parameter is preferred and is used in priority. The ID of reassignable number. Required if property 'reassign' is 'null' or not provided.", "type": "integer", "example": "1" }, "reassign": { "description": "Source type and source id to take number for reassigning, format: '{sourcePath}:{sourceId}'. Possibile values: App\\\\\\Teams\\\\\\Team:{your ID}. Required if 'reassign_number_id' is not provided", "type": "string", "default": null } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberResource" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "reassign_number_id": { "title": "reassign_number_id", "type": "string" }, "number": { "title": "number", "type": "string" } }, "type": "object" } } } }, "500": { "description": "Invalid Number", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "numbers:write" ] } ], "x-versions": [ "public" ] } }, "/numbers/unassigned/create": { "post": { "tags": [ "Numbers" ], "summary": "Create unassigned number", "description": "REQUIRED SCOPES ['numbers:write']
Create unassigned numbers", "operationId": "1f2092a4067f505386db703b71418164", "requestBody": { "content": { "application/json": { "schema": { "required": [ "number" ], "properties": { "number": { "description": "Number", "type": "string", "example": "+20255555555" }, "number_vendor_id": { "description": "Number vendor id. If it`s not provided, then Organization's number vendor id will be used", "type": "integer", "example": null }, "vendor_id": { "description": "Vendor id", "type": "string", "example": null } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberResource" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "stripe": { "title": "stripe", "type": "string" }, "number": { "title": "number", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "numbers:write" ] } ], "x-versions": [ "public" ] } }, "/numbers/unassigned": { "get": { "tags": [ "Numbers" ], "summary": "Get unassigned numbers", "description": "REQUIRED SCOPES ['numbers:read']
Get unassigned numbers", "operationId": "ef7355424dae89b3647640f749a3c24f", "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "numbers:read" ] } ], "x-versions": [ "public" ] } }, "/numbers/vendors": { "get": { "tags": [ "Numbers" ], "summary": "Get numbers vendors", "description": "REQUIRED SCOPES ['numbers:read']
Get numbers vendors", "operationId": "0717e432789215ba0f3100374f88d9be", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NumberVendor" } } } } } }, "security": [ { "apiAuth": [ "numbers:read" ] } ], "x-versions": [ "public" ] } }, "/numbers/vendors/integration": { "get": { "tags": [ "Numbers" ], "summary": "List number vendors", "description": "REQUIRED SCOPES ['numbers:read']
List number vendors", "operationId": "1ed3e8d3f510cc6fc836647023f5c4b6", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "0": { "type": "integer", "property": "id" }, "1": { "type": "integer", "property": "organization_id" }, "2": { "properties": { "key": { "type": "string" }, "name": { "type": "string" } }, "type": "object", "property": "integration" }, "3": { "type": "string", "format": "date-time", "property": "created_at" }, "4": { "type": "string", "format": "date-time", "property": "updated_at" } } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "numbers:read" ] } ], "x-versions": [ "public" ] } }, "/business-hours": { "post": { "tags": [ "Off Hours" ], "summary": "Update business hours", "description": "REQUIRED SCOPES ['off-hours:write']
Update business hours", "operationId": "2eea5771fb196afd5530e4fcd81fd48d", "requestBody": { "content": { "application/json": { "schema": { "properties": { "hourable_id": { "description": "Team ID", "type": "string" }, "hourable_type": { "description": "Type", "type": "string", "example": "App\\Teams\\Team" }, "timezone": { "description": "Timezone", "type": "string" }, "days": { "description": "Days", "type": "array", "items": { "type": "string" }, "example": [ { "day": "sun", "closed": true, "start": "09:00:00", "end": "21:00:00" }, { "day": "mon", "closed": true, "start": "09:00:00", "end": "21:00:00" }, { "day": "tue", "closed": true, "start": "09:00:00", "end": "21:00:00" }, { "day": "wed", "closed": true, "start": "09:00:00", "end": "21:00:00" }, { "day": "thu", "closed": true, "start": "09:00:00", "end": "21:00:00" }, { "day": "fri", "closed": true, "start": "09:00:00", "end": "21:00:00" }, { "day": "sat", "closed": true, "start": "09:00:00", "end": "21:00:00" } ] }, "message": { "description": "Message", "type": "string" }, "is_active": { "description": "Activate", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Not Found" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "off-hours:write" ] } ], "x-versions": [ "public" ] } }, "/agency/invites": { "get": { "tags": [ "Organizations Agency" ], "summary": "Get agency`s invitations", "description": "REQUIRED SCOPES ['organizations-agency:read']
Get agency`s invitations", "operationId": "559136b0f279284417659e2c7892c3d7", "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "organizations-agency:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Organizations Agency" ], "summary": "Create agency's invitation", "description": "REQUIRED SCOPES ['organizations-agency:write']
Create agency's invitation", "operationId": "37ecd76ecfab8860a81a4de9b33674ec", "requestBody": { "content": { "application/json": { "schema": { "required": [ "email", "plan" ], "properties": { "email": { "description": "Email", "type": "string", "format": "email", "example": "test@test.test" }, "plan": { "description": "Plan", "type": "string", "example": "" }, "trial": { "description": "Trial", "type": "boolean", "example": true }, "organization_clone": { "description": "Organization clone", "type": "integer", "example": null, "nullable": true }, "affiliate_link": { "description": "Agency Affiliate Link", "type": "string", "example": "https://www.salesmessage.com/?fp_ref=example", "nullable": true }, "payment_method": { "description": "ID of payment method. It's taken into account when Organization is Franchise", "type": "string", "example": null, "nullable": true }, "pay_now": { "description": "Pay now flag", "type": "boolean", "example": null, "nullable": true }, "card_token": { "description": "Optional field for card token. It's taken into account when 'pay_now' is TRUE", "type": "string", "example": null, "nullable": true }, "first_name": { "description": "First name of customer. It's taken into account when 'pay_now' is TRUE", "type": "string", "example": null, "nullable": true }, "last_name": { "description": "Last name of customer. It's taken into account when 'pay_now' is TRUE", "type": "string", "example": null, "nullable": true }, "integration_teams": { "description": "The IDs of the Teams. It's taken into account when groups flow is allowed.", "type": "array", "items": { "type": "integer" }, "example": null, "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Create Customer Error", "content": { "application/json": { "schema": { "properties": { "message": { "title": "message", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "organizations-agency:write" ] } ], "x-versions": [ "public" ] } }, "/agency/invites/{clientInvitation}/resend": { "post": { "tags": [ "Organizations Agency" ], "summary": "Resend the invitation", "description": "REQUIRED SCOPES ['organizations-agency:write']
Resend the invitation", "operationId": "46e61c30867d79bc689a6940ec573c69", "parameters": [ { "name": "clientInvitation", "in": "path", "description": "The ID of the Client invitation", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "organizations-agency:write" ] } ], "x-versions": [ "public" ] } }, "/agency/invites/{clientInvitation}": { "post": { "tags": [ "Organizations Agency" ], "summary": "Update the invitation", "description": "REQUIRED SCOPES ['organizations-agency:write']
Update the invitation", "operationId": "3bfede6f28507bf1997f70592e796e7d", "parameters": [ { "name": "clientInvitation", "in": "path", "description": "The ID of the Client invitation", "required": true, "schema": { "type": "string", "example": "" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "email" ], "properties": { "email": { "description": "New email for updating", "type": "string", "format": "email", "example": "test@test.test" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "organizations-agency:write" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Organizations Agency" ], "summary": "Delete the invitation", "description": "REQUIRED SCOPES ['organizations-agency:write']
Delete the invitation", "operationId": "7b4da7fcd7f949af70179c44d2c43072", "parameters": [ { "name": "clientInvitation", "in": "path", "description": "The ID of the Client invitation", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "organizations-agency:write" ] } ], "x-versions": [ "public" ] } }, "/agency/invites/validate": { "post": { "tags": [ "Organizations Agency" ], "summary": "Validate email on invitation create", "description": "REQUIRED SCOPES ['organizations-agency:write']
Validate email on invitation create", "operationId": "5445fcdb00612e17c6c757ba012ed820", "requestBody": { "content": { "application/json": { "schema": { "required": [ "email" ], "properties": { "email": { "description": "Email", "type": "string", "format": "email", "example": "test@test.test" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "valid": { "title": "Valid", "type": "boolean" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "organizations-agency:write" ] } ], "x-versions": [ "public" ] } }, "/agency/clients/{client}": { "delete": { "tags": [ "Organizations Agency" ], "summary": "Deletes the client from an agency", "description": "REQUIRED SCOPES ['organizations-agency:write']
Deletes the client from an agency", "operationId": "90e80209084cc7d885d7d9eb95e85184", "parameters": [ { "name": "client", "in": "path", "description": "The ID of the Client", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "organizations-agency:write" ] } ], "x-versions": [ "public" ] } }, "/agency/clients": { "get": { "tags": [ "Organizations Agency" ], "summary": "Get clients", "description": "REQUIRED SCOPES ['organizations-agency:read']
Fetches a list of clients based on specified criteria.", "operationId": "924baa04120ee8284c6978d9b9b8242b", "parameters": [ { "name": "sortBy", "in": "query", "description": "Field to sort by", "required": false, "schema": { "type": "string", "example": "name" } }, { "name": "sortOrder", "in": "query", "description": "Sort order", "required": false, "schema": { "type": "string", "example": "asc" } }, { "name": "all", "in": "query", "description": "Fetch all clients without pagination", "required": false, "schema": { "type": "boolean", "example": false } }, { "name": "search", "in": "query", "description": "Search term", "required": false, "schema": { "type": "string" } }, { "name": "length", "in": "query", "description": "Number of results per page", "required": false, "schema": { "type": "integer", "example": 20 } }, { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "fields_list", "in": "query", "description": "List of specific fields to return", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Successful retrieval of client list", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationLiteResource" } }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationResource" } }, "meta": { "type": "object" }, "links": { "type": "object" } }, "type": "object" } ] } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "organizations-agency:read" ] } ], "x-versions": [ "public" ] } }, "/organization/analytics": { "get": { "tags": [ "Organizations" ], "summary": "Get organization analytics", "description": "REQUIRED SCOPES ['organizations:read']
Get organization analytics", "operationId": "81fe87f3d529276f9620087e38a10cdb", "parameters": [ { "name": "from", "in": "query", "description": "Start date for analytics (format: Y-m-d)", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "End date for analytics (format: Y-m-d)", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "timezone", "in": "query", "description": "Timezone for the dates", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for inbox pagination", "schema": { "type": "integer", "default": 1 } }, { "name": "sort", "in": "query", "description": "Field to sort by", "schema": { "type": "string", "default": "name" } }, { "name": "order", "in": "query", "description": "Sort order (asc or desc)", "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "totals": { "type": "array", "items": { "type": "object" } }, "inboxes": { "type": "object" }, "calls": { "type": "array", "items": { "title": "Call Statistics", "properties": { "date": { "title": "Date", "type": "string" }, "label": { "title": "Label", "type": "string" }, "forwarded": { "title": "Forwarded Count", "type": "integer" }, "inbound": { "title": "Inbound Count", "type": "integer" }, "outbound": { "title": "Outbound Count", "type": "integer" }, "total": { "title": "Total Count", "type": "integer" } }, "type": "object" } } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "organizations:read" ] } ], "x-versions": [ "public" ] } }, "/organization/auto-close-setting": { "post": { "tags": [ "Organizations" ], "summary": "Updates organization's auto close setting", "description": "REQUIRED SCOPES ['organizations:write']
Updates organization's auto close setting", "operationId": "304323e6bb06cb0614e45070be333d18", "requestBody": { "content": { "application/json": { "schema": { "properties": { "auto_close_setting": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK" }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "properties": { "auto_close_setting": { "type": "boolean", "example": "The is auto_close_setting is required." } }, "type": "object" } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/auto-close-days": { "post": { "tags": [ "Organizations" ], "summary": "Updates organization's auto close days", "description": "REQUIRED SCOPES ['organizations:write']
Updates organization's auto close days", "operationId": "ed3375ec390094749190d58d98c198a4", "requestBody": { "content": { "application/json": { "schema": { "properties": { "auto_close_days": { "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK" }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "properties": { "auto_close_days": { "type": "integer", "example": "The is auto_close_days is required." } }, "type": "object" } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/auto-close-unsubscribe": { "post": { "tags": [ "Organizations" ], "summary": "Updates organization's auto close unsubscribe setting", "description": "REQUIRED SCOPES ['organizations:write']
Updates organization's auto close unsubscribe setting", "operationId": "06de160055adbe391cde4a0903068e16", "requestBody": { "content": { "application/json": { "schema": { "properties": { "auto_close_setting": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK" }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "properties": { "auto_close_unsubscribe": { "type": "boolean", "example": "The is auto_close_unsubscribe is required." } }, "type": "object" } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/call-queue-participants/{team?}": { "get": { "tags": [ "Organizations" ], "summary": "Get list of call queue participants", "description": "REQUIRED SCOPES ['organizations:read']
Get list of call queue participants", "operationId": "3eed3b097a389a15a630d6d675b4c10d", "parameters": [ { "name": "team", "in": "path", "description": "ID of the team (optional)", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "description": "Participant ID", "type": "integer" }, "name": { "description": "Participant name", "type": "string" }, "email": { "description": "Participant email", "type": "string" }, "role": { "description": "Participant role", "type": "string" } }, "type": "object" } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Team not found" } }, "security": [ { "apiAuth": [ "organizations:read" ] } ], "x-versions": [ "public" ] } }, "/organization/call-status": { "post": { "tags": [ "Organizations" ], "summary": "Updates organization's calling status", "description": "REQUIRED SCOPES ['organizations:write']
Updates organization's calling status", "operationId": "29ead291d50687ccaca875168e1dbd92", "requestBody": { "content": { "application/json": { "schema": { "properties": { "is_active": { "description": "Is active", "type": "boolean", "default": true }, "is_active_inbound": { "description": "Is active inbound", "type": "boolean", "default": true } }, "type": "object" } } } }, "responses": { "200": { "description": "OK" }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "properties": { "is_active_inbound": { "type": "string", "example": "The is active inbound field is required." } }, "type": "object" } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/conversation-history-settings": { "post": { "tags": [ "Organizations" ], "summary": "Update conversation history settings for the organization", "description": "REQUIRED SCOPES ['organizations:write']
Update conversation history settings for the organization", "operationId": "cb9ce76eea58290d3a0e9f268a491809", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "use_global_conversation_history" ], "properties": { "use_global_conversation_history": { "description": "Whether to use global conversation history", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Settings updated successfully", "content": { "application/json": { "schema": { "properties": { "use_global_conversation_history": { "description": "Updated setting for global conversation history", "type": "boolean" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/current": { "get": { "tags": [ "Organizations" ], "summary": "Get Current Organization", "description": "REQUIRED SCOPES ['organizations:read']
Get Current Organization", "operationId": "Get Current Organization", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "account_balance": { "type": "boolean" }, "account_credits": { "type": "integer" }, "auto_close_days": { "type": "integer" }, "auto_close_setting": { "type": "boolean" }, "auto_close_unsubscribe": { "type": "boolean" }, "auto_assign_contact_owner": { "type": "boolean" }, "use_global_conversation_history": { "type": "boolean" }, "extended_international_texting": { "type": "boolean" }, "broadcast_limits": { "type": "array", "items": { "properties": { "broadcasts_long_code": { "type": "integer" }, "broadcasts_short_code": { "type": "integer" }, "broadcasts_toll_free": { "type": "integer" }, "broadcasts_mobile": { "type": "integer" } }, "type": "object" } }, "clients_plan": { "type": "string" }, "country": { "type": "string" }, "created_at": { "type": "string" }, "custom_fields_list": { "type": "array", "items": { "properties": { "0": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "key": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "type": "integer" }, "type": { "type": "string" }, "visible": { "type": "integer" } }, "type": "object" } } }, "type": "object" } }, "dlc_status": { "type": "string" }, "double_opt_in": { "type": "array", "items": { "properties": { "is_active": { "type": "boolean" } }, "type": "object" } }, "first_promoter_ref_id": { "type": "string" }, "franchise": { "type": "boolean" }, "hasAffiliateLink": { "type": "boolean" }, "hasTwilioNumbers": { "type": "boolean" }, "hash_id": { "type": "string" }, "id": { "type": "integer" }, "is_agency": { "type": "boolean" }, "ivr_greetings": { "type": "array", "items": { "properties": { "0": { "type": "array", "items": { "properties": { "content_type": { "type": "string" }, "created_at": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "organization_id": { "type": "integer" }, "updated_at": { "type": "string" }, "url": { "type": "string" } }, "type": "object" } } }, "type": "object" } }, "name": { "type": "string" }, "settings": { "type": "array", "items": {} }, "trial_credits": { "type": "integer" }, "owner_id": { "type": "integer" }, "trial_ends_at": { "type": "string" }, "two_fa_enabled": { "type": "boolean" }, "voicemail_greetings": { "type": "array", "items": { "properties": { "0": { "type": "array", "items": { "properties": { "content_type": { "type": "string" }, "created_at": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "organization_id": { "type": "integer" }, "updated_at": { "type": "string" }, "url": { "type": "string" } }, "type": "object" } } }, "type": "object" } }, "number_vendor": { "type": "array", "items": { "properties": { "key": { "type": "string" } }, "type": "object" } }, "organization_call": { "type": "array", "items": { "properties": { "is_active": { "type": "boolean" }, "is_active_inbound": { "type": "boolean" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "organizations:read" ] } ], "x-versions": [ "public" ] } }, "/organization/double-opt-in": { "put": { "tags": [ "Organizations" ], "summary": "Updates an organization's double opt in setting", "description": "REQUIRED SCOPES ['organizations:write']
Updates an organization's double opt in setting", "operationId": "8c93a579b74cdc19608ce3758fb1d039", "requestBody": { "content": { "application/json": { "schema": { "properties": { "is_active": { "description": "Is active", "type": "boolean", "default": false } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "id": { "title": "ID", "type": "integer" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "is_active": { "title": "Is active", "type": "boolean" } }, "type": "object" } } } }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "properties": { "is_active": { "type": "string", "example": "The is active field is required." } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/fallback-inbox": { "delete": { "tags": [ "Organizations" ], "summary": "Delete fallback inbox", "description": "REQUIRED SCOPES ['organizations:write']
Delete fallback inbox", "operationId": "673e575eb996f9c93b4e045caa4e8c36", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "organization_id": { "title": "Organization ID", "type": "integer" }, "fallback_team_id": { "title": "Fallback team ID", "type": "integer" } }, "type": "object" } } } }, "500": { "description": "Failed to reset fallback inbox", "content": { "application/json": { "schema": { "properties": { "message": { "title": "message", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/set-fallback-inbox/{team}": { "post": { "tags": [ "Organizations" ], "summary": "Update organization's fallback inbox", "description": "REQUIRED SCOPES ['organizations:write']
Update organization's fallback inbox", "operationId": "5cb717a57bf19a7637b46a71cf053995", "parameters": [ { "name": "team", "in": "path", "description": "The ID of the Team", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "organization_id": { "title": "Organization ID", "type": "integer" }, "fallback_team_id": { "title": "Fallback team ID", "type": "integer" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "fallback_team_id": { "title": "message", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/segments/create": { "post": { "tags": [ "Organizations" ], "summary": "Create filter", "description": "REQUIRED SCOPES ['organizations:write']
Create filter", "operationId": "9dc05af3d49df4b89ad187a2ca450997", "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "type": "string", "example": "Test Segment" }, "is_favorite": { "type": "boolean", "example": "false" }, "filters": { "properties": { "filtersList": { "type": "array", "items": { "properties": { "filters": { "type": "array", "items": { "properties": { "key": { "type": "string", "example": "first_name" }, "operator": { "type": "string", "example": "equals" }, "value": { "type": "string", "example": "test" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "id": { "title": "ID", "type": "integer" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "name": { "title": "Name", "type": "string" }, "is_favorite": { "title": "Is Favorite", "type": "boolean" }, "filters": { "title": "Filters", "type": "array", "items": { "$ref": "#/components/schemas/OrganizationFilter" } } }, "type": "object" } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/segments/{organizationFilter}/update": { "put": { "tags": [ "Organizations" ], "summary": "Update the filter", "description": "REQUIRED SCOPES ['organizations:write']
Update the filter", "operationId": "115850bb273b057c22d1eab6ad4b553c", "parameters": [ { "name": "organizationFilter", "in": "path", "description": "The ID of the Organization filter", "required": true, "schema": { "type": "string", "example": "" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "type": "string", "example": "Test Segment" }, "is_favorite": { "type": "boolean", "example": "false" }, "filters": { "properties": { "filtersList": { "type": "array", "items": { "properties": { "filters": { "type": "array", "items": { "properties": { "key": { "type": "string", "example": "first_name" }, "operator": { "type": "string", "example": "equals" }, "value": { "type": "string", "example": "test" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "id": { "title": "ID", "type": "integer" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "name": { "title": "Name", "type": "string" }, "is_favorite": { "title": "Is Favorite", "type": "boolean" }, "filters": { "title": "Filters", "type": "array", "items": { "$ref": "#/components/schemas/OrganizationFilter" } } }, "type": "object" } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/segments/{organizationFilter}/delete": { "delete": { "tags": [ "Organizations" ], "summary": "Delete the filter", "description": "REQUIRED SCOPES ['organizations:write']
Delete the filter", "operationId": "c334cf50554fce41cee2d05ce2be7b49", "parameters": [ { "name": "organizationFilter", "in": "path", "description": "The ID of the Organization filter", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/segments/search": { "get": { "tags": [ "Organizations" ], "summary": "Search segments", "description": "REQUIRED SCOPES ['organizations:read']
Search segments", "operationId": "e19f767386dfd50b9ea4b69d9cd0aa73", "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "per_page", "in": "query", "description": "Results per page", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "example": 10 } }, { "name": "ids", "in": "query", "description": "Array of IDs", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "include_deleted", "in": "query", "description": "Indicates if soft deleted should be included", "required": false, "schema": { "type": "boolean", "example": "true" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationFilter" } }, "total": { "type": "integer" }, "current_page": { "type": "integer" }, "last_page": { "type": "integer" }, "per_page": { "type": "integer" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "organizations:read" ] } ], "x-versions": [ "public" ] } }, "/organization/invites": { "get": { "tags": [ "Organizations Invitations" ], "summary": "Get organization's invites", "description": "REQUIRED SCOPES ['organizations-invitations:read']
Get organization's invites", "operationId": "884f557ec355752a0fd41b8069a173ef", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "invitations": { "type": "array", "items": { "properties": { "id": { "title": "ID", "type": "string" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "owner_id": { "title": "Owner ID", "type": "integer" }, "user_id": { "title": "User ID", "type": "integer" }, "email": { "title": "Email", "type": "string" }, "team_id": { "title": "Team ID", "type": "integer" }, "number": { "title": "Number", "type": "string" } }, "type": "object" } }, "invitation_requests": { "type": "array", "items": { "properties": { "id": { "title": "ID", "type": "string" }, "$integration": { "title": "Integration", "type": "string" }, "integration_user_id": { "title": "Integration user ID", "type": "integer" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "owner_id": { "title": "Owner ID", "type": "integer" }, "email": { "title": "Email", "type": "string" }, "first_name": { "title": "First name", "type": "string" }, "last_name": { "title": "Last name", "type": "string" }, "request_date": { "title": "Request date", "type": "string" } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "organizations-invitations:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Organizations Invitations" ], "summary": "Create organization's invite", "description": "REQUIRED SCOPES ['organizations-invitations:write']
Create organization's invite", "operationId": "7d976625d84a15a9c4aa3a5b331fd966", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "email": { "title": "Email", "type": "string" }, "role": { "title": "Role", "type": "string" }, "team_id": { "title": "Team ID", "type": "integer", "deprecated": true }, "team_ids": { "title": "Team IDs", "type": "array", "items": { "type": "integer" } }, "use_organization_settings": { "description": "Indicates Use Organization Settings or Not", "type": "boolean", "example": "true" } }, "type": "object" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "title": "ID", "type": "string" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "owner_id": { "title": "Owner ID", "type": "integer" }, "user_id": { "title": "User ID", "type": "integer" }, "email": { "title": "Email", "type": "string" }, "team_id": { "title": "Team ID", "type": "integer" }, "number": { "title": "Number", "type": "string" }, "use_organization_settings": { "description": "Indicates Use Organization Settings or Not", "type": "boolean", "example": "true" } }, "type": "object" } } } } }, "422": { "description": "Payment error from Stripe", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Error messages", "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Error messages", "type": "array", "items": { "type": "string" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "organizations-invitations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/invites/{invitation}/resend": { "post": { "tags": [ "Organizations Invitations" ], "summary": "Resend the invitation", "description": "REQUIRED SCOPES ['organizations-invitations:write']
Resend the invitation", "operationId": "08f8dfe1bd053129744b739136da6bad", "parameters": [ { "name": "invitation", "in": "path", "description": "The ID of the invitation", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "id": { "title": "ID", "type": "string" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "owner_id": { "title": "Owner ID", "type": "integer" }, "user_id": { "title": "User ID", "type": "integer" }, "email": { "title": "Email", "type": "string" }, "team_id": { "title": "Team ID", "type": "integer" }, "number": { "title": "Number", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "organizations-invitations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/invites/{invitation}": { "get": { "tags": [ "Organizations Invitations" ], "summary": "Get details of a specific invitation", "description": "REQUIRED SCOPES ['organizations-invitations:read']
Get details of a specific invitation", "operationId": "15620a5515a029b4e09b6f1e7cdc1511", "parameters": [ { "name": "invitation", "in": "path", "description": "ID of the invitation", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "id": { "description": "Invitation ID", "type": "integer" }, "email": { "description": "Invited user's email", "type": "string" }, "token": { "description": "Invitation token", "type": "string" }, "url": { "description": "Invitation URL", "type": "string" }, "owner_id": { "description": "Owner ID", "type": "integer" }, "organization_id": { "description": "Organization ID", "type": "integer" }, "user_id": { "description": "User ID if accepted", "type": "integer", "nullable": true }, "team_id": { "description": "Team ID if accepted", "type": "integer", "nullable": true }, "profile_id": { "description": "User Profile ID if accepted", "type": "integer", "nullable": true }, "created_at": { "description": "Creation timestamp", "type": "string", "format": "date-time" }, "updated_at": { "description": "Last update timestamp", "type": "string", "format": "date-time" }, "user": { "description": "User details if invitation is accepted", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "email": { "type": "string" }, "profile": { "properties": { "id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" } }, "type": "object" } }, "type": "object", "nullable": true }, "organization": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Invitation not found" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "organizations-invitations:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Organizations Invitations" ], "summary": "Update the invitation", "description": "REQUIRED SCOPES ['organizations-invitations:write']
Update the invitation", "operationId": "e78bff89bbd09a9ec7e008e813b44059", "parameters": [ { "name": "invitation", "in": "path", "description": "The ID of the invitation", "required": true, "schema": { "type": "string", "example": "" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "email": { "description": "Email", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "id": { "title": "ID", "type": "string" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "owner_id": { "title": "Owner ID", "type": "integer" }, "user_id": { "title": "User ID", "type": "integer" }, "email": { "title": "Email", "type": "string" }, "team_id": { "title": "Team ID", "type": "integer" }, "number": { "title": "Number", "type": "string" } }, "type": "object" } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "organizations-invitations:write" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Organizations Invitations" ], "summary": "Delete the invitation", "description": "REQUIRED SCOPES ['organizations-invitations:write']
Delete the invitation", "operationId": "4a800c7ffc9c6be3233a460bf391ae8f", "parameters": [ { "name": "invitation", "in": "path", "description": "The ID of the invitation", "required": true, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "organizations-invitations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/members/{member}": { "put": { "tags": [ "Organizations" ], "summary": "Update the member", "description": "REQUIRED SCOPES ['organizations:write']
Update the member", "operationId": "46b7cf291f2d7c19c57095eaedf10a98", "parameters": [ { "name": "member", "in": "path", "description": "The ID of the member", "required": true, "schema": { "type": "string", "example": "" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "member_id": { "description": "The ID of the Member to Reassign", "type": "integer", "example": 0 }, "remove_seat": { "description": "Is Remove Seat", "type": "integer", "default": 0 }, "role": { "description": "New Member's role", "type": "string", "example": "admin" }, "use_organization_settings": { "description": "Indicates Use Organization Settings or Not", "type": "boolean", "example": "true" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResource" } } } }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "message": { "title": "message", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Organizations" ], "summary": "Delete the member", "description": "REQUIRED SCOPES ['organizations:write']
Delete the member", "operationId": "119a76a91238b647fb2471e8cef73141", "parameters": [ { "name": "member", "in": "path", "description": "The ID of the member", "required": true, "schema": { "type": "string", "example": "" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "confirm": { "description": "Condirm delete action", "type": "boolean", "default": true }, "reassign_contacts_user_id": { "description": "Contact id to reassign contacts", "type": "integer", "example": 1 }, "reassign_teams_user_id": { "description": "Contact id to reassign teams/automations (workflows/textbots/campaigns)", "type": "integer", "example": 1 } }, "type": "object" } } } }, "responses": { "204": { "description": "OK" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "properties": { "reassign_contacts_user_id": { "type": "string", "example": "The selected reassign contacts user id is invalid." } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/members": { "get": { "tags": [ "Organizations" ], "summary": "Get members", "description": "REQUIRED SCOPES ['organizations:read']
Get members", "operationId": "ff990314237b398e23112288c3b4d816", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserResource" } } } } } }, "security": [ { "apiAuth": [ "organizations:read" ] } ], "x-versions": [ "public" ] } }, "/organization/members/logout": { "post": { "tags": [ "Organizations" ], "summary": "Logout organization members", "description": "REQUIRED SCOPES ['organizations:write']
Logout organization members", "operationId": "3aa3f2dd3394a952a83f6a16219cca71", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "all" ], "properties": { "ids": { "description": "IDs of users to logout", "type": "array", "items": { "type": "integer" } }, "all": { "description": "Whether to logout all members", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/update-messaging-canada-only": { "post": { "tags": [ "Organizations" ], "summary": "Update messaging Canada-only setting for the organization", "description": "REQUIRED SCOPES ['organizations:write']
Update messaging Canada-only setting for the organization", "operationId": "e3cdc3cdfe133d99ce2e64b666f8d9e7", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "is_canada_only" ], "properties": { "is_canada_only": { "description": "Whether messaging should be restricted to Canada only", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Setting updated successfully", "content": { "application/json": { "schema": { "properties": { "organization_id": { "description": "ID of the organization", "type": "integer" }, "is_messaging_canada_only": { "description": "Updated Canada-only messaging setting", "type": "boolean" } }, "type": "object" } } } }, "422": { "description": "Validation error or update failed", "content": { "application/json": { "schema": { "properties": { "is_canada_only": { "description": "Error message", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/multiorganizations/list": { "get": { "tags": [ "Organizations" ], "summary": "Get list of organizations for a profile", "description": "REQUIRED SCOPES ['organizations:read']
Get list of organizations for a profile", "operationId": "a84baa11c2740acf09af6157887f67a5", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationResource" } } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "organizations:read" ] } ], "x-versions": [ "public" ] } }, "/users/profile": { "get": { "tags": [ "Users" ], "summary": "Get profile details", "description": "REQUIRED SCOPES ['users:read']
Get profile details", "operationId": "5d97e3cc00c50e8508a7ca2a581afa92", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileResource" } } } }, "404": { "description": "Profile not found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Profile not exist" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "apiAuth": [ "users:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Users" ], "summary": "Update user profile", "description": "REQUIRED SCOPES [‘users:write’]
This API endpoint enables you to update the current user’s specific personal information in the system.

Each contact (user) has 4 fields which can be updated by default:
  • First name
  • Last name
  • Email
  • Phone number

These fields of a user’s profile document with JSON objects are replaced by data that’s included in the request. New keys and their values are added to the profile document.

", "operationId": "Update user profile", "parameters": [ { "name": "first_name", "in": "query", "description": "First name", "required": true, "schema": { "type": "string", "example": "" } }, { "name": "last_name", "in": "query", "description": "Last name", "required": true, "schema": { "type": "string", "example": "" } }, { "name": "email", "in": "query", "description": "Email", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "number", "in": "query", "description": "Number", "required": false, "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResource" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" }, "trace": { "title": "trace", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "users:write" ] } ], "x-versions": [ "public" ] } }, "/organization/number": { "get": { "tags": [ "Organizations" ], "summary": "Get Number", "description": "REQUIRED SCOPES ['organizations:read']
Get Number", "operationId": "Get Number", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "country_calling_code": { "type": "string" }, "disabled": { "type": "boolean" }, "formattedNumber": { "type": "string" }, "formatted_number": { "type": "string" }, "has_profile": { "type": "boolean" }, "voice": { "type": "boolean" }, "voice_outbound": { "type": "boolean" }, "use_organization_call_settings": { "type": "boolean" }, "id": { "type": "integer" }, "is_aircall": { "type": "boolean" }, "is_toll_free": { "type": "boolean" }, "is_transcribe_voice_to_text": { "type": "boolean" }, "is_landline": { "type": "integer" }, "is_zipwhip": { "type": "integer" }, "landline": { "type": "string" }, "mms": { "type": "boolean" }, "national_number": { "type": "string" }, "number": { "type": "string" }, "number_vendor_id": { "type": "integer" }, "organization_id": { "type": "integer" }, "short_code": { "type": "integer" }, "state": { "type": "string" }, "toll_free_verification_sid": { "type": "string" }, "type": { "type": "string" }, "verified_status": { "type": "string" }, "area_code": { "type": "array", "items": { "properties": { "area_code": { "type": "string" }, "country_code": { "type": "string" }, "id": { "type": "integer" }, "state_code": { "type": "string" }, "state_name": { "type": "string" }, "time_zone": { "type": "string" } }, "type": "object" } }, "number_vendor": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "is_active": { "type": "boolean" }, "key": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "organizations:read" ] } ], "x-versions": [ "public" ] } }, "/organization/phone-checker/enable": { "post": { "tags": [ "Organizations" ], "summary": "Enable phone checker", "description": "REQUIRED SCOPES ['organizations:write']
Enable phone checker", "operationId": "b172ed506f84e5d6c5ceb2549247bb96", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "organization_id": { "title": "Organization ID", "type": "integer" }, "is_active": { "title": "Is active", "type": "boolean" }, "enabled_at": { "title": "Enabled at", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/phone-checker/disable": { "post": { "tags": [ "Organizations" ], "summary": "Disable phone checker", "description": "REQUIRED SCOPES ['organizations:write']
Disable phone checker", "operationId": "e4e62bca0b6c8b925eef7c9ba75f5c88", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "organization_id": { "title": "Organization ID", "type": "integer" }, "is_active": { "title": "Is active", "type": "boolean" }, "enabled_at": { "title": "Enabled at", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/profile": { "post": { "tags": [ "Organizations" ], "summary": "Update organization profile", "description": "REQUIRED SCOPES ['organizations:write']
Update organization profile", "operationId": "f37651e9ecf8debbff017a06caae5d90", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name" ], "properties": { "name": { "description": "Organization name to update", "type": "string", "example": "Test Company" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResource" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "name": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/settings": { "get": { "tags": [ "Organizations" ], "summary": "Get organization's settings", "description": "REQUIRED SCOPES ['organizations:read']
Get organization's settings", "operationId": "0016174c50659c9c00dccc4b8173e05b", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "0": { "type": "array", "items": { "properties": { "created_at": { "type": "string" }, "description": { "type": "string" }, "key": { "type": "string" }, "updated_at": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "integer" }, "default_settings": { "type": "array", "items": { "properties": { "active": { "type": "boolean" } }, "type": "object" } }, "settings": { "type": "array", "items": { "properties": { "active": { "type": "boolean" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "organizations:read" ] } ], "x-versions": [ "public" ] }, "patch": { "tags": [ "Organizations" ], "summary": "Update organization's settings", "description": "REQUIRED SCOPES ['organizations:write']
Update organization's settings", "operationId": "e9699ce65549247d9cbe5fc911589f1d", "parameters": [ { "name": "featureKey", "in": "query", "description": "Featured Key", "required": true, "schema": { "type": "string" } }, { "name": "settingsKey", "in": "query", "description": "Settings Key", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Value", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "User ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] } }, "/organization/subscription": { "get": { "tags": [ "Organizations" ], "summary": "Get Subscription", "description": "REQUIRED SCOPES ['organizations:read']
Get Subscription", "operationId": "Get Subscription", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "created_at": { "type": "string" }, "id": { "type": "integer" }, "numbers": { "type": "array", "items": { "properties": { "left": { "type": "integer" }, "total": { "type": "integer" }, "used": { "type": "integer" } }, "type": "object" } }, "period_ends_at": { "type": "string" }, "plan": { "type": "array", "items": { "properties": { "active": { "type": "boolean" }, "additional_credit_amount": { "type": "number", "format": "float" }, "custom": { "type": "boolean" }, "id": { "type": "integer" }, "interval": { "type": "string" }, "meta": { "type": "string" }, "name": { "type": "string" }, "price": { "type": "integer" }, "seats_plan_id": { "type": "string" }, "shared_inboxes_plan_id": { "type": "string" }, "features": { "type": "array", "items": { "properties": { "broadcasts-access": { "type": "boolean" }, "broadcasts-long-code": { "type": "integer" }, "broadcasts-short-code": { "type": "integer" }, "broadcasts-toll-free": { "type": "integer" }, "broadcasts-mobile": { "type": "integer" }, "business-hours-access": { "type": "boolean" }, "canned-messages": { "type": "boolean" }, "integrations-activecampaign": { "type": "boolean" }, "integrations-aircall": { "type": "boolean" }, "integrations-google": { "type": "boolean" }, "integrations-hubspot": { "type": "boolean" }, "integrations-infusionsoft": { "type": "boolean" }, "integrations-intercom": { "type": "boolean" }, "integrations-marketo": { "type": "boolean" }, "integrations-pipedrive": { "type": "boolean" }, "integrations-salesforce": { "type": "boolean" }, "integrations-slack": { "type": "boolean" }, "integrations-zapier": { "type": "boolean" }, "message-receive-mms": { "type": "boolean" }, "message-send-mms": { "type": "boolean" }, "message-send-scheduled": { "type": "boolean" }, "shared-inboxes": { "type": "boolean" }, "tags-access": { "type": "boolean" }, "triggers-access": { "type": "boolean" }, "triggers-short-code": { "type": "boolean" } }, "type": "object" } } }, "type": "object" } }, "dlc_status": { "type": "string" }, "first_promoter_ref_id": { "type": "string" }, "franchise": { "type": "boolean" }, "hasTwilioNumbers": { "type": "boolean" }, "hash_id": { "type": "string" }, "is_agency": { "type": "boolean" }, "ivr_greetings": { "type": "array", "items": { "properties": { "0": { "type": "array", "items": { "properties": { "content_type": { "type": "string" }, "created_at": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "organization_id": { "type": "integer" }, "updated_at": { "type": "string" }, "url": { "type": "string" } }, "type": "object" } } }, "type": "object" } }, "name": { "type": "string" }, "trial_credits": { "type": "integer" }, "owner_id": { "type": "integer" }, "trial_ends_at": { "type": "string" }, "two_fa_enabled": { "type": "boolean" }, "voicemail_greetings": { "type": "array", "items": { "properties": { "0": { "type": "array", "items": { "properties": { "content_type": { "type": "string" }, "created_at": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "organization_id": { "type": "integer" }, "updated_at": { "type": "string" }, "url": { "type": "string" } }, "type": "object" } } }, "type": "object" } }, "number_vendor": { "type": "array", "items": { "properties": { "key": { "type": "string" } }, "type": "object" } }, "organization_call": { "type": "array", "items": { "properties": { "is_active": { "type": "boolean" }, "is_active_inbound": { "type": "boolean" } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "organizations:read" ] } ], "x-versions": [ "public" ] } }, "/organization/permissions/save": { "post": { "tags": [ "Role Permissions" ], "summary": "Save role permissions", "description": "REQUIRED SCOPES ['role-permissions:write']
Save role permissions", "operationId": "28e23dafe0c6e4a4e1fc14d1cca567c6", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "role", "permissions" ], "properties": { "role": { "description": "The role to update permissions for", "type": "string", "example": "member" }, "permissions": { "description": "Array of permission names to assign to the role", "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Role permissions saved successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Role permissions saved successfully" }, "data": { "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "Can't save role permissions! Please contact support." } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "role-permissions:write" ] } ], "x-versions": [ "public" ] } }, "/blacklist/check": { "post": { "tags": [ "Messages" ], "summary": "Check if a message is blacklisted", "description": "REQUIRED SCOPES ['messages:read']", "operationId": "9452d25d574e7d9ac70797e6aec371f1", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "message", "types" ], "properties": { "message": { "description": "The message to check", "type": "string" }, "types": { "description": "Types of blacklist to check against", "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "is_blacklisted": { "description": "Whether the message is blacklisted", "type": "boolean" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "messages:read" ] } ], "x-versions": [ "public" ] } }, "/tags/contact/{contact}/{tag}": { "put": { "tags": [ "Tags" ], "summary": "Add tag for contact", "description": "REQUIRED SCOPES ['tags:write']
Add tag for contact", "operationId": "ee9796ec81058b528a332a3fe6805dae", "parameters": [ { "name": "contact", "in": "path", "description": "The ID of the Contact", "required": true, "schema": { "type": "string" } }, { "name": "tag", "in": "path", "description": "The ID of the Tag", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "type": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Not Found" }, "status": { "type": "integer", "example": 404 } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "This action is unauthorized." }, "status": { "type": "integer", "example": 403 } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "tags:write" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Tags" ], "summary": "Remove tag from contact", "description": "REQUIRED SCOPES ['tags:write']
Remove tag from contact", "operationId": "93df8ba0d45848d8e63820f592d014da", "parameters": [ { "name": "contact", "in": "path", "description": "The ID of the Contact", "required": true, "schema": { "type": "string" } }, { "name": "tag", "in": "path", "description": "The ID of the Tag", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "type": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Not Found" }, "status": { "type": "integer", "example": 404 } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "This action is unauthorized." }, "status": { "type": "integer", "example": 403 } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "tags:write" ] } ], "x-versions": [ "public" ] } }, "/tags": { "get": { "tags": [ "Tags" ], "summary": "Get tags", "description": "REQUIRED SCOPES ['tags:read']
This API endpoint returns all tags that are currently used within the system.

Tags can be sorted by name, label, etc. Additionally, you are allowed to choose a sorting order and the number of results per page, up to 100.", "operationId": "Get tags", "parameters": [ { "name": "sortBy", "in": "query", "description": "Sort by field (name, label, etc)", "required": false, "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sorting order", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "search", "in": "query", "description": "Tag label", "required": false, "schema": { "type": "string" } }, { "name": "exclude[]", "in": "query", "description": "The IDs of the Tags to exclude from searching", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "ids[]", "in": "query", "description": "The IDs of the Tags to include", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "length", "in": "query", "description": "Results per page", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "example": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "title": "Tags List", "type": "array", "items": { "$ref": "#/components/schemas/TagResource" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "tags:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Tags" ], "summary": "Create tag", "description": "REQUIRED SCOPES ['tags:write']
Through this API endpoint, you can create and add a new tag label in the repository to the ones that already exist.

As a result, each user in the system can now narrow down the search among their contacts and individualize messages.

On creating, up to 15 characters are allowed for each tag label.", "operationId": "Create tag", "parameters": [ { "name": "label", "in": "query", "description": "Tag label", "required": true, "schema": { "type": "string", "maxLength": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResource" } } } } }, "security": [ { "apiAuth": [ "tags:write" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Tags" ], "summary": "Bulk delete tags", "description": "REQUIRED SCOPES ['tags:write']
Bulk delete tags", "operationId": "52b6fe688adcf80cf63f0819de417f22", "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "description": "The IDs of the Tags", "type": "array", "items": { "type": "integer", "example": 1 } }, "delete_all": { "description": "Delete All", "type": "boolean", "example": false } }, "type": "object" } } } }, "responses": { "204": { "description": "Response" }, "404": { "description": "Organization not found", "content": { "application/json": { "schema": { "properties": { "message": { "title": "message", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "tags:write" ] } ], "x-versions": [ "public" ] } }, "/tags/contact/{contact}/create": { "post": { "tags": [ "Tags" ], "summary": "Create tag for contact", "description": "REQUIRED SCOPES ['tags:write']
Create tag for contact", "operationId": "04d5ea8af060e6681952ce359ffc78be", "parameters": [ { "name": "contact", "in": "path", "description": "The ID of the Contact", "required": true, "schema": { "type": "integer" } }, { "name": "label", "in": "query", "description": "Tag label", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResource" } } } } }, "security": [ { "apiAuth": [ "tags:write" ] } ], "x-versions": [ "public" ] } }, "/tags/{tag}": { "get": { "tags": [ "Tags" ], "summary": "Get tag", "description": "REQUIRED SCOPES ['tags:read']
Get tag", "operationId": "d3bc713cbde6dd815c3564d836a94aae", "parameters": [ { "name": "tag", "in": "path", "description": "The ID of the Tag", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResource" } } } } }, "security": [ { "apiAuth": [ "tags:read" ] } ], "x-versions": [ "public" ] }, "put": { "tags": [ "Tags" ], "summary": "Update tag", "description": "REQUIRED SCOPES ['tags:write']
This API request allows for modifying data for a specific tag by tag id. You can update tag label with any text up to 15 characters.

The endpoint updates a tag based on the data properties provided in the request body.", "operationId": "Update tag", "parameters": [ { "name": "tag", "in": "path", "description": "Tag id", "required": true, "schema": { "type": "integer" } }, { "name": "label", "in": "query", "description": "Tag label", "required": true, "schema": { "type": "string", "maxLength": 50, "uniqueItems": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResource" } } } } }, "security": [ { "apiAuth": [ "tags:write" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Tags" ], "summary": "Delete a tag", "description": "REQUIRED SCOPES ['tags:write']
This API endpoint deletes a tag of a repository.

As a result, through this API endpoint, any identified tag will automatically be removed from all the contacts who had it applied to them. The request deletes a tag by id with the corresponding values.", "operationId": "Delete a tag", "parameters": [ { "name": "tag", "in": "path", "description": "Tag id", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } }, "404": { "description": "Organization not found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Not Found" }, "status": { "type": "integer", "example": 404 } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "tags:write" ] } ], "x-versions": [ "public" ] } }, "/tags/paginated": { "get": { "tags": [ "Tags" ], "summary": "Get tags paginated", "description": "REQUIRED SCOPES ['tags:read']
This API endpoint returns all tags that are currently used within the system.

Tags can be sorted by name, label, etc. Additionally, you are allowed to choose a sorting order and the number of results per page, up to 100.", "operationId": "Get tags paginated", "parameters": [ { "name": "sortBy", "in": "query", "description": "Sort by field (name, label, etc)", "required": false, "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sorting order", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "search", "in": "query", "description": "Tag label", "required": false, "schema": { "type": "string" } }, { "name": "exclude[]", "in": "query", "description": "The IDs of the Tags to exclude from searching", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "ids[]", "in": "query", "description": "The IDs of the Tags to include", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "length", "in": "query", "description": "Results per page", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "example": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "title": "Tags List", "type": "array", "items": { "$ref": "#/components/schemas/TagResource" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "tags:read" ] } ], "x-versions": [ "public" ] } }, "/tags/search": { "get": { "tags": [ "Tags" ], "summary": "Search tags", "description": "REQUIRED SCOPES ['tags:read']
Search tags", "operationId": "3291e76c6bb950e7c9fcec72b4b6cff3", "parameters": [ { "name": "term", "in": "query", "description": "Term", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "description": "Per Page", "required": true, "schema": { "type": "integer", "default": 50 } }, { "name": "page", "in": "query", "description": "Page", "required": true, "schema": { "type": "integer", "default": 1 } }, { "name": "exclude[]", "in": "query", "description": "The IDs of the Tags", "schema": { "type": "array", "items": { "type": "integer" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/TagResource" } }, "total": { "type": "integer" }, "errors": { "type": "boolean" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "tags:read" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/assigment-settings": { "get": { "tags": [ "Teams" ], "summary": "Get assignment settings for a team", "description": "REQUIRED SCOPES ['teams:read']
Get assignment settings for a team", "operationId": "95e5e8dc139a69fe1eb472d44e3a5fc6", "parameters": [ { "name": "team", "in": "path", "description": "ID of the team", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "manual": { "properties": { "enabled": { "type": "boolean" }, "default_user_id": { "type": "integer" }, "smart_assignment_enabled": { "type": "boolean" }, "smart_assignment_positive": { "type": "integer" }, "smart_assignment_neutral": { "type": "integer" }, "smart_assignment_negative": { "type": "integer" } }, "type": "object" }, "round_robin": { "properties": { "enabled": { "type": "boolean" }, "users": { "type": "array", "items": { "type": "integer" } } }, "type": "object" }, "hubspot_assignment": { "properties": { "enabled": { "type": "boolean" }, "integration": { "type": "boolean" }, "integration_assignment_field": { "type": "string" }, "integration_assignment_field_deleted": { "type": "boolean" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Team not found" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "teams:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Teams" ], "summary": "Update assignment settings for a team", "description": "REQUIRED SCOPES ['teams:write']
Update assignment settings for a team", "operationId": "dcbd2b2b4edff52c03312b58a2a1874c", "parameters": [ { "name": "team", "in": "path", "description": "ID of the team", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "manual": { "properties": { "default_user_id": { "type": "integer" }, "enabled": { "type": "boolean" }, "smart_assignment_enabled": { "type": "boolean" }, "smart_assignment_positive": { "type": "integer" }, "smart_assignment_neutral": { "type": "integer" }, "smart_assignment_negative": { "type": "integer" } }, "type": "object" }, "round_robin": { "properties": { "enabled": { "type": "boolean" }, "users": { "type": "array", "items": { "type": "integer" } } }, "type": "object" }, "hubspot_assignment": { "properties": { "enabled": { "type": "boolean" }, "integration_assignment_field": { "type": "string" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "manual": { "properties": { "enabled": { "type": "boolean" }, "default_user_id": { "type": "integer" }, "smart_assignment_enabled": { "type": "boolean" }, "smart_assignment_positive": { "type": "integer" }, "smart_assignment_neutral": { "type": "integer" }, "smart_assignment_negative": { "type": "integer" } }, "type": "object" }, "round_robin": { "properties": { "enabled": { "type": "boolean" }, "users": { "type": "array", "items": { "type": "integer" } } }, "type": "object" }, "hubspot_assignment": { "properties": { "enabled": { "type": "boolean" }, "integration": { "type": "boolean" }, "integration_assignment_field": { "type": "string" }, "integration_assignment_field_deleted": { "type": "boolean" } }, "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "404": { "description": "Team not found" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/assigment-settings/hubspot-fields": { "get": { "tags": [ "Teams" ], "summary": "Get HubSpot contact fields for assignment", "description": "REQUIRED SCOPES ['teams:read']
Get HubSpot contact fields for assignment", "operationId": "610b3d8ee5658ab2f9f741e9a4fb6fb4", "parameters": [ { "name": "cash_ignore", "in": "query", "description": "Whether to ignore cache", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "name": { "type": "string" }, "label": { "type": "string" } }, "type": "object" } } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "422": { "description": "Validation error" } }, "security": [ { "apiAuth": [ "teams:read" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/queue/{callSid}": { "get": { "tags": [ "Teams" ], "summary": "Get a call queue participant and initiate a call", "description": "REQUIRED SCOPES ['teams:read']
Get a call queue participant and initiate a call", "operationId": "14273bd7a932c6c6e385310044aa2acd", "parameters": [ { "name": "team", "in": "path", "description": "ID of the team", "required": true, "schema": { "type": "integer" } }, { "name": "callSid", "in": "path", "description": "Twilio Call SID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Call not found or already finished", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "Call not found or already finished." } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "Error message" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "teams:read" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/change-owner": { "put": { "tags": [ "Teams" ], "summary": "Change owner", "description": "REQUIRED SCOPES ['teams:write']
Change owner", "operationId": "af61df478af01e9ce1473a8fdf26230b", "parameters": [ { "name": "team", "in": "path", "description": "Team", "required": true, "schema": { "type": "number" } }, { "name": "owner_id", "in": "query", "description": "Member ID", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserResource" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "owner_id": { "title": "owner_id", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/color-coding": { "put": { "tags": [ "Teams" ], "summary": "Toggle color-coding", "description": "REQUIRED SCOPES ['teams:write']
Toggle color-coding", "operationId": "d55bc067b644db76fa2409f00dfe04ac", "parameters": [ { "name": "enabled", "in": "query", "required": true, "schema": { "type": "boolen" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "enabled": { "type": "boolen", "example": true } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamResource" } } } } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/conversation-history-settings": { "post": { "tags": [ "Teams" ], "summary": "Update conversation history settings for a team", "description": "REQUIRED SCOPES ['teams:write']
Update conversation history settings for a team", "operationId": "6a9f2d83b3f5dba2f836db6b2f4a866d", "parameters": [ { "name": "team", "in": "path", "description": "ID of the team", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "use_global_conversation_history": { "type": "boolean" }, "use_conversation_history": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "use_global_conversation_history": { "type": "boolean" }, "use_conversation_history": { "type": "boolean" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "404": { "description": "Team not found" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams": { "get": { "tags": [ "Teams" ], "summary": "Get teams (inboxes)", "description": "REQUIRED SCOPES ['teams:read']
Allows for obtaining information about teams. The API endpoint returns a list of all the teams with their properties and metadata, such as Team id, Organization, Owner, User names, Team initiation date, and the others. Find them below.", "operationId": "Get teams (inboxes)", "parameters": [ { "name": "limit", "in": "query", "description": "Results limit", "required": false, "schema": { "type": "integer" } }, { "name": "has_membership", "in": "query", "description": "Show only those teams where current user is added as member", "required": false, "schema": { "type": "boolean" } }, { "name": "exclude_unverified", "in": "query", "description": "Exclude unverified toll-free numbers: unverified, declined, blocked", "required": false, "schema": { "type": "boolean" } }, { "name": "exclude_deprioritized", "in": "query", "description": "Exclude deprioritized numbers for Smart Inboxes", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TeamResource" } } } } } }, "security": [ { "apiAuth": [ "teams:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Teams" ], "summary": "Create team", "description": "REQUIRED SCOPES ['teams:write']
Create team", "operationId": "2b0240e28750a72777ce9661e0b93bd9", "parameters": [ { "name": "number", "in": "query", "description": "Number", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name", "required": true, "schema": { "type": "string" } }, { "name": "number_vendor_id", "in": "query", "description": "Number Vendor ID", "required": true, "schema": { "type": "number" } }, { "name": "members[]", "in": "query", "description": "Member IDs", "required": true, "schema": { "type": "array", "items": { "type": "number" } } }, { "name": "vendor_id", "in": "query", "description": "Vendor ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamResource" } } } }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "number": { "title": "number", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/unassigned": { "post": { "tags": [ "Teams" ], "summary": "Create team (unassigned)", "description": "REQUIRED SCOPES ['teams:write']
Create team (unassigned)", "operationId": "d4005fbbb0e901829474a7db0813ed76", "parameters": [ { "name": "name", "in": "query", "description": "Name", "required": true, "schema": { "type": "string" } }, { "name": "numberIds[]", "in": "query", "description": "Number IDs", "required": true, "schema": { "type": "array", "items": { "type": "number" } } }, { "name": "vendor_id", "in": "query", "description": "Vendor ID", "required": false, "schema": { "type": "string" } }, { "name": "members[]", "in": "query", "description": "Member IDs", "required": false, "schema": { "type": "array", "items": { "type": "number" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamResource" } } } }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "stipe": { "title": "stipe", "type": "string" }, "number": { "title": "number", "type": "string" } }, "type": "object" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "properties": { "owner": { "title": "owner", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/default-assignee": { "get": { "tags": [ "Teams" ], "summary": "Show default assignee", "description": "REQUIRED SCOPES ['teams:read']
Show default assignee", "operationId": "ccb80f61709bf35e690637eaf6bf1854", "parameters": [ { "name": "team", "in": "path", "description": "Team ID", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResource" } } } } }, "security": [ { "apiAuth": [ "teams:read" ] } ], "x-versions": [ "public" ] }, "put": { "tags": [ "Teams" ], "summary": "Update default assignee", "description": "REQUIRED SCOPES ['teams:write']
Update default assignee", "operationId": "1d2bc4f848c88c56968f806a8a0c40eb", "parameters": [ { "name": "team", "in": "path", "description": "Team ID", "required": true, "schema": { "type": "number" } }, { "name": "user_id", "in": "query", "description": "Member ID", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamResource" } } } }, "404": { "description": "Not Found" }, "403": { "description": "Unautorized", "content": { "application/json": { "schema": { "properties": { "message": { "title": "This action is unauthorized.", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}": { "get": { "tags": [ "Teams" ], "summary": "Get team", "description": "REQUIRED SCOPES ['teams:read']
Get team", "operationId": "2734f352bcfedae609c0ad76701c401a", "parameters": [ { "name": "team", "in": "path", "description": "Team ID", "required": true, "schema": { "type": "number" } }, { "name": "include_sending_options", "in": "query", "description": "Indicates if we need to calculate and include sending options", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamResource" } } } } }, "security": [ { "apiAuth": [ "teams:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Teams" ], "summary": "Update team", "description": "REQUIRED SCOPES ['teams:write']
Update team", "operationId": "aaa57535d595134c083f72c03c09dc62", "parameters": [ { "name": "team", "in": "path", "description": "Team ID", "required": true, "schema": { "type": "number" } }, { "name": "name", "in": "query", "description": "Name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamResource" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "number": { "title": "number", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Teams" ], "summary": "Delete team", "description": "REQUIRED SCOPES ['teams:write']
Delete team", "operationId": "45e39d8fd598d0b2866990fe3e47b4d2", "parameters": [ { "name": "team", "in": "path", "description": "Team ID", "required": true, "schema": { "type": "number" } }, { "name": "reassign", "in": "query", "description": "Re-Assign Team ID", "required": true, "schema": { "type": "string", "example": "App\\Teams\\Team:0" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResource" } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/favorite": { "post": { "tags": [ "Teams" ], "summary": "Mark or unmark an inbox as favorite", "description": "REQUIRED SCOPES ['teams:write']
Mark or unmark an inbox as favorite", "operationId": "e7d408880264e9ec0dbf34e3345c407a", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "inbox_id", "inbox_type", "favorite" ], "properties": { "inbox_type": { "description": "Type of the inbox", "type": "string" }, "inbox_id": { "description": "ID of the inbox", "type": "integer" }, "favorite": { "description": "Whether to mark as favorite or not", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "type": { "type": "string", "example": "status" }, "message": { "type": "string", "example": "Successfully updated." } }, "type": "object" } } } }, "404": { "description": "Inbox not found" }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/geo-match": { "put": { "tags": [ "Teams" ], "summary": "Toggle geo-match", "description": "REQUIRED SCOPES ['teams:write']
Toggle geo-match", "operationId": "92c4b7efba233adc08ea1743071f93c1", "parameters": [ { "name": "team", "in": "path", "description": "Team ID", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamResource" } } } } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/hubspot": { "put": { "tags": [ "Teams" ], "summary": "Toggle hubspot", "description": "REQUIRED SCOPES ['teams:write']
Toggle hubspot", "operationId": "e13baa813c5cb09165d936ff0f1cbfd1", "parameters": [ { "name": "team", "in": "path", "description": "Team ID", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamResource" } } } } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/personal": { "get": { "tags": [ "Teams" ], "summary": "Get personal teams (inboxes)", "description": "REQUIRED SCOPES ['teams:read']
Get personal teams (inboxes)", "operationId": "Get personal teams (inboxes)", "parameters": [ { "name": "withUnified", "in": "query", "description": "With Unified", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TeamResource" } } } } } }, "security": [ { "apiAuth": [ "teams:read" ] } ], "x-versions": [ "public" ] } }, "/teams/all": { "get": { "tags": [ "Teams" ], "summary": "Get all teams (inboxes)", "description": "REQUIRED SCOPES ['teams:read']
Get all teams (inboxes)", "operationId": "Get all teams (inboxes)", "parameters": [ { "name": "limit", "in": "query", "description": "Results limit", "required": false, "schema": { "type": "integer" } }, { "name": "has_membership", "in": "query", "description": "Show only those teams where current user is added as member", "required": false, "schema": { "type": "boolean" } }, { "name": "exclude_unverified", "in": "query", "description": "Exclude unverified toll-free numbers: unverified, declined, blocked", "required": false, "schema": { "type": "boolean" } }, { "name": "exclude_deprioritized", "in": "query", "description": "Exclude deprioritized numbers for Smart Inboxes", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TeamResource" } } } } } }, "security": [ { "apiAuth": [ "teams:read" ] } ], "x-versions": [ "public" ] } }, "/teams/sorted": { "get": { "tags": [ "Teams" ], "summary": "Get sorted teams (inboxes)", "description": "REQUIRED SCOPES ['teams:read']
Get sorted teams (inboxes)", "operationId": "Get sorted teams (inboxes)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TeamResource" } }, "sort_data": { "type": "array", "items": { "properties": { "": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "teams:read" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/make-default": { "post": { "tags": [ "Teams" ], "summary": "Make default for current user", "description": "REQUIRED SCOPES ['teams:write']
Make default for current user", "operationId": "a114181a161b2fadf964fbab02ec33d2", "parameters": [ { "name": "team", "in": "path", "description": "Team ID", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResource" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "team": { "title": "team", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/make-default-for/{member}": { "post": { "tags": [ "Teams" ], "summary": "Make default for member", "description": "REQUIRED SCOPES ['teams:write']
Make default for member", "operationId": "14a4875384f1c4c3cbbeb38cf6e9384e", "parameters": [ { "name": "team", "in": "path", "description": "Team ID", "required": true, "schema": { "type": "number" } }, { "name": "member", "in": "path", "description": "Member ID", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResource" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "team": { "title": "team", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/members": { "get": { "tags": [ "Teams" ], "summary": "Get team members", "description": "REQUIRED SCOPES ['teams:read']
Returnes a list of all the members within a particular team. This API endpoint also allows for filtering team members before fetching by user's first name or last name.", "operationId": "Get team members", "parameters": [ { "name": "team", "in": "path", "description": "Team", "required": true, "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Filter by user's first_name or last_name", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limit", "required": false, "schema": { "type": "integer", "example": "" } }, { "name": "offset", "in": "query", "description": "Offset", "required": false, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/UserResource" }, { "properties": { "team_role": { "type": "string", "example": "member" }, "user_role": { "type": "string", "example": "admin" }, "has_inbox_access_request": { "type": "boolean", "example": false }, "has_change_role_request": { "type": "boolean", "example": false }, "member_teams_count": { "type": "integer", "example": 3 }, "calling_enabled": { "type": "boolean", "example": true }, "cannot_remove": { "description": "Array of inbox IDs where user cannot be removed due to settings conflicts", "type": "array", "items": { "type": "integer", "example": 100015945 } } }, "type": "object" } ] } } } } } }, "security": [ { "apiAuth": [ "teams:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Teams" ], "summary": "Add team members", "description": "REQUIRED SCOPES ['teams:write']
This request adds a user object as a team member to a particular team by user id. Additionally, the API is used to define team member roles in the team.", "operationId": "Add team members", "parameters": [ { "name": "team", "in": "path", "description": "Team id", "required": true, "schema": { "type": "integer", "example": "1" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "members": { "description": "The IDs of the Members", "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserResource" } } } } }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "members": { "type": "string", "example": "The members field is required." } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/members/{member}": { "delete": { "tags": [ "Teams" ], "summary": "Remove team members", "description": "REQUIRED SCOPES [‘teams:write’]
This request removes information about a particular team member, specified by a member’s id, from the team, specified by team id.

The result is – the user no more can see the team they were a part of.", "operationId": "Remove team members", "parameters": [ { "name": "team", "in": "path", "description": "Team", "required": true, "schema": { "type": "integer" } }, { "name": "member", "in": "path", "description": "Member", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserResource" } } } } }, "409": { "description": "Conflict - User cannot be removed due to team settings configuration", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Cannot remove user from team. User is configured in team settings." }, "conflicts": { "type": "array", "items": { "properties": { "type": { "type": "string", "example": "ring_group" }, "message": { "type": "string", "example": "User is configured in Ring Group settings" }, "endpoint": { "type": "string", "example": "POST core/voice/settings/members/100015945" } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/members/search": { "get": { "tags": [ "Teams" ], "summary": "Search team members", "description": "REQUIRED SCOPES ['teams:read']
This API endpoint allows for searching team members (excluding current user) by
  • First name
  • Last name
  • Their email
  • Their number

This request fetches and returns a specific list for members that match the specified query terms.

", "operationId": "Search team members", "parameters": [ { "name": "team", "in": "path", "description": "Team", "required": true, "schema": { "type": "integer" } }, { "name": "term", "in": "query", "description": "Search user by first_name, last_name, email, number)", "required": true, "schema": { "type": "string" } }, { "name": "assigned", "in": "query", "description": "Member's user id is not equal", "required": true, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "Limit", "required": false, "schema": { "type": "integer", "example": "" } }, { "name": "offset", "in": "query", "description": "Offset", "required": false, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserResource" } } } } } }, "security": [ { "apiAuth": [ "teams:read" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/mute": { "post": { "tags": [ "Teams" ], "summary": "Mute or unmute a team for the authenticated user", "description": "REQUIRED SCOPES ['teams:write']
Mute or unmute a team for the authenticated user", "operationId": "d09e00905775599be1bfe2233ffbc39b", "parameters": [ { "name": "team", "in": "path", "description": "ID of the team", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "is_muted": { "description": "True to mute, false to unmute", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "success" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "404": { "description": "Team not found" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/numbers": { "get": { "tags": [ "Teams" ], "summary": "Get team numbers", "description": "REQUIRED SCOPES ['teams:read']
Get team numbers", "operationId": "ea4890cccbf0de7d48e7af2c5cf79108", "parameters": [ { "name": "team", "in": "path", "description": "Team ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberResource" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "teams:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Teams" ], "summary": "Add a new number to a team", "description": "REQUIRED SCOPES ['teams:write']
Add a new number to a team", "operationId": "d3e3c374a74123fe5932fd444e282b95", "parameters": [ { "name": "team", "in": "path", "description": "ID of the team", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "number": { "description": "The phone number to add", "type": "string" }, "number_vendor_id": { "description": "The vendor ID of the number", "type": "string" }, "vendor_id": { "description": "The vendor ID", "type": "string" }, "is_mobile": { "description": "Whether this is a mobile number (required for GB mobile numbers)", "type": "boolean", "example": false } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NumberResource" } } } } }, "422": { "description": "Validation error or payment failure", "content": { "application/json": { "schema": { "properties": { "stripe": { "type": "array", "items": { "type": "string" } }, "number": { "type": "string" } }, "type": "object" } } } }, "404": { "description": "Team not found" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/round-robin": { "put": { "tags": [ "Teams" ], "summary": "Toggle team round robin", "description": "REQUIRED SCOPES ['teams:write']
Toggle team round robin", "operationId": "3c24abd1ff90368824431efe9242bcf4", "parameters": [ { "name": "team", "in": "path", "description": "Team ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamResource" } } } } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/round-robin/users": { "get": { "tags": [ "Teams" ], "summary": "Get round robin users and status for a team", "description": "REQUIRED SCOPES ['teams:read']
Get round robin users and status for a team", "operationId": "fc1ebb199ae0dd04218a046954b5c173", "parameters": [ { "name": "team", "in": "path", "description": "ID of the team", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "users": { "description": "List of round robin users", "type": "array", "items": { "properties": { "id": { "description": "User ID", "type": "integer" }, "name": { "description": "User name", "type": "string" } }, "type": "object" } }, "status": { "description": "Whether round robin is enabled for the team", "type": "boolean" } }, "type": "object" } } } }, "404": { "description": "Team not found" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "teams:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Teams" ], "summary": "Update round robin users for a team", "description": "REQUIRED SCOPES ['teams:write']
Update round robin users for a team", "operationId": "46db959e8c5f0763a036574e6b8e75c5", "parameters": [ { "name": "team", "in": "path", "description": "ID of the team", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "users" ], "properties": { "users": { "description": "Array of user IDs to be included in round robin", "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamResource" } } } }, "422": { "description": "Validation error" }, "404": { "description": "Team not found" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/search": { "get": { "tags": [ "Teams" ], "summary": "Search teams", "description": "REQUIRED SCOPES ['teams:read']
Search teams", "operationId": "fa8a829f1c36224e5e7a56d3fd53ee94", "parameters": [ { "name": "per_page", "in": "query", "description": "The maximum number of teams that you want returned from this call.", "schema": { "type": "integer", "default": 50 } }, { "name": "page", "in": "query", "description": "Page", "schema": { "type": "integer", "default": 1 } }, { "name": "term", "in": "query", "description": "The string to search for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TeamResource" } } } } } }, "security": [ { "apiAuth": [ "teams:read" ] } ], "x-versions": [ "public" ] } }, "/teams/sort": { "get": { "tags": [ "Teams" ], "summary": "Get user's team sort preferences", "description": "REQUIRED SCOPES ['teams:read']
Get user's team sort preferences", "operationId": "7ca8c6f3d67a19a9676526f11edbdd95", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "sort": { "description": "User's team sort preferences", "type": "array", "items": { "properties": { "id": { "description": "Team ID", "type": "integer" }, "order": { "description": "Sort order", "type": "integer" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "apiAuth": [ "teams:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Teams" ], "summary": "Update user's team sort preferences", "description": "REQUIRED SCOPES ['teams:write']
Update user's team sort preferences", "operationId": "06f960f894f41313e6a5eabc7c5c1964", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "sort" ], "properties": { "sort": { "description": "Array of team IDs in the desired order", "type": "array", "items": { "properties": { "id": { "description": "Team ID", "type": "integer" }, "type": { "description": "Sort order", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "sort": { "description": "Updated team sort preferences", "type": "array", "items": { "properties": { "id": { "description": "Team ID", "type": "integer" }, "order": { "description": "Sort order", "type": "integer" } }, "type": "object" } } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/groups/create": { "post": { "tags": [ "Teams" ], "summary": "Create team group", "description": "REQUIRED SCOPES ['teams:write']
Create team group", "operationId": "9c9227a0cdd48688a9f52e1dbc7199fb", "parameters": [ { "name": "name", "in": "query", "description": "Name", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Description", "required": true, "schema": { "type": "string" } }, { "name": "team_ids[]", "in": "query", "description": "Team IDs", "required": true, "schema": { "type": "array", "items": { "type": "number" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamsGroupResource" } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/groups/{teamsGroup}": { "get": { "tags": [ "Teams" ], "summary": "Get teams groups", "description": "REQUIRED SCOPES ['teams:read']
Get teams groups", "operationId": "c33b18fa85be3cad5970c1dbbb7a3578", "parameters": [ { "name": "teamsGroup", "in": "path", "description": "Teams Group ID", "required": true, "schema": { "type": "integer", "example": "1" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamsGroupResource" } } } } }, "security": [ { "apiAuth": [ "teams:read" ] } ], "x-versions": [ "public" ] }, "put": { "tags": [ "Teams" ], "summary": "Update team group", "description": "REQUIRED SCOPES ['teams:write']
Update team group", "operationId": "bda927e35155cf2849c287161e5b2414", "parameters": [ { "name": "teamsGroup", "in": "path", "description": "Teams Group ID", "required": true, "schema": { "type": "number" } }, { "name": "name", "in": "query", "description": "Name", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Description", "required": true, "schema": { "type": "string" } }, { "name": "teamIds[]", "in": "query", "description": "Team IDs", "required": true, "schema": { "type": "array", "items": { "type": "number" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamsGroupResource" } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Teams" ], "summary": "Delete team group", "description": "REQUIRED SCOPES ['teams:write']
Delete team group", "operationId": "d253bbde37ec5ad186eb5c3e8dd693dd", "parameters": [ { "name": "teamsGroup", "in": "path", "description": "Teams Group ID", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "title": "status", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/groups/list": { "get": { "tags": [ "Teams" ], "summary": "Get team groups", "description": "REQUIRED SCOPES ['teams:read']
Get team groups", "operationId": "eb1bd176a6e61a6eb3eb88471c122d23", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TeamsGroupResource" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "teams:read" ] } ], "x-versions": [ "public" ] } }, "/teams/groups/personal": { "get": { "tags": [ "Teams" ], "summary": "Get personal team groups", "description": "REQUIRED SCOPES ['teams:read']
Get personal team groups", "operationId": "cb69d6ec4124d454fe15db530a0a813d", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TeamsGroupResource" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "teams:read" ] } ], "x-versions": [ "public" ] } }, "/teams/groups/{teamsGroup}/add-teams": { "post": { "tags": [ "Teams" ], "summary": "Add teams to team group", "description": "REQUIRED SCOPES ['teams:write']
Add teams to team group", "operationId": "28c1cf87d955e7260621599d1ffba82a", "parameters": [ { "name": "teamsGroup", "in": "path", "description": "Teams Group ID", "required": true, "schema": { "type": "number" } }, { "name": "teamIds", "in": "query", "description": "Team IDs", "required": true, "schema": { "type": "array", "items": { "type": "number" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "title": "status", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/groups/move-team": { "post": { "tags": [ "Teams" ], "summary": "Move team", "description": "REQUIRED SCOPES ['teams:write']
Move team", "operationId": "51012ce5c5970a4436929cab93639b14", "requestBody": { "content": { "application/json": { "schema": { "properties": { "team_id": { "type": "integer" }, "from_group_id": { "type": "integer" }, "to_group_id": { "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "title": "status", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/groups/{teamsGroup}/remove-team/{team}": { "delete": { "tags": [ "Teams" ], "summary": "Remove team from team group", "description": "REQUIRED SCOPES ['teams:write']
Remove team from team group", "operationId": "a9babbe10141969be6457d7edf74d88b", "parameters": [ { "name": "teamsGroup", "in": "path", "description": "Teams Group ID", "required": true, "schema": { "type": "number" } }, { "name": "team", "in": "path", "description": "Team ID", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "title": "status", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/update-emails-to-sms": { "put": { "tags": [ "Teams" ], "summary": "Update email to SMS settings for multiple teams", "description": "REQUIRED SCOPES ['teams:write']
Update email to SMS settings for multiple teams", "operationId": "a7e297546c56ff519cb0a63db3475dc8", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "items": { "description": "Items to update", "type": "array", "items": { "properties": { "email": { "description": "Email", "type": "string" }, "team_ids": { "description": "IDs of teams", "type": "array", "items": { "type": "integer" } } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "success" } }, "type": "object" } } } }, "422": { "description": "Validation error or empty team ids", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Team ids can not be empty" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/call-settings": { "get": { "tags": [ "Teams" ], "summary": "Get call settings", "description": "REQUIRED SCOPES ['teams:read']
Get call settings", "operationId": "c7b0cfd223e195f795f84830d10cc935", "parameters": [ { "name": "team", "in": "path", "description": "ID of the team", "required": true, "schema": { "type": "integer" } }, { "name": "level", "in": "query", "description": "Level of settings (e.g., 'organization', 'team', 'user')", "required": true, "schema": { "type": "string" } }, { "name": "level_id", "in": "query", "description": "ID of the level entity", "required": true, "schema": { "type": "integer" } }, { "name": "organization_id", "in": "query", "description": "ID of the organization", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "ref": "#/components/schemas/CallSettingsResource" } } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "teams:read" ] } ], "x-versions": [ "public" ] }, "put": { "tags": [ "Teams" ], "summary": "Toggle call-settings", "description": "REQUIRED SCOPES ['teams:write']
Toggle call-settings", "operationId": "91f69fac3fed43bc4ef947d8a9793b49", "parameters": [ { "name": "team", "in": "path", "description": "Team ID", "required": true, "schema": { "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "voice": { "description": "Voice Toggle", "type": "boolean", "default": true }, "voice_outbound": { "description": "Outbound Voice Toggle", "type": "boolean", "default": true }, "use_organization_call_settings": { "description": "Use Organization Settings Toggle", "type": "boolean", "default": true } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResource" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "use_organization_call_settings": { "type": "string", "example": "The use organization call settings field is required." } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/triggers": { "get": { "tags": [ "Triggers" ], "summary": "Get all triggers", "description": "REQUIRED SCOPES ['triggers:read']
Get all triggers", "operationId": "3c6c411102fd13a34f932dc98c449c4a", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Trigger" } } } } } }, "security": [ { "apiAuth": [ "triggers:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Triggers" ], "summary": "Create trigger", "description": "REQUIRED SCOPES ['triggers:write']
Create trigger", "operationId": "182b134814ba34eee7f59a3a8b972f29", "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "description": "Name", "type": "string" }, "message": { "description": "Message", "type": "string" }, "is_track_conversion": { "description": "Keep track of conversions?", "type": "boolean", "default": "false" }, "conversion_id": { "description": "The ID of the Conversation", "type": "integer" }, "number_id": { "description": "Number ID", "type": "integer" }, "send_from": { "description": "Send from configuration", "properties": { "type": { "type": "string", "example": "send_from_rcs_sender|send_from_number|send_from_smart_inbox" }, "options": { "properties": { "team_id": { "description": "Team ID (required for RCS sender and smart inbox)", "type": "integer", "example": 1 }, "number_id": { "description": "Number ID (required for send_from_number)", "type": "integer", "example": 1 }, "smart_option": { "description": "Smart inbox option (required for smart inbox)", "type": "string", "example": "default" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Trigger" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "triggers:write" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Triggers" ], "summary": "Bulk delete triggers", "description": "REQUIRED SCOPES ['triggers:write']
Bulk delete triggers", "operationId": "bed803bfe77b8ef410bf21ed92d3e575", "requestBody": { "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "description": "Trigger IDs", "type": "array", "items": { "type": "integer" } }, "bulk_all": { "description": "Bulk all", "type": "boolean", "example": false } }, "type": "object" } } } }, "responses": { "200": { "description": "OK" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "ids": { "title": "ids", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "triggers:write" ] } ], "x-versions": [ "public" ] } }, "/triggers/contacts/{trigger}": { "get": { "tags": [ "Triggers" ], "summary": "Get trigger contacts", "description": "REQUIRED SCOPES ['triggers:read']
Get trigger contacts", "operationId": "39edaacbf2e2f1e9436efe0af84eebf6", "parameters": [ { "name": "trigger", "in": "path", "description": "The ID of the Trigger", "required": true, "schema": { "type": "integer", "example": "" } }, { "name": "filter", "in": "query", "description": "Filter", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page of a collection to return.", "schema": { "type": "integer", "default": "1" } }, { "name": "length", "in": "query", "description": "The number of items to return per page.", "schema": { "type": "integer", "default": "10" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResource" } } } } }, "security": [ { "apiAuth": [ "triggers:read" ] } ], "x-versions": [ "public" ] } }, "/triggers/contacts/{trigger}/export": { "get": { "tags": [ "Triggers" ], "summary": "Export trigger contacts", "description": "REQUIRED SCOPES ['triggers:read']
Export trigger contacts", "operationId": "e4f44a30147c7e21ff2499e2308c131f", "parameters": [ { "name": "trigger", "in": "path", "description": "The ID of the Trigger", "required": true, "schema": { "type": "integer", "example": "" } }, { "name": "filter", "in": "query", "description": "Filter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "url": { "type": "string", "example": "https://app.salesmessage.com/export/contacts.csv" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "triggers:read" ] } ], "x-versions": [ "public" ] } }, "/triggers/{trigger}": { "get": { "tags": [ "Triggers" ], "summary": "Get trigger", "description": "REQUIRED SCOPES ['triggers:read']
Get trigger", "operationId": "4d6478ebabe62dbd90d83d18b806d145", "parameters": [ { "name": "trigger", "in": "path", "description": "The ID of the Trigger", "required": true, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Trigger" } } } } }, "security": [ { "apiAuth": [ "triggers:read" ] } ], "x-versions": [ "public" ] }, "put": { "tags": [ "Triggers" ], "summary": "Update trigger", "description": "REQUIRED SCOPES ['triggers:write']
Updatetrigger", "operationId": "437c51c981ba18d628a6b28d39bbd8ee", "parameters": [ { "name": "trigger", "in": "path", "description": "The ID of the Trigger", "required": true, "schema": { "type": "integer", "example": "" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "description": "Name", "type": "string" }, "message": { "description": "Message", "type": "string" }, "number_id": { "description": "Number ID", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Trigger" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "triggers:write" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Triggers" ], "summary": "Delete trigger", "description": "REQUIRED SCOPES ['triggers:write']
Delete trigger", "operationId": "98d0ccec6edaffef8d74f1828cb562ad", "parameters": [ { "name": "trigger", "in": "path", "description": "The ID of the Trigger", "required": true, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "triggers:write" ] } ], "x-versions": [ "public" ] } }, "/triggers/filters": { "get": { "tags": [ "Triggers" ], "summary": "Get all triggers filters", "description": "REQUIRED SCOPES ['triggers:read']
Get all triggers filters", "operationId": "f7e93eb1d323d77c8691a1b356e1e8b0", "parameters": [ { "name": "name", "in": "query", "description": "Name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "triggers:read" ] } ], "x-versions": [ "public" ] } }, "/triggers/search": { "get": { "tags": [ "Triggers" ], "summary": "Search trigger", "description": "REQUIRED SCOPES ['triggers:read']
Search trigger", "operationId": "c201e3985e76cae447181518650b5518", "parameters": [ { "name": "limit", "in": "query", "description": "The maximum number of messages that you want returned from this call.", "schema": { "type": "integer", "default": 10 } }, { "name": "term", "in": "query", "description": "The string to search for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Trigger" } } } } } }, "security": [ { "apiAuth": [ "triggers:read" ] } ], "x-versions": [ "public" ] } }, "/triggers/test": { "post": { "tags": [ "Triggers" ], "summary": "Send Test Trigger", "description": "REQUIRED SCOPES ['triggers:write']
Send Test Trigger", "operationId": "ab56c8e9aa52073db694f3717704963d", "parameters": [ { "name": "integration_id", "in": "query", "description": "The ID of Integration", "schema": { "type": "integer" } }, { "name": "number", "in": "query", "description": "Number", "required": true, "schema": { "type": "string" } }, { "name": "number_id", "in": "query", "description": "The ID of the Number", "required": true, "schema": { "type": "integer" } }, { "name": "team_id", "in": "query", "description": "Send from RCS inbox (team)", "schema": { "type": "integer" } }, { "name": "message", "in": "query", "description": "Message", "schema": { "type": "string" } }, { "name": "media_url[]", "in": "query", "description": "The url of the media", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tags[]", "in": "query", "description": "The list of Tags", "schema": { "type": "array", "items": { "type": "integer" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "triggers:write" ] } ], "x-versions": [ "public" ] } }, "/triggers/toggle/{trigger}": { "put": { "tags": [ "Triggers" ], "summary": "Toggle trigger", "description": "REQUIRED SCOPES ['triggers:write']
Toggle trigger", "operationId": "7a923c5fc5bc25a471f0cece4fea7ede", "parameters": [ { "name": "trigger", "in": "path", "description": "The ID of the Trigger", "required": true, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Trigger" } } } } }, "security": [ { "apiAuth": [ "triggers:write" ] } ], "x-versions": [ "public" ] } }, "/app/opt-in-data/opt-in-data-files/validate": { "post": { "tags": [ "Opt-In Data Files" ], "summary": "Validate Opt-In Data File", "description": "REQUIRED SCOPES ['opt-in-data-files:write']
Validate Opt-In Data File", "operationId": "validateOptInDataFile", "requestBody": { "description": "Opt-In Data File", "required": true, "content": { "multipart/form-data": { "schema": { "properties": { "file": { "description": "Opt-In Data File", "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "200": { "description": "Validation passed", "content": { "application/json": { "schema": { "properties": { "validation_passed": { "type": "boolean" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "opt-in-data-files:write" ] } ], "x-versions": [ "public" ] } }, "/users/away-status": { "post": { "tags": [ "Users" ], "summary": "Update user's away status", "description": "REQUIRED SCOPES ['users:write']
Update user's away status", "operationId": "f8b7f4b42a8d438aae21feb612e98a84", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "away_status": { "description": "True if user is away, false otherwise", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "isAway": { "description": "Current away status", "type": "boolean" }, "awayStatusLastDate": { "description": "Timestamp of last away status change", "type": "string", "format": "date-time", "nullable": true } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "apiAuth": [ "users:write" ] } ], "x-versions": [ "public" ] } }, "/users/business-hours": { "get": { "tags": [ "Users" ], "summary": "Get Business Hours", "description": "REQUIRED SCOPES ['users:read']
Get business hours", "operationId": "a231edfeb02805183f396481eb94c83f", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "days": { "type": "array", "items": { "properties": { "closed": { "type": "boolean" }, "day": { "type": "string" }, "end": { "type": "string" }, "start": { "type": "string" } }, "type": "object" } }, "is_active": { "type": "boolean" }, "media_url": { "type": "string" }, "message": { "type": "string" }, "timezone": { "type": "string" }, "hourable_type": { "type": "string" }, "hourable_id": { "type": "integer" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "users:read" ] } ], "x-versions": [ "public" ] } }, "/users/config": { "get": { "tags": [ "Users" ], "summary": "Get Config", "description": "REQUIRED SCOPES ['users:read']
", "operationId": "721dba9eabcd137e0f2323083df73271", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "10dlc_banners_info": { "type": "array", "items": { "properties": { "should_show_banner": { "type": "boolean" }, "grace_period": { "type": "array", "items": { "properties": { "days_left": { "type": "integer" }, "hours_left": { "type": "integer" } }, "type": "object" } } }, "type": "object" } }, "developer": { "type": "boolean" }, "integrationDisconnected": { "type": "boolean" }, "intercom": { "type": "string" }, "welcomeVideoEnabled": { "type": "boolean" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "users:read" ] } ], "x-versions": [ "public" ] } }, "/users/email": { "post": { "tags": [ "Users" ], "summary": "Update user email and password", "description": "REQUIRED SCOPES [‘users:write’]
This API endpoint is used to update the email address of the user.

The required parameter to update user’s email is the relevant user’s password which is used to confirm the email update operation.

As a result of this API request, you are able to change the email record in the database.", "operationId": "Update user email and password", "parameters": [ { "name": "current_password", "in": "query", "description": "Password", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResource" } } } } }, "security": [ { "apiAuth": [ "users:write" ] } ], "x-versions": [ "public" ] } }, "/users/feedback": { "post": { "tags": [ "Users" ], "summary": "Submit user feedback", "description": "REQUIRED SCOPES ['users:write']
Submit user feedback", "operationId": "b73899882e5c112958de0ea42b4d2744", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "feedback": { "description": "User's feedback message", "type": "string" }, "path": { "description": "Path where the feedback was submitted from", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Feedback sent successfully", "content": { "application/json": { "schema": { "properties": { "sent": { "type": "boolean", "example": true } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "apiAuth": [ "users:write" ] } ], "x-versions": [ "public" ] } }, "/users/integration": { "get": { "tags": [ "Users" ], "summary": "Get integration", "description": "REQUIRED SCOPES ['users:read']
Get integration", "operationId": "64741026920c19567b15728571af90ad", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "activecampaign": { "type": "array", "items": { "properties": { "api_key": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "connection_error": { "type": "integer" }, "organization_id": { "type": "integer" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "deleted_at": { "type": "string" }, "id": { "type": "integer" }, "user_id": { "type": "integer" }, "user_credential_id": { "type": "integer" }, "integration_id": { "type": "integer" }, "identity": { "type": "string" }, "last_check_at": { "type": "string" }, "provider_user_id": { "type": "string" }, "token": { "type": "string" }, "updated_at": { "type": "string" }, "url": { "type": "string" }, "sync_token": { "type": "string" }, "webhook_id": { "type": "string" }, "webhook_url": { "type": "string" }, "is_active": { "type": "boolean" }, "integration": { "type": "array", "items": { "properties": { "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "integer" }, "is_active": { "type": "boolean" }, "oauth": { "type": "boolean" }, "key": { "type": "string" }, "name": { "type": "string" }, "photo_url": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" } }, "user_credential": { "type": "array", "items": { "properties": { "avatar": { "type": "string" }, "created_at": { "type": "string" }, "deleted_at": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "nickname": { "type": "string" }, "provider": { "type": "string" }, "provider_identifier": { "type": "string" }, "provider_user_id": { "type": "string" }, "third_token": { "type": "string" }, "updated_at": { "type": "string" }, "expires_at": { "type": "string" }, "id": { "type": "integer" }, "user_id": { "type": "integer" }, "is_active": { "type": "boolean" }, "oauth": { "type": "boolean" }, "meta": { "type": "array", "items": { "properties": { "company": { "type": "array", "items": { "properties": { "name": { "type": "string" }, "numbers_count": { "type": "integer" }, "users_count": { "type": "integer" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } }, "aircall": { "type": "array", "items": { "properties": { "api_key": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "connection_error": { "type": "integer" }, "organization_id": { "type": "integer" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "deleted_at": { "type": "string" }, "id": { "type": "integer" }, "user_id": { "type": "integer" }, "user_credential_id": { "type": "integer" }, "integration_id": { "type": "integer" }, "identity": { "type": "string" }, "last_check_at": { "type": "string" }, "provider_user_id": { "type": "string" }, "token": { "type": "string" }, "updated_at": { "type": "string" }, "url": { "type": "string" }, "sync_token": { "type": "string" }, "webhook_id": { "type": "string" }, "webhook_url": { "type": "string" }, "is_active": { "type": "boolean" }, "integration": { "type": "array", "items": { "properties": { "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "integer" }, "is_active": { "type": "boolean" }, "oauth": { "type": "boolean" }, "key": { "type": "string" }, "name": { "type": "string" }, "photo_url": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" } }, "user_credential": { "type": "array", "items": { "properties": { "avatar": { "type": "string" }, "created_at": { "type": "string" }, "deleted_at": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "nickname": { "type": "string" }, "provider": { "type": "string" }, "provider_identifier": { "type": "string" }, "provider_user_id": { "type": "string" }, "third_token": { "type": "string" }, "updated_at": { "type": "string" }, "expires_at": { "type": "string" }, "id": { "type": "integer" }, "user_id": { "type": "integer" }, "is_active": { "type": "boolean" }, "oauth": { "type": "boolean" }, "meta": { "type": "array", "items": { "properties": { "company": { "type": "array", "items": { "properties": { "name": { "type": "string" }, "numbers_count": { "type": "integer" }, "users_count": { "type": "integer" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } }, "google": { "type": "array", "items": { "properties": { "api_key": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "connection_error": { "type": "integer" }, "organization_id": { "type": "integer" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "deleted_at": { "type": "string" }, "id": { "type": "integer" }, "user_id": { "type": "integer" }, "user_credential_id": { "type": "integer" }, "integration_id": { "type": "integer" }, "identity": { "type": "string" }, "last_check_at": { "type": "string" }, "provider_user_id": { "type": "string" }, "token": { "type": "string" }, "updated_at": { "type": "string" }, "url": { "type": "string" }, "sync_token": { "type": "string" }, "webhook_id": { "type": "string" }, "webhook_url": { "type": "string" }, "is_active": { "type": "boolean" }, "integration": { "type": "array", "items": { "properties": { "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "integer" }, "is_active": { "type": "boolean" }, "oauth": { "type": "boolean" }, "key": { "type": "string" }, "name": { "type": "string" }, "photo_url": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" } }, "user_credential": { "type": "array", "items": { "properties": { "avatar": { "type": "string" }, "created_at": { "type": "string" }, "deleted_at": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "nickname": { "type": "string" }, "provider": { "type": "string" }, "provider_identifier": { "type": "string" }, "provider_user_id": { "type": "string" }, "third_token": { "type": "string" }, "updated_at": { "type": "string" }, "expires_at": { "type": "string" }, "id": { "type": "integer" }, "user_id": { "type": "integer" }, "is_active": { "type": "boolean" }, "oauth": { "type": "boolean" }, "meta": { "type": "array", "items": { "properties": { "company": { "type": "array", "items": { "properties": { "name": { "type": "string" }, "numbers_count": { "type": "integer" }, "users_count": { "type": "integer" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } }, "infusionsoft": { "type": "array", "items": { "properties": { "api_key": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "connection_error": { "type": "integer" }, "organization_id": { "type": "integer" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "deleted_at": { "type": "string" }, "id": { "type": "integer" }, "user_id": { "type": "integer" }, "user_credential_id": { "type": "integer" }, "integration_id": { "type": "integer" }, "identity": { "type": "string" }, "last_check_at": { "type": "string" }, "provider_user_id": { "type": "string" }, "token": { "type": "string" }, "updated_at": { "type": "string" }, "url": { "type": "string" }, "sync_token": { "type": "string" }, "webhook_id": { "type": "string" }, "webhook_url": { "type": "string" }, "is_active": { "type": "boolean" }, "integration": { "type": "array", "items": { "properties": { "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "integer" }, "is_active": { "type": "boolean" }, "oauth": { "type": "boolean" }, "key": { "type": "string" }, "name": { "type": "string" }, "photo_url": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" } }, "user_credential": { "type": "array", "items": { "properties": { "avatar": { "type": "string" }, "created_at": { "type": "string" }, "deleted_at": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "nickname": { "type": "string" }, "provider": { "type": "string" }, "provider_identifier": { "type": "string" }, "provider_user_id": { "type": "string" }, "third_token": { "type": "string" }, "updated_at": { "type": "string" }, "expires_at": { "type": "string" }, "id": { "type": "integer" }, "user_id": { "type": "integer" }, "is_active": { "type": "boolean" }, "oauth": { "type": "boolean" }, "meta": { "type": "array", "items": { "properties": { "company": { "type": "array", "items": { "properties": { "name": { "type": "string" }, "numbers_count": { "type": "integer" }, "users_count": { "type": "integer" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } }, "pipedrive": { "type": "array", "items": { "properties": { "api_key": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "connection_error": { "type": "integer" }, "organization_id": { "type": "integer" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "deleted_at": { "type": "string" }, "id": { "type": "integer" }, "user_id": { "type": "integer" }, "user_credential_id": { "type": "integer" }, "integration_id": { "type": "integer" }, "identity": { "type": "string" }, "last_check_at": { "type": "string" }, "provider_user_id": { "type": "string" }, "token": { "type": "string" }, "updated_at": { "type": "string" }, "url": { "type": "string" }, "sync_token": { "type": "string" }, "webhook_id": { "type": "string" }, "webhook_url": { "type": "string" }, "is_active": { "type": "boolean" }, "integration": { "type": "array", "items": { "properties": { "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "integer" }, "is_active": { "type": "boolean" }, "oauth": { "type": "boolean" }, "key": { "type": "string" }, "name": { "type": "string" }, "photo_url": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" } }, "user_credential": { "type": "array", "items": { "properties": { "avatar": { "type": "string" }, "created_at": { "type": "string" }, "deleted_at": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "nickname": { "type": "string" }, "provider": { "type": "string" }, "provider_identifier": { "type": "string" }, "provider_user_id": { "type": "string" }, "third_token": { "type": "string" }, "updated_at": { "type": "string" }, "expires_at": { "type": "string" }, "id": { "type": "integer" }, "user_id": { "type": "integer" }, "is_active": { "type": "boolean" }, "oauth": { "type": "boolean" }, "meta": { "type": "array", "items": { "properties": { "company": { "type": "array", "items": { "properties": { "name": { "type": "string" }, "numbers_count": { "type": "integer" }, "users_count": { "type": "integer" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "users:read" ] } ], "x-versions": [ "public" ] } }, "/users/me": { "get": { "tags": [ "Users" ], "summary": "Get current user", "description": "REQUIRED SCOPES ['users:read']
Returns information about the user who is currently authenticated in the system and wants to view the data about their account.

In the case of a client-side authenticated OAuth application, this will be the user who authorized the application.

After sending the request, the current user can view thier:
  • First name
  • Last name
  • Email
  • Business hour
  • Configs
  • Number, etc.
", "operationId": "Get current user", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Me" } } } } }, "security": [ { "apiAuth": [ "users:read" ] } ], "x-versions": [ "public" ] } }, "/users/password": { "post": { "tags": [ "Users" ], "summary": "Change user password", "description": "REQUIRED SCOPES ['users:write']
This endpoint allows an authenticated current user to change their password.

To allow a user to successfully change their password via this API call, it is required from the user to input:
  • Current password
  • New password
  • Confirm the new password
", "operationId": "Change user password", "parameters": [ { "name": "password", "in": "query", "description": "New password", "required": true, "schema": { "type": "string" } }, { "name": "password_confirmation", "in": "query", "description": "Confirm new password", "required": true, "schema": { "type": "string" } }, { "name": "current_password", "in": "query", "description": "Current password", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResource" } } } } }, "security": [ { "apiAuth": [ "users:write" ] } ], "x-versions": [ "public" ] } }, "/users/permissions": { "get": { "tags": [ "Users" ], "summary": "Get permissions", "description": "REQUIRED SCOPES ['users:read']
Get permissions", "operationId": "7a68c410a6e9ea93ff7b9c23afa74342", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "can_access_inboxes": { "type": "boolean" }, "can_create_additional_inboxes": { "type": "boolean" }, "can_manage_inboxes": { "type": "boolean" }, "can_manage_organization_inboxes": { "type": "boolean" }, "can_manage_billing_settings": { "type": "boolean" }, "can_manage_billing_compliance_settings": { "type": "boolean" }, "can_manage_members": { "type": "boolean" }, "can_manage_organization_settings": { "type": "boolean" }, "can_manage_phone_checker": { "type": "boolean" }, "can_manage_security_settings": { "type": "boolean" }, "can_manage_tags": { "type": "boolean" }, "can_manage_contacts": { "type": "boolean" }, "can_import_contacts": { "type": "boolean" }, "can_export_contacts": { "type": "boolean" }, "can_manage_conversations": { "type": "boolean" }, "can_manage_integrations": { "type": "boolean" }, "can_manage_clients": { "type": "boolean" }, "can_manage_saved_replies": { "type": "boolean" }, "can_reassign_conversations": { "type": "boolean" }, "can_manage_broadcasts": { "type": "boolean" }, "can_manage_organization_broadcasts": { "type": "boolean" }, "can_manage_triggers": { "type": "boolean" }, "can_manage_organization_triggers": { "type": "boolean" }, "can_manage_keywords": { "type": "boolean" }, "can_manage_organization_keywords": { "type": "boolean" }, "can_access_analytics": { "type": "boolean" }, "can_manage_oauth_applications": { "type": "boolean" }, "can_manage_canned_messages": { "type": "boolean" }, "can_manage_shared_canned_messages": { "type": "boolean" }, "can_manage_custom_fields": { "type": "boolean" }, "can_manage_referrals": { "type": "boolean" }, "can_manage_website_chat_widget": { "type": "boolean" }, "can_access_all": { "type": "boolean" }, "can_access_own": { "type": "boolean" }, "can_access_groups": { "type": "boolean" }, "can_manage_text_bots": { "type": "boolean" }, "can_manage_organization_text_bots": { "type": "boolean" }, "can_manage_calling_agents": { "type": "boolean" }, "can_manage_organization_calling_agents": { "type": "boolean" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "users:read" ] } ], "x-versions": [ "public" ] } }, "/users/assign-inbox-request": { "get": { "tags": [ "Users" ], "summary": "Get users assign inbox request", "description": "REQUIRED SCOPES ['users:read']
Get users assign inbox request", "operationId": "08c55f8893510c100905d14941f9dd19", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "data": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Unauthorized action." } }, "security": [ { "apiAuth": [ "users:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Users" ], "summary": "Update user assign inbox request", "description": "REQUIRED SCOPES ['users:write']
Update user assign inbox request", "operationId": "01e6fa501924b3a62baa33a7e07ff597", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "data": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Unauthorized action." } }, "security": [ { "apiAuth": [ "users:write" ] } ], "x-versions": [ "public" ] } }, "/users/access-requests": { "get": { "tags": [ "Users" ], "summary": "Get user access requests", "description": "REQUIRED SCOPES ['users:read']
Get user access requests", "operationId": "04ab0b68c5544ce982aef8a2a3f48eec", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "data": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "users:read" ] } ], "x-versions": [ "public" ] } }, "/roles": { "get": { "tags": [ "Users" ], "summary": "List roles with permissions for the user's organization", "description": "REQUIRED SCOPES ['users:read']
List roles with permissions for the user's organization", "operationId": "ace794deb81218c6355bdfde06948da2", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "available_permissions": { "type": "array", "items": { "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "default": { "type": "boolean" } }, "type": "object" } }, "unavailable_permissions": { "type": "array", "items": { "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "default": { "type": "boolean" } }, "type": "object" } }, "organization_permissions": { "type": "array", "items": { "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "default": { "type": "boolean" } }, "type": "object" } }, "all_permissions": { "type": "array", "items": { "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "default": { "type": "boolean" } }, "type": "object" } } }, "type": "object" } } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "apiAuth": [ "users:read" ] } ], "x-versions": [ "public" ] } }, "/users/search": { "get": { "tags": [ "Users" ], "summary": "Search members in current organization", "description": "REQUIRED SCOPES ['users:read']
Search members in current organization", "operationId": "9dac97bc0c449bc7d0fdf2366ac40a4f", "parameters": [ { "name": "term", "in": "query", "description": "Term", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "description": "Per Page", "required": true, "schema": { "type": "integer", "default": 50 } }, { "name": "page", "in": "query", "description": "Page", "required": true, "schema": { "type": "integer", "default": 1 } }, { "name": "exclude[]", "in": "query", "description": "The IDs of the Contacts", "schema": { "type": "array", "items": { "type": "integer" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "results": { "type": "array", "items": { "type": "object" } }, "total": { "type": "integer" }, "errors": { "type": "boolean" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "users:read" ] } ], "x-versions": [ "public" ] } }, "/users/settings": { "get": { "tags": [ "Users" ], "summary": "Get settings", "description": "REQUIRED SCOPES ['users:read']
Get settings", "operationId": "b6ee92fd9167a19bb4a848edaf093fcb", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "0": { "type": "array", "items": { "properties": { "created_at": { "type": "string" }, "description": { "type": "string" }, "key": { "type": "string" }, "updated_at": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "integer" }, "default_settings": { "type": "array", "items": { "properties": { "active": { "type": "boolean" } }, "type": "object" } }, "settings": { "type": "array", "items": { "properties": { "active": { "type": "boolean" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "users:read" ] } ], "x-versions": [ "public" ] }, "patch": { "tags": [ "Users" ], "summary": "Update user feature settings", "description": "REQUIRED SCOPES [‘users:write’]
Each user in the system has personal feature settings related to choosing a convenient UI for the interaction within a conversation.

This API endpoint allows for setting a flag for a specific feature setting, such as send a message by a click of the ‘Send’ button or the ‘Enter’ button on the keyboard.

Through this API request, the user can save such personal settings and preferences.", "operationId": "Update user feature settings", "parameters": [ { "name": "featureKey", "in": "query", "description": "Key of the feature", "required": true, "schema": { "type": "string" } }, { "name": "settingsKey", "in": "query", "description": "Settings key", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Settings value", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "value": { "type": "string" }, "settingsKey": { "type": "string" }, "featureKey": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "users:write" ] } ], "x-versions": [ "public" ] } }, "/users/settings-multiple": { "patch": { "tags": [ "Users" ], "summary": "Update multiple user settings", "description": "REQUIRED SCOPES ['users:write']
Update multiple user settings", "operationId": "6b7c356f9ce4c83e03c981e42d4e7580", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "featureKey": { "type": "string" }, "settingsKey": { "type": "string" }, "value": { "type": "string" } }, "type": "object" } } } } }, "responses": { "200": { "description": "Settings updated successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "featureKey": { "type": "string" }, "settingsKey": { "type": "string" }, "value": { "type": "string" } }, "type": "object" } } } } }, "422": { "description": "Validation error or incorrect settings", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Incorrect settings" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "apiAuth": [ "users:write" ] } ], "x-versions": [ "public" ] } }, "/users/team": { "put": { "tags": [ "Users" ], "summary": "Update user's team", "description": "REQUIRED SCOPES ['users:write']
The API endpoint helps to update team id and choose another message inbox which will be used for the conversations by default.

This becomes needed in case the user wants to switch between teams (inboxes) that they wish to receive messages and notifications from.

If the users skip updating their team, messages will be sent and received within the currently active team.", "operationId": "Update users team", "parameters": [ { "name": "id", "in": "query", "description": "Team ID", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "currentInboxId": { "type": "integer" }, "currentInboxTypeId": { "type": "integer" }, "currentInboxType": { "type": "string" }, "unread": { "type": "integer" }, "unread_calls": { "type": "integer" }, "unread_messages_count": { "type": "integer" }, "unread_mentions_count": { "type": "integer" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "users:write" ] } ], "x-versions": [ "public" ] } }, "/users/toggle-record-automatically": { "post": { "tags": [ "Users" ], "summary": "Update users toggle record automatically", "description": "REQUIRED SCOPES ['users:write']
Update users toggle record automatically", "operationId": "1ac6e27cf466b7d648b1fb26cac0d6fc", "requestBody": { "content": { "application/json": { "schema": { "properties": { "isRecordAutomatically": { "description": "Record Automatically flag.", "type": "boolean", "default": false } }, "type": "object" } } } }, "responses": { "204": { "description": "OK" } }, "security": [ { "apiAuth": [ "users:write" ] } ], "x-versions": [ "public" ] } }, "/users/ui-settings": { "get": { "tags": [ "Users" ], "summary": "Get List Of User's UI Settings", "description": "REQUIRED SCOPES ['users:read']
Get list of user's UI settings", "operationId": "805aa268ae1640459e62dfe76b0a8e97", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "title": "data", "type": "array", "items": { "$ref": "#/components/schemas/UISettingsResource" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "users:read" ] } ], "x-versions": [ "public" ] } }, "/users/ui-settings/{type}": { "get": { "tags": [ "Users" ], "summary": "Get User's UI Settings For The Provided Type", "description": "REQUIRED SCOPES ['users:read']
Get user's UI settings for the provided type", "operationId": "be7d13e0d3e926c4016c2fded85196b7", "parameters": [ { "name": "type", "in": "path", "description": "UI Settings Type", "required": true, "schema": { "type": "string", "example": "contacts-table-columns" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/UISettingsResource" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "users:read" ] } ], "x-versions": [ "public" ] } }, "/users/ui-settings/sync": { "post": { "tags": [ "Users" ], "summary": "Sync User's UI Settings.", "description": "REQUIRED SCOPES ['users:write']
Sync User's UI Settings: Create OR Update.", "operationId": "700ac08d33ba43dace1a8507b4bcf86e", "requestBody": { "content": { "application/json": { "schema": { "required": [ "source_type", "items" ], "properties": { "source_type": { "description": "Source Type", "type": "string", "example": "contacts-table-columns" }, "items": { "description": "Settings Items: array or object", "oneOf": [ { "type": "array", "items": {} }, { "type": "object" } ] } }, "type": "object" } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/UISettingsResource" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "properties": { "error": { "title": "error", "type": "string" }, "code": { "title": "error", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "users:write" ] } ], "x-versions": [ "public" ] } }, "/user": { "get": { "tags": [ "Users" ], "summary": "Get Current User", "description": "REQUIRED SCOPES ['users:read']
Get current user", "operationId": "Get Current User", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "awayStatusLastDate": { "type": "string" }, "contact_fields": { "type": "array", "items": { "properties": { "organization_id": { "type": "integer" }, "user_id": { "type": "integer" }, "id": { "type": "integer" }, "active_fields": { "type": "array", "items": { "properties": { "0": { "type": "string" } }, "type": "object" } } }, "type": "object" } }, "createdAt": { "type": "string" }, "inboxesCount": { "type": "integer" }, "currentInboxId": { "type": "integer" }, "currentInboxType": { "type": "integer" }, "currentInboxTypeId": { "type": "integer" }, "defaultTeamId": { "type": "integer" }, "dlcBannerShouldShowAgain": { "type": "boolean" }, "dlcBannerShowLastDate": { "type": "string" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "fullName": { "type": "string" }, "hasAccessibleOrganizations": { "type": "boolean" }, "id": { "type": "integer" }, "isAway": { "type": "boolean" }, "isGroupsFlow": { "type": "integer" }, "isRecordAutomatically": { "type": "boolean" }, "isRequireNumber": { "type": "integer" }, "lastName": { "type": "string" }, "number": { "type": "string" }, "country": { "type": "string" }, "countryCallingCode": { "type": "string" }, "ownersNumber": { "type": "string" }, "photoUrl": { "type": "string" }, "role": { "type": "string" }, "timezone": { "type": "string" }, "first_promoter_ref_id": { "type": "string" }, "design_version": { "type": "string" }, "can_switch_design": { "type": "boolean" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "users:read" ] } ], "x-versions": [ "public" ] } }, "/user/{user}": { "get": { "tags": [ "Users" ], "summary": "Get User By Id", "description": "REQUIRED SCOPES ['users:read']
Get user by ID", "operationId": "Get User By Id", "parameters": [ { "name": "user", "in": "path", "description": "The ID of the User", "required": true, "schema": { "type": "integer", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "full_name": { "type": "string" }, "photo_url": { "type": "string" }, "email": { "type": "string" }, "timezone": { "type": "string" }, "role": { "type": "string" }, "role_label": { "type": "string" }, "number": { "type": "string" }, "two_fa_enabled": { "type": "boolean" }, "has_change_role_request": { "type": "boolean" }, "has_inbox_access_request": { "type": "boolean" }, "disabled": { "type": "boolean" }, "default_team_id": { "type": "integer" }, "member_teams_count": { "type": "integer" }, "permissions": { "type": "array", "items": { "properties": { "billing": { "type": "boolean" }, "members": { "type": "boolean" }, "dataAndSecurity": { "type": "boolean" }, "inbox": { "type": "boolean" }, "broadcasts": { "type": "boolean" }, "triggers": { "type": "boolean" }, "reportingAndAnalytics": { "type": "boolean" } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "users:read" ] } ], "x-versions": [ "public" ] } }, "/users": { "get": { "tags": [ "Users" ], "summary": "Get Users", "description": "REQUIRED SCOPES ['users:read']
Get users", "operationId": "Get Users", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "full_name": { "type": "string" }, "photo_url": { "type": "string" }, "email": { "type": "string" }, "timezone": { "type": "string" }, "role": { "type": "string" }, "role_label": { "type": "string" }, "number": { "type": "string" }, "two_fa_enabled": { "type": "boolean" }, "has_change_role_request": { "type": "boolean" }, "has_inbox_access_request": { "type": "boolean" }, "disabled": { "type": "boolean" }, "default_team_id": { "type": "integer" }, "member_teams_count": { "type": "integer" }, "permissions": { "type": "array", "items": { "properties": { "billing": { "type": "boolean" }, "members": { "type": "boolean" }, "dataAndSecurity": { "type": "boolean" }, "inbox": { "type": "boolean" }, "broadcasts": { "type": "boolean" }, "triggers": { "type": "boolean" }, "reportingAndAnalytics": { "type": "boolean" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "users:read" ] } ], "x-versions": [ "public" ] } }, "/call-history": { "get": { "tags": [ "Call History" ], "summary": "Get call history list", "description": "REQUIRED SCOPES ['call-history:read']
Get call history list", "operationId": "5f7ca5f719fd58e9ecb83313006ffbe4", "parameters": [ { "name": "group", "in": "query", "description": "Group", "required": false, "schema": { "type": "string" } }, { "name": "team_id", "in": "query", "description": "Team ID", "required": false, "schema": { "type": "integer" } }, { "name": "team_type", "in": "query", "description": "Team type", "required": false, "schema": { "type": "string" } }, { "name": "filtersList", "in": "query", "description": "List of filters to apply", "required": false, "schema": { "type": "array", "items": { "properties": { "filters": { "type": "array", "items": { "properties": { "key": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "format": "query" } } }, "type": "object", "format": "query" } } }, { "name": "search", "in": "query", "description": "Search value", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer" } }, { "name": "sorting", "in": "query", "description": "Sorting criteria", "required": false, "schema": { "type": "array", "items": { "properties": { "field": { "type": "string" }, "order": { "type": "string" } }, "type": "object", "format": "query" } } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "call-history:read" ] } ], "x-versions": [ "public" ] } }, "/call-history/statistics": { "get": { "tags": [ "Call History" ], "summary": "Get call history statistics", "description": "REQUIRED SCOPES ['call-history:read']
Get call history statistics", "operationId": "8cf7a67ef8f3dc7cdf0b8318d54da37b", "parameters": [ { "name": "group", "in": "query", "description": "Group", "required": false, "schema": { "type": "string" } }, { "name": "team_id", "in": "query", "description": "Team ID", "required": false, "schema": { "type": "integer" } }, { "name": "team_type", "in": "query", "description": "Team type", "required": false, "schema": { "type": "string" } }, { "name": "filtersList", "in": "query", "description": "List of filters to apply", "required": false, "schema": { "type": "array", "items": { "properties": { "filters": { "type": "array", "items": { "properties": { "key": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "format": "query" } } }, "type": "object", "format": "query" } } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "total_messages": { "type": "number" }, "total_unread_messages": { "type": "number" }, "total_unread_inbound_calls": { "type": "number" }, "total_unread_outbound_calls": { "type": "number" }, "total_unread_outbound_answered": { "type": "number" }, "total_unread_outbound_no_answered": { "type": "number" }, "total_unread_inbound_answered": { "type": "number" }, "total_unread_inbound_missed": { "type": "number" }, "total_unread_inbound_voicemail": { "type": "number" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "call-history:read" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/call-settings/audio": { "post": { "tags": [ "Teams" ], "summary": "Create a new call setting audio", "description": "REQUIRED SCOPES ['teams:write']
Create a new call setting audio", "operationId": "d6affc30258f8cecf20499bac6fbfe23", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "properties": { "file": { "description": "Audio file", "type": "string", "format": "binary" }, "call_setting_name": { "type": "string" }, "name": { "type": "string" }, "is_make_active": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "id": { "type": "integer" }, "organization_id": { "type": "integer" }, "name": { "type": "string" }, "content_type": { "type": "string" }, "url": { "type": "string" }, "call_setting_name": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Validation error or no file provided", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "No file." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/organization/call-settings": { "get": { "tags": [ "Organizations" ], "summary": "Get call settings", "description": "REQUIRED SCOPES ['organizations:read']
Get call settings", "operationId": "8812e9e4d886f5d6eade4f572f36adcd", "parameters": [ { "name": "level", "in": "query", "description": "Level of settings (e.g., 'organization', 'team', 'user')", "required": true, "schema": { "type": "string" } }, { "name": "level_id", "in": "query", "description": "ID of the level entity", "required": true, "schema": { "type": "integer" } }, { "name": "organization_id", "in": "query", "description": "ID of the organization", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "ref": "#/components/schemas/CallSettingsResource" } } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "organizations:read" ] } ], "x-versions": [ "public" ] } }, "/organization/call-settings/{title}": { "post": { "tags": [ "Organizations" ], "summary": "Save call settings", "description": "REQUIRED SCOPES ['organizations:write']
Save call settings", "operationId": "c9eb52a0e19233cffb9e861660539d98", "parameters": [ { "name": "title", "in": "path", "description": "The title of the settings", "required": true, "schema": { "type": "string", "example": "call-distribution" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "is_active", "level", "level_id", "organization_id" ], "properties": { "is_active": { "type": "boolean" }, "level": { "description": "Level of settings (e.g., 'organization', 'team', 'user')", "type": "string" }, "level_id": { "description": "ID of the level entity", "type": "integer" }, "organization_id": { "description": "ID of the organization", "type": "integer" }, "settings": { "description": "Call settings to save", "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallSettingsResource" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "organizations:write" ] } ], "x-versions": [ "public" ] } }, "/teams/{team}/call-settings/{title}": { "post": { "tags": [ "Teams" ], "summary": "Save call settings", "description": "REQUIRED SCOPES ['teams:write']
Save call settings", "operationId": "603c2b06b31e7a06f2e463c1ef661f7a", "parameters": [ { "name": "team", "in": "path", "description": "ID of the team", "required": true, "schema": { "type": "integer" } }, { "name": "title", "in": "path", "description": "The title of the settings", "required": true, "schema": { "type": "string", "example": "call-distribution" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "is_active", "level", "level_id", "organization_id" ], "properties": { "is_active": { "type": "boolean" }, "level": { "description": "Level of settings (e.g., 'organization', 'team', 'user')", "type": "string" }, "level_id": { "description": "ID of the level entity", "type": "integer" }, "organization_id": { "description": "ID of the organization", "type": "integer" }, "settings": { "description": "Call settings to save", "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallSettingsResource" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "teams:write" ] } ], "x-versions": [ "public" ] } }, "/voice/voicemail/greeting/synthesize": { "get": { "tags": [ "Voice" ], "summary": "Synthesize a greeting message to speech", "description": "REQUIRED SCOPES ['voice:read']
Synthesize a greeting message to speech", "operationId": "f69c2e20b12469e20ebb73ccab9d11b4", "parameters": [ { "name": "message", "in": "query", "description": "The text message to synthesize", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "audio/mpeg": { "schema": { "type": "string", "format": "binary" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "apiAuth": [ "voice:read" ] } ], "x-versions": [ "public" ] } }, "/voice/ivr/greeting/synthesize": { "get": { "tags": [ "Voice" ], "summary": "Synthesize a greeting message to speech", "description": "REQUIRED SCOPES ['voice:read']
Synthesize a greeting message to speech", "operationId": "da2a629aff9188e5417b7440f82b1d40", "parameters": [ { "name": "message", "in": "query", "description": "The text message to synthesize", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "audio/mpeg": { "schema": { "type": "string", "format": "binary" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "apiAuth": [ "voice:read" ] } ], "x-versions": [ "public" ] } }, "/voice/record/{recordingId}/token": { "get": { "tags": [ "Voice" ], "summary": "Listen to the voice record new", "description": "REQUIRED SCOPES ['voice:read']
Listen to the voice record new", "operationId": "Listen to the voice record new", "parameters": [ { "name": "recordingId", "in": "path", "description": "The ID of the Recording. This string starts with prefix \\'RE\\'.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "audio/wav": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "apiAuth": [ "voice:read" ] } ], "x-versions": [ "public" ] } }, "/voice/record/{recordingId}": { "get": { "tags": [ "Voice" ], "summary": "Listen to the voice record", "description": "REQUIRED SCOPES ['voice:read']
Listen to the voice record", "operationId": "Listen to the voice record", "parameters": [ { "name": "recordingId", "in": "path", "description": "The ID of the Recording. This string starts with prefix \\'RE\\'.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "audio/wav": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "apiAuth": [ "voice:read" ] } ], "x-versions": [ "public" ] } }, "/voice/voicemail/drops": { "get": { "tags": [ "Voice" ], "summary": "Get list of voicemail drop audiofiles", "description": "REQUIRED SCOPES ['voice:read']
Get list of voicemail drop audiofiles", "operationId": "0c80645683399ba673ab04f87f1e1317", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VoicemailDropResource" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "This action is unauthorized." }, "status": { "type": "integer", "example": 403 } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "voice:read" ] } ], "x-versions": [ "public" ] } }, "/voice/voicemail/drops/upload": { "post": { "tags": [ "Voice" ], "summary": "Upload voicemail drop file", "description": "REQUIRED SCOPES ['voice:write']
Upload voicemail drop file", "operationId": "5cf02c5fa992faeb8e062d3f4f61a292", "requestBody": { "description": "Voicemail Drop File", "required": true, "content": { "multipart/form-data": { "schema": { "properties": { "file": { "description": "Audio File", "type": "string", "format": "binary" }, "name": { "title": "Name", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoicemailDropResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "This action is unauthorized." }, "status": { "type": "integer", "example": 403 } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "voice:write" ] } ], "x-versions": [ "public" ] } }, "/voice/voicemail/drops/update/{voicemailDrop}": { "put": { "tags": [ "Voice" ], "summary": "Update voicemail drop name", "description": "REQUIRED SCOPES ['voice:write']
Update voicemail drop name", "operationId": "7ab93f1a0a56b87d0588af84a60f086c", "parameters": [ { "name": "voicemailDrop", "in": "path", "description": "The ID of the Voicemail Drop Audiofile.", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "title": "Name", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoicemailDropResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "This action is unauthorized." }, "status": { "type": "integer", "example": 403 } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "voice:write" ] } ], "x-versions": [ "public" ] } }, "/voice/voicemail/drops/delete/{voicemailDrop}": { "delete": { "tags": [ "Voice" ], "summary": "Delete voicemail drop audiofile", "description": "REQUIRED SCOPES ['voice:write']
Delete voicemail drop audiofile", "operationId": "1cc397ba9d160cb98a7c566fa7b781d6", "parameters": [ { "name": "voicemailDrop", "in": "path", "description": "The ID of the Voicemail Drop Audiofile.", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "This action is unauthorized." }, "status": { "type": "integer", "example": 403 } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "voice:write" ] } ], "x-versions": [ "public" ] } }, "/voice/voicemail-record/{recordingId}": { "get": { "tags": [ "Voice" ], "summary": "Listen to the voicemail record", "description": "REQUIRED SCOPES ['voice:read']
Listen to the voicemail record", "operationId": "Listen to the voicemail record", "parameters": [ { "name": "recordingId", "in": "path", "description": "The ID of the Recording. This string starts with prefix \\'RE\\'.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "audio/wav": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "apiAuth": [ "voice:read" ] } ], "x-versions": [ "public" ] } }, "/voice/voicemail/settings/{team}": { "post": { "tags": [ "Voice" ], "summary": "Update voicemail settings", "description": "REQUIRED SCOPES ['voice:write']
Listen to voice recording", "operationId": "d3859aac59cf781a4b63a1d0a8afa600", "parameters": [ { "name": "team", "in": "path", "description": "The ID of the Team.", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "is_active": { "description": "Enable/disable settings", "type": "boolean", "example": true }, "open_hours_greeting_id": { "description": "The ID of the greeting for regular business hours", "type": "integer", "example": 0 }, "after_hours_greeting_id": { "description": "The ID of the greeting for regular after hours", "type": "integer", "example": 0 }, "is_send_via_email": { "description": "Send recording of voicemails by email", "type": "boolean", "example": false }, "is_directly_voicemail": { "description": "Send incoming calls straight to voicemail", "type": "boolean", "example": false }, "ring_duration": { "description": "The amount of time in seconds before sending call to voicemail", "type": "integer", "example": 15 } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoicemailSettingResource" } } } } }, "security": [ { "apiAuth": [ "voice:write" ] } ], "x-versions": [ "public" ] } }, "/voice/voicemail/greeting/upload/{team}": { "post": { "tags": [ "Voice" ], "summary": "Upload a voicemail greeting", "description": "REQUIRED SCOPES ['voice:write']
Upload a voicemail greeting", "operationId": "cd3e7cc0960b2207faabaf5146d6ba64", "parameters": [ { "name": "team", "in": "path", "description": "The ID of the Team", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "properties": { "file": { "description": "The voicemail greeting audio file", "type": "string", "format": "binary" }, "name": { "description": "The name of the voicemail greeting", "type": "string" }, "type": { "description": "The type of the voicemail greeting", "type": "string", "example": "open_hours" }, "is_make_active": { "description": "Make voicemail greeting active if true", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Team not found" } }, "security": [ { "apiAuth": [ "voice:write" ] } ], "x-versions": [ "public" ] } }, "/voice/voicemail/greeting/update/{greeting}": { "put": { "tags": [ "Voice" ], "summary": "Update voicemail greeting name", "description": "REQUIRED SCOPES ['voice:write']
Update voicemail greeting name", "operationId": "b53ddf089656f56a3e09848afc80f853", "parameters": [ { "name": "greeting", "in": "path", "description": "The ID of the Voicemail Greeting", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "description": "The new name for the voicemail greeting", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Voicemail Greeting not found" } }, "security": [ { "apiAuth": [ "voice:write" ] } ], "x-versions": [ "public" ] } }, "/voice/voicemail/greeting/delete/{greeting}": { "delete": { "tags": [ "Voice" ], "summary": "Delete a voicemail greeting", "description": "REQUIRED SCOPES ['voice:write']
Delete a voicemail greeting", "operationId": "4e4c5ff40244a6baabb5ea5d6d66873d", "parameters": [ { "name": "greeting", "in": "path", "description": "The ID of the Voicemail Greeting to delete", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "success" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Voicemail Greeting not found" } }, "security": [ { "apiAuth": [ "voice:write" ] } ], "x-versions": [ "public" ] } }, "/voice/ivr/greeting/{team}": { "post": { "tags": [ "Voice" ], "summary": "Create a new IVR greeting for a team", "description": "REQUIRED SCOPES ['voice:write']
Create a new IVR greeting for a specific team", "operationId": "40790ed49f00dd87efbbd444a9967f87", "parameters": [ { "name": "team", "in": "path", "description": "The ID of the team", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "properties": { "file": { "description": "The audio file for the IVR greeting", "type": "string", "format": "binary" }, "name": { "description": "The name of the IVR greeting", "type": "string" }, "is_make_active": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "id": { "title": "ID", "type": "integer" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "name": { "title": "Name", "type": "string" }, "content_type": { "title": "Content Type", "type": "string" }, "url": { "title": "URL", "type": "string" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Team not found" } }, "security": [ { "apiAuth": [ "voice:write" ] } ], "x-versions": [ "public" ] } }, "/voice/ivr/greeting/{greeting}": { "put": { "tags": [ "Voice" ], "summary": "Update an existing IVR greeting", "description": "REQUIRED SCOPES ['voice:write']
Update an existing IVR greeting for a specific team", "operationId": "11a2e4922f8bb35b3206bced5e718e2f", "parameters": [ { "name": "greeting", "in": "path", "description": "The ID of the IVR greeting", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "description": "The new name for the ivr greeting", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "id": { "title": "ID", "type": "integer" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "name": { "title": "Name", "type": "string" }, "content_type": { "title": "Content Type", "type": "string" }, "url": { "title": "URL", "type": "string" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "IVR Greeting not found" } }, "security": [ { "apiAuth": [ "voice:write" ] } ], "x-versions": [ "public" ] }, "delete": { "tags": [ "Voice" ], "summary": "Delete an existing IVR greeting", "description": "REQUIRED SCOPES ['voice:write']
Delete an existing IVR greeting for a specific team", "operationId": "218f4ff37c436e4709fbbb016733accd", "parameters": [ { "name": "greeting", "in": "path", "description": "The ID of the IVR greeting to delete", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "status": { "description": "The status of the delete operation", "type": "string", "enum": [ "success", "failed" ] } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "IVR Greeting not found" } }, "security": [ { "apiAuth": [ "voice:write" ] } ], "x-versions": [ "public" ] } }, "/voice/ivr/settings/{team}": { "post": { "tags": [ "Voice" ], "summary": "Set IVR settings for a team", "description": "REQUIRED SCOPES ['voice:write']
Update or create IVR (Interactive Voice Response) settings for a specific team", "operationId": "da5d3d88f0a6cd2dc10b2da681340115", "parameters": [ { "name": "team", "in": "path", "description": "The ID of the team", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IvrSettingRequest" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IvrSettingsResource" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Team not found" } }, "security": [ { "apiAuth": [ "voice:write" ] } ], "x-versions": [ "public" ] } }, "/chats": { "get": { "tags": [ "Website Chat" ], "summary": "Get website chat", "description": "REQUIRED SCOPES ['website-chat:read']
Get website chat", "operationId": "Get website chat", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteChatResource" } } } } }, "security": [ { "apiAuth": [ "website-chat:read" ] } ], "x-versions": [ "public" ] }, "post": { "tags": [ "Website Chat" ], "summary": "Create or update website chat", "description": "REQUIRED SCOPES ['website-chat:write']
Create or update website chat", "operationId": "Create or update website chat", "requestBody": { "content": { "application/json": { "schema": { "properties": { "header": { "description": "Header", "type": "string" }, "phone": { "description": "Phone", "type": "string" }, "team_id": { "description": "Team ID", "type": "string" }, "button": { "description": "Button", "type": "string" }, "color": { "description": "Color", "type": "string" }, "message": { "description": "Message", "type": "string" }, "status": { "description": "Activate", "type": "boolean" }, "domains": { "description": "Domains", "type": "array", "items": { "type": "string" } }, "tags": { "description": "Array of Tag IDs", "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteChatResource" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "properties": { "message": { "title": "message", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "website-chat:write" ] } ], "x-versions": [ "public" ] } }, "/chats/{token}": { "get": { "tags": [ "Website Chat" ], "summary": "Get website chat settings", "description": "REQUIRED SCOPES ['website-chat:read']
Get website chat settings", "operationId": "Get website chat settings", "parameters": [ { "name": "token", "in": "path", "description": "Token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteChatSettingsResource" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "properties": { "message": { "title": "message", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "website-chat:read" ] } ], "x-versions": [ "public" ] } }, "/messages/chats/{token}": { "post": { "tags": [ "Website Chat" ], "summary": "Send a message in a website chat", "description": "REQUIRED SCOPES ['website-chat:write']
Add a new message to an existing website chat identified by its token", "operationId": "441b225355fde0d778cd83c8e40ca177", "parameters": [ { "name": "token", "in": "path", "description": "The token of the website chat", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "number": { "description": "The phone number of the sender", "type": "string" }, "message": { "description": "The content of the message", "type": "string" }, "name": { "description": "The name of the sender", "type": "string" }, "optedIn": { "description": "Whether the sender has opted in", "type": "boolean" }, "email": { "description": "The email of the sender", "type": "string" } }, "type": "object" } } } }, "responses": { "201": { "description": "Message sent successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Message sent successfully" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Chat not found" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Error message" } }, "type": "object" } } } } }, "x-versions": [ "public" ] } }, "/chats/status": { "post": { "tags": [ "Website Chat" ], "summary": "Update website chat status", "description": "REQUIRED SCOPES ['website-chat:write']
Update website chat status", "operationId": "Update website chat status", "requestBody": { "content": { "application/json": { "schema": { "properties": { "status": { "description": "Enable", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteChatResource" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "properties": { "message": { "title": "message", "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [ "website-chat:write" ] } ], "x-versions": [ "public" ] } }, "/core/analytics/calling/export": { "get": { "tags": [ "Analytics" ], "summary": "Export Calling Analytics", "description": "REQUIRED SCOPES ['analytics:read']
", "operationId": "21d547234566f36a01f0513fbd2d7bc4", "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "analytics:read" ] } ], "x-versions": [ "public" ] } }, "/core/analytics/calling": { "get": { "tags": [ "Analytics" ], "summary": "Get calling analytics", "description": "REQUIRED SCOPES ['analytics:read']
Retrieve statistics and charts for inbound and outbound calls within the specified time range.", "operationId": "b69dc913a9bdc4691089f7df66eecf07", "parameters": [ { "name": "from", "in": "query", "description": "Start date for the statistics range (YYYY-MM-DD)", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "End date for the statistics range (YYYY-MM-DD)", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "interval", "in": "query", "description": "Interval for grouping the statistics", "required": true, "schema": { "type": "string", "enum": [ "day", "week", "month", "year" ] } }, { "name": "timezone", "in": "query", "description": "Timezone in which the statistics should be calculated", "required": true, "schema": { "type": "string" } }, { "name": "filter[members]", "in": "query", "description": "Filter by members (comma-separated or array)", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "filter[inboxes]", "in": "query", "description": "Filter by inboxes (comma-separated or array)", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "filter[numbers]", "in": "query", "description": "Filter by numbers (comma-separated or array)", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "filter[tags]", "in": "query", "description": "Filter by tags (comma-separated or array)", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } } ], "responses": { "200": { "description": "Successful response with calling analytics", "content": { "application/json": { "schema": { "properties": { "statistic": { "type": "array", "items": { "$ref": "#/components/schemas/CallingStatistic" }, "example": [ { "key": "outbound_calls", "label": "Outbound Calls", "value": 0, "prevValue": 0, "parent": "" }, { "key": "inbound_calls", "label": "Inbound Calls", "value": 3, "prevValue": 8, "parent": "" }, { "key": "avg_duration_outbound", "label": "Avg Duration Outbound", "value": 0, "prevValue": 0, "parent": "outbound_calls" }, { "key": "answered_outbound", "label": "Answered Outbound", "value": 0, "prevValue": 0, "parent": "outbound_calls" }, { "key": "unanswered_outbound", "label": "Unanswered Outbound", "value": 0, "prevValue": 0, "parent": "outbound_calls" }, { "key": "busy_outbound", "label": "Busy Outbound", "value": 0, "prevValue": 0, "parent": "outbound_calls" }, { "key": "failed_outbound", "label": "Failed Outbound", "value": 0, "prevValue": 0, "parent": "outbound_calls" }, { "key": "avg_duration_inbound", "label": "Avg Duration Inbound", "value": 1, "prevValue": 0, "parent": "inbound_calls" }, { "key": "answered_inbound", "label": "Answered Inbound", "value": 1, "prevValue": 0, "parent": "inbound_calls" }, { "key": "answered_inbound_human", "label": "Answered Inbound Human", "value": 1, "prevValue": 0, "parent": "inbound_calls" }, { "key": "answered_inbound_ai", "label": "Answered Inbound Ai", "value": 0, "prevValue": 0, "parent": "inbound_calls" }, { "key": "missed_inbound", "label": "Missed Inbound", "value": 2, "prevValue": 8, "parent": "inbound_calls" }, { "key": "busy_inbound", "label": "Busy Inbound", "value": 0, "prevValue": 0, "parent": "inbound_calls" }, { "key": "failed_inbound", "label": "Failed Inbound", "value": 0, "prevValue": 0, "parent": "inbound_calls" }, { "key": "forwarded", "label": "Forwarded", "value": 1, "prevValue": 0, "parent": "" }, { "key": "avg_duration_forwarded", "label": "Avg Duration Forwarded", "value": 1, "prevValue": 0, "parent": "forwarded" } ] }, "charts": { "type": "array", "items": { "$ref": "#/components/schemas/CallingChartData" } } }, "type": "object" } } } }, "500": { "description": "Internal server error" } }, "security": [ { "apiAuth": [ "analytics:read" ] } ], "x-versions": [ "public" ] } }, "/core/analytics/contacts": { "get": { "tags": [ "Analytics" ], "summary": "Get Contacts Analytics", "description": "REQUIRED SCOPES ['analytics:read']
", "operationId": "dd705359e04993a5e4a966b90f1846f5", "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "analytics:read" ] } ], "x-versions": [ "public" ] } }, "/core/analytics/contacts/export": { "get": { "tags": [ "Analytics" ], "summary": "Export Contacts Analytics", "description": "REQUIRED SCOPES ['analytics:read']
", "operationId": "a46e430cb1dcb40ff08aef98e76092a2", "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "analytics:read" ] } ], "x-versions": [ "public" ] } }, "/core/analytics/conversations": { "get": { "tags": [ "Analytics" ], "summary": "Get Conversations Analytics", "description": "REQUIRED SCOPES ['analytics:read']
", "operationId": "59b0c779d00e3b47435ad32b17a7b5ac", "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "analytics:read" ] } ], "x-versions": [ "public" ] } }, "/core/analytics/conversations/export": { "get": { "tags": [ "Analytics" ], "summary": "Export Conversations Analytics", "description": "REQUIRED SCOPES ['analytics:read']
", "operationId": "6a46393a3a73ab59e97118aa7a3feb9c", "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "analytics:read" ] } ], "x-versions": [ "public" ] } }, "/core/analytics/conversions/list": { "get": { "tags": [ "Analytics" ], "summary": "Get Conversions List Analytics", "description": "REQUIRED SCOPES ['analytics:read']
", "operationId": "f0a589a2a84ab5dcdaca70c1c93a3d21", "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "analytics:read" ] } ], "x-versions": [ "public" ] } }, "/core/analytics/conversions/{conversion}/chart": { "get": { "tags": [ "Analytics" ], "summary": "Get Conversion Chart", "description": "REQUIRED SCOPES ['analytics:read']
", "operationId": "87182ad2602d1364085e252a9b79a93c", "parameters": [ { "name": "conversion", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "analytics:read" ] } ], "x-versions": [ "public" ] } }, "/core/analytics/conversions/{conversion}/export": { "get": { "tags": [ "Analytics" ], "summary": "Export Conversion", "description": "REQUIRED SCOPES ['analytics:read']
", "operationId": "7387aca3abaa5524f67338f14fce0d45", "parameters": [ { "name": "conversion", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "analytics:read" ] } ], "x-versions": [ "public" ] } }, "/core/analytics/conversions": { "get": { "tags": [ "Analytics" ], "summary": "Get Conversions Analytics", "description": "REQUIRED SCOPES ['analytics:read']
", "operationId": "0db762f086120c66f7a9b886dee278e3", "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "analytics:read" ] } ], "x-versions": [ "public" ] } }, "/core/analytics/conversions/export": { "get": { "tags": [ "Analytics" ], "summary": "Export Conversions Analytics", "description": "REQUIRED SCOPES ['analytics:read']
", "operationId": "60351bef6f121507937a77640155f77e", "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "analytics:read" ] } ], "x-versions": [ "public" ] } }, "/core/analytics/credits-usage/details": { "post": { "tags": [ "Analytics" ], "summary": "Get Credits Usage Details", "description": "REQUIRED SCOPES ['analytics:read']
", "operationId": "96c0c5225700e5f6de06b502f99540b7", "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "analytics:read" ] } ], "x-versions": [ "public" ] } }, "/core/analytics/messages": { "get": { "tags": [ "Analytics" ], "summary": "Get Messages Analytics", "description": "REQUIRED SCOPES ['analytics:read']
", "operationId": "0f8ab5ac152acec1c562b34b001fe68e", "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "analytics:read" ] } ], "x-versions": [ "public" ] } }, "/core/analytics/messages/export": { "get": { "tags": [ "Analytics" ], "summary": "Export Messages Analytics", "description": "REQUIRED SCOPES ['analytics:read']
", "operationId": "0ae3e68644b128286a4929e4970ab12f", "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "analytics:read" ] } ], "x-versions": [ "public" ] } }, "/core/analytics/overall/{section}": { "get": { "tags": [ "Analytics" ], "summary": "Get Overall Analytics", "description": "REQUIRED SCOPES ['analytics:read']
", "operationId": "6c8293cd11fed0eb0ab5b75616bba94f", "parameters": [ { "name": "section", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "messages", "calls", "performance" ] } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "analytics:read" ] } ], "x-versions": [ "public" ] } }, "/core/analytics/performance/members": { "get": { "tags": [ "Analytics" ], "summary": "Get Performance Members Analytics", "description": "REQUIRED SCOPES ['analytics:read']
", "operationId": "3aa47ad353d6fe230625e3888c1dcce9", "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "analytics:read" ] } ], "x-versions": [ "public" ] } }, "/core/analytics/performance": { "get": { "tags": [ "Analytics" ], "summary": "Get Performance Analytics", "description": "REQUIRED SCOPES ['analytics:read']
", "operationId": "31ea585fdc521f8b4f69f91343db2c5b", "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "analytics:read" ] } ], "x-versions": [ "public" ] } }, "/core/analytics/performance/export": { "get": { "tags": [ "Analytics" ], "summary": "Export Performance Analytics", "description": "REQUIRED SCOPES ['analytics:read']
", "operationId": "06923344ad804d676b4ce83c7f0eb9e2", "responses": { "200": { "description": "OK" } }, "security": [ { "apiAuth": [ "analytics:read" ] } ], "x-versions": [ "public" ] } }, "/core/organization/analytics": { "get": { "tags": [ "Organizations" ], "summary": "Get organization analytics", "description": "REQUIRED SCOPES ['organizations:read']
Get organization analytics", "operationId": "getCoreOrganizationAnalytics", "parameters": [ { "name": "from", "in": "query", "description": "Start date for analytics (format: Y-m-d)", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "End date for analytics (format: Y-m-d)", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "timezone", "in": "query", "description": "Timezone for the dates", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for inbox pagination", "schema": { "type": "integer", "default": 1 } }, { "name": "sort", "in": "query", "description": "Field to sort by", "schema": { "type": "string", "default": "name" } }, { "name": "order", "in": "query", "description": "Sort order (asc or desc)", "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "totals": { "type": "array", "items": { "type": "object" } }, "inboxes": { "type": "object" }, "calls": { "type": "array", "items": { "title": "Call Statistics", "properties": { "date": { "title": "Date", "type": "string" }, "label": { "title": "Label", "type": "string" }, "forwarded": { "title": "Forwarded Count", "type": "integer" }, "inbound": { "title": "Inbound Count", "type": "integer" }, "outbound": { "title": "Outbound Count", "type": "integer" }, "total": { "title": "Total Count", "type": "integer" } }, "type": "object" } } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "apiAuth": [ "organizations:read" ] } ], "x-versions": [ "public" ] } } }, "components": { "schemas": { "CallingChartDataCollection": { "title": "Calling Chart Data Collection", "description": "Collection of calling chart data", "properties": { "charts": { "type": "array", "items": { "$ref": "#/components/schemas/CallingChartData" } } }, "type": "object" }, "CallingChartData": { "title": "Calling Chart Data", "description": "Chart data entry for calling analytics", "properties": { "date": { "description": "Date of the data point", "type": "string", "format": "date", "example": "2025-01-10" }, "label": { "description": "Label for the chart data point", "type": "string", "example": "2025-01-10" }, "outbound_calls": { "type": "integer", "example": 0 }, "inbound_calls": { "type": "integer", "example": 3 }, "avg_duration_outbound": { "type": "number", "format": "float", "example": 0 }, "answered_outbound": { "type": "integer", "example": 0 }, "unanswered_outbound": { "type": "integer", "example": 0 }, "busy_outbound": { "type": "integer", "example": 0 }, "failed_outbound": { "type": "integer", "example": 0 }, "avg_duration_inbound": { "type": "number", "format": "float", "example": 1 }, "answered_inbound": { "type": "integer", "example": 1 }, "answered_inbound_human": { "type": "integer", "example": 1 }, "answered_inbound_ai": { "type": "integer", "example": 0 }, "missed_inbound": { "type": "integer", "example": 2 }, "busy_inbound": { "type": "integer", "example": 0 }, "failed_inbound": { "type": "integer", "example": 0 }, "forwarded": { "type": "integer", "example": 1 }, "avg_duration_forwarded": { "type": "number", "format": "float", "example": 1 } }, "type": "object" }, "CallingStatisticCollection": { "title": "Calling Statistic Collection", "description": "Collection of calling statistics", "properties": { "statistic": { "type": "array", "items": { "$ref": "#/components/schemas/CallingStatistic" }, "example": [ { "key": "outbound_calls", "label": "Outbound Calls", "value": 0, "prevValue": 0, "parent": "" }, { "key": "inbound_calls", "label": "Inbound Calls", "value": 3, "prevValue": 8, "parent": "" }, { "key": "avg_duration_outbound", "label": "Avg Duration Outbound", "value": 0, "prevValue": 0, "parent": "outbound_calls" }, { "key": "answered_outbound", "label": "Answered Outbound", "value": 0, "prevValue": 0, "parent": "outbound_calls" }, { "key": "unanswered_outbound", "label": "Unanswered Outbound", "value": 0, "prevValue": 0, "parent": "outbound_calls" }, { "key": "busy_outbound", "label": "Busy Outbound", "value": 0, "prevValue": 0, "parent": "outbound_calls" }, { "key": "failed_outbound", "label": "Failed Outbound", "value": 0, "prevValue": 0, "parent": "outbound_calls" }, { "key": "avg_duration_inbound", "label": "Avg Duration Inbound", "value": 1, "prevValue": 0, "parent": "inbound_calls" }, { "key": "answered_inbound", "label": "Answered Inbound", "value": 1, "prevValue": 0, "parent": "inbound_calls" }, { "key": "answered_inbound_human", "label": "Answered Inbound Human", "value": 1, "prevValue": 0, "parent": "inbound_calls" }, { "key": "answered_inbound_ai", "label": "Answered Inbound Ai", "value": 0, "prevValue": 0, "parent": "inbound_calls" }, { "key": "missed_inbound", "label": "Missed Inbound", "value": 2, "prevValue": 8, "parent": "inbound_calls" }, { "key": "busy_inbound", "label": "Busy Inbound", "value": 0, "prevValue": 0, "parent": "inbound_calls" }, { "key": "failed_inbound", "label": "Failed Inbound", "value": 0, "prevValue": 0, "parent": "inbound_calls" }, { "key": "forwarded", "label": "Forwarded", "value": 1, "prevValue": 0, "parent": "" }, { "key": "avg_duration_forwarded", "label": "Avg Duration Forwarded", "value": 1, "prevValue": 0, "parent": "forwarded" } ] } }, "type": "object" }, "CallingStatistic": { "title": "Calling Statistic", "description": "Statistic entry for calling analytics", "properties": { "key": { "description": "Statistic key", "type": "string", "example": "outbound_calls" }, "label": { "description": "Human-readable label", "type": "string", "example": "Outbound Calls" }, "value": { "description": "Current value of the statistic", "type": "integer", "example": 0 }, "prevValue": { "description": "Previous period value", "type": "integer", "example": 0 }, "parent": { "description": "Parent statistic key", "type": "string", "example": "", "nullable": true } }, "type": "object" }, "CannedMessageResource": { "description": "Class CannedMessageResource", "properties": { "id": { "title": "ID", "type": "integer" }, "owner_id": { "title": "Owner ID", "type": "integer" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "integration_id": { "title": "Integration ID", "type": "integer" }, "public": { "title": "Public", "type": "boolean" }, "title": { "title": "Title", "type": "string" }, "message": { "title": "Message", "type": "string" }, "shortcut": { "title": "Shortcut", "type": "string" }, "media_url": { "title": "Media URLs", "type": "array", "items": { "properties": { "url": { "title": "URL", "type": "string" }, "content_type": { "title": "Content Type", "type": "string" } }, "type": "object" } } }, "type": "object", "xml": { "name": "CannedMessageResource" } }, "ContactCustomFieldResource": { "description": "Class ContactCustomFieldResource", "properties": { "id": { "title": "ID", "type": "integer" }, "custom_field_id": { "title": "Custom Field ID", "type": "integer" }, "contact_id": { "title": "Contact ID", "type": "integer" }, "field_key": { "title": "Field Key", "type": "string" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "text": { "title": "Text", "type": "string" }, "number": { "title": "Number", "type": "integer" }, "date": { "title": "Date", "type": "string" }, "created_at": { "title": "Create Date", "type": "string" }, "updated_at": { "title": "Update Date", "type": "string" }, "value": { "title": "Value Data", "type": "array", "items": { "properties": { "type": { "title": "Type", "type": "string" }, "value": { "title": "Value", "type": "string" } }, "type": "object" } } }, "type": "object", "xml": { "name": "ContactCustomFieldResource" } }, "ContactImportResource": { "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer" }, "organization_id": { "type": "integer" }, "contacts": { "type": "integer" }, "added": { "type": "integer" }, "skipped": { "type": "integer" }, "current": { "type": "integer" }, "approved_at": { "type": "string", "format": "date-time", "nullable": true }, "approved_by": { "type": "integer", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "duplicate_count": { "type": "integer" }, "duplicate_reasons": { "type": "object" }, "failed_at": { "type": "string", "format": "date-time", "nullable": true }, "failed_reason": { "type": "string", "nullable": true }, "finished_at": { "type": "string", "format": "date-time", "nullable": true }, "list": { "type": "null" }, "mapping": { "type": "object" }, "path": { "type": "string" }, "skipped_count": { "type": "integer" }, "skipped_reasons": { "type": "object" }, "started_at": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "user": { "$ref": "#/components/schemas/UserResource" } }, "type": "object" }, "ContactResource": { "description": "Class ContactResource", "properties": { "id": { "title": "ID", "description": "Returns the contact in array format.", "type": "integer" }, "owner_id": { "title": "Owner ID", "type": "integer" }, "color": { "title": "Color", "type": "string" }, "first_name": { "title": "First name", "type": "string" }, "last_name": { "title": "Last name", "type": "string" }, "full_name": { "title": "Full name", "type": "string" }, "email": { "title": "Email", "type": "string" }, "photo_url": { "title": "Photo Url", "type": "string" }, "number": { "title": "Number", "type": "string" }, "country": { "title": "Country", "type": "string" }, "country_calling_code": { "title": "Calling Code", "type": "string" }, "national_number": { "title": "National Number", "type": "string" }, "typeted_number": { "title": "typeted Number", "type": "string" }, "is_blocked": { "title": "typeted Number", "type": "boolean" }, "opt_out": { "title": "Opt Out Status", "type": "boolean" }, "opt_out_at": { "title": "Opt Out Date", "type": "string" }, "opt_in_request_at": { "title": "Opt In Request Date", "type": "string" }, "opt_in_requests": { "title": "Opt In Requests", "type": "array", "items": { "properties": { "number_id": { "title": "Number ID", "type": "integer" } }, "type": "object" } }, "opt_in_at": { "title": "Opt In Date", "type": "string" }, "shortcode_opt_outs": { "title": "Shortcode Opted-out", "type": "array", "items": { "properties": { "id": { "title": "Opt Out ID", "type": "integer" }, "number_id": { "title": "Opt Out Number ID", "type": "integer" }, "name": { "title": "Opt Out Number ID", "type": "string" }, "disabled": { "title": "Disabled", "type": "boolean" }, "timestamp": { "title": "Opt Out Date", "type": "string" }, "value": { "title": "Opt Out Value", "type": "boolean" } }, "type": "object" } }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" }, "integration_vendor_id": { "title": "Integration Vendor Id", "type": "integer" }, "prevent_autolink": { "title": "Prevent Autolink", "type": "boolean" }, "integration": { "title": "Integration", "type": "array", "items": { "properties": { "id": { "title": "Integration ID", "type": "integer" }, "key": { "title": "Integration Key", "type": "string" }, "name": { "title": "Integration Name", "type": "string" }, "photo_url": { "title": "Integration Photo Url", "type": "string" } }, "type": "object" } }, "custom_fields": { "title": "Custom Fields", "type": "array", "items": { "$ref": "#/components/schemas/ContactCustomFieldResource" } }, "tags": { "title": "Tags", "type": "array", "items": { "$ref": "#/components/schemas/ContactTagResource" } }, "notes": { "title": "Notes", "type": "array", "items": { "properties": { "id": { "title": "ID", "type": "integer" }, "text": { "title": "Text", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" } }, "type": "object" } } }, "type": "object", "xml": { "name": "ContactResource" } }, "ContactTagResource": { "description": "Class ContactTagResource", "properties": { "id": { "title": "ID", "type": "integer" }, "name": { "title": "Name", "type": "string" }, "label": { "title": "Label", "type": "string" }, "created_at": { "title": "Created At", "type": "string" } }, "type": "object", "xml": { "name": "ContactTagResource" } }, "ConversationResource": { "description": "Class ConversationResource", "properties": { "id": { "title": "ID", "type": "integer" }, "inbox_id": { "title": "Inbox ID", "type": "integer" }, "contact_id": { "title": "Contact ID", "type": "integer" }, "user_id": { "title": "User ID", "type": "integer" }, "last_message_at": { "title": "Last Message Date", "type": "string" }, "last_manual_message_at": { "title": "Last Manual Message Date", "type": "string" }, "last_read_at": { "title": "Last Read Date", "type": "string" }, "has_tagging": { "title": "Has Tagging", "type": "boolean" }, "tagging_last_message_at": { "title": "Tagging Last Message Date", "type": "string" }, "tagging_last_read_at": { "title": "Tagging Last Read Date", "type": "string" }, "started_at": { "title": "Start Date", "type": "string" }, "closed_at": { "title": "Close Date", "type": "string" }, "owner": { "$ref": "#/components/schemas/UserResource" }, "number_id": { "title": "Number ID", "type": "integer" }, "number": { "$ref": "#/components/schemas/NumberResource" }, "allow_call": { "title": "Call Allowed", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "group_name": { "title": "Group Name", "type": "string" }, "is_group": { "title": "Is Group", "type": "boolean" }, "participants": { "title": "Participants", "type": "array", "items": { "$ref": "#/components/schemas/ContactResource" } }, "reassign_logs": { "title": "Reassign Logs", "type": "array", "items": { "$ref": "#/components/schemas/ReassignLogResource" } } }, "type": "object", "xml": { "name": "ConversationResource" } }, "CustomFieldResource": { "description": "Class CustomFieldResource", "properties": { "id": { "title": "ID", "type": "integer" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "key": { "title": "Key", "type": "string" }, "name": { "title": "Name", "type": "string" }, "type": { "title": "Type", "type": "string" }, "visible": { "title": "Visible", "type": "integer" } }, "type": "object", "xml": { "name": "CustomFieldResource" } }, "MessageMediaResource": { "description": "Class MessageMediaResource", "properties": { "id": { "title": "ID", "type": "integer" }, "content_type": { "title": "Content Type", "type": "string" }, "source": { "title": "Source", "type": "string" }, "source_short": { "title": "Source Short", "type": "string" }, "created_at": { "title": "Created At", "type": "string" } }, "type": "object", "xml": { "name": "MessageMediaResource" } }, "MessageResource": { "description": "Class MessageResource", "properties": { "id": { "title": "ID", "type": "integer" }, "conversation_id": { "title": "Conversation ID", "type": "integer" }, "automated": { "title": "Is Automated", "type": "boolean" }, "status": { "title": "Status", "type": "string" }, "type": { "title": "Type", "type": "string" }, "mms_status": { "title": "MMS Status", "type": "string" }, "body": { "title": "Body", "type": "string" }, "body_raw": { "title": "Body Raw", "type": "string" }, "has_tagging": { "title": "Has Tagging", "type": "boolean" }, "icon": { "title": "Icon", "type": "string" }, "received_at": { "title": "Received At", "type": "string" }, "send_at": { "title": "Send At", "type": "string" }, "queued_at": { "title": "Queued At", "type": "string" }, "sent_at": { "title": "Sent At", "type": "string" }, "delivered_at": { "title": "Delivered At", "type": "string" }, "failed_at": { "title": "Failed At", "type": "string" }, "failed_reason": { "title": "Failed Reason", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "stop_on_response": { "title": "Stop On Response", "type": "boolean" }, "is_hipaa": { "title": "Is HIPAA", "type": "boolean" }, "record": { "title": "Call Recording", "properties": { "id": { "title": "ID", "type": "integer" }, "message_id": { "title": "Message ID", "type": "integer" }, "sid": { "title": "Call SID", "type": "string" }, "record_id": { "title": "Record ID", "type": "string" }, "duration": { "title": "Duration", "type": "integer" }, "status": { "title": "Status", "type": "string" }, "url": { "title": "Url", "type": "string" }, "is_voicemail": { "title": "Is Voicemail", "type": "boolean" }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" } }, "type": "object" }, "user_id": { "title": "User ID", "type": "integer" }, "source_id": { "title": "Source ID", "type": "string" }, "source": { "title": "Source", "type": "string" }, "contact": { "$ref": "#/components/schemas/ContactResource" }, "user": { "$ref": "#/components/schemas/UserResource" }, "pending_mentions": { "title": "Pending Mentions", "type": "array", "items": { "$ref": "#/components/schemas/UserResource" } }, "media": { "title": "Media", "type": "array", "items": { "$ref": "#/components/schemas/MessageMediaResource" } } }, "type": "object", "xml": { "name": "MessageResource" } }, "NumberResource": { "description": "Class NumberResource", "properties": { "id": { "title": "ID", "type": "integer" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "country": { "title": "Country", "type": "string" }, "state": { "title": "State", "type": "string" }, "city": { "title": "City", "type": "string" }, "number": { "title": "Number", "type": "string" }, "number_vendor_id": { "title": "Number Vendor Id", "type": "integer" }, "country_calling_code": { "title": "Calling Code", "type": "string" }, "national_number": { "title": "National Number", "type": "string" }, "formattedNumber": { "title": "Formatted Number", "type": "string" }, "formatted_number": { "title": "Formatted Number", "type": "string" }, "short_code": { "title": "Is Shortcode", "type": "integer" }, "is_landline": { "title": "Is Landline", "type": "integer" }, "is_toll_free": { "title": "Is Toll Free", "type": "boolean" }, "is_mobile": { "title": "Is Mobile", "type": "boolean" }, "is_aircall": { "title": "Is AirCall", "type": "boolean" }, "voice": { "title": "Voice", "type": "boolean" }, "use_organization_call_settings": { "title": "Use Organization Call Settings", "type": "boolean" }, "voice_outbound": { "title": "Voice Outbound", "type": "boolean" }, "mms": { "title": "MMS", "type": "boolean" }, "disabled": { "title": "Is Disabled", "type": "boolean" }, "has_profile": { "title": "Has Profile", "type": "boolean" }, "verified_status": { "title": "Verified Status", "type": "string" }, "area_code": { "title": "Area Code", "properties": { "id": { "title": "ID", "type": "integer" }, "area_code": { "title": "Area Code", "type": "string" }, "state_code": { "title": "State Code", "type": "string" }, "state_name": { "title": "State Name", "type": "string" }, "country_code": { "title": "Country Code", "type": "string" }, "time_zone": { "title": "Time Zone", "type": "string" }, "group_id": { "title": "Group ID", "type": "integer" } }, "type": "object" }, "landline": { "title": "Landline", "properties": { "id": { "title": "ID", "type": "integer" }, "number_id": { "title": "Number ID", "type": "integer" }, "address_sid": { "title": "Address SID", "type": "string" }, "sid": { "title": "SID", "type": "string" }, "document_sid": { "title": "Document SID", "type": "string" }, "status": { "title": "Status", "type": "string" }, "verification_attempts": { "title": "Verification Attempts", "type": "integer" }, "last_verify_attempt_at": { "title": "Last Verify Date", "type": "string" }, "landline_name": { "title": "Landline Name", "type": "string" }, "street_address": { "title": "Street Address", "type": "string" }, "city": { "title": "City", "type": "string" }, "state": { "title": "State", "type": "string" }, "zip_code": { "title": "Zip Code", "type": "string" }, "completed": { "title": "Completed", "type": "integer" }, "created_at": { "title": "Create Date", "type": "string" }, "updated_at": { "title": "Update Date", "type": "string" } }, "type": "object" }, "number_vendor": { "title": "Number Vendor", "properties": { "id": { "title": "ID", "type": "integer" }, "is_active": { "title": "Is Active", "type": "boolean" }, "key": { "title": "Key", "type": "string" }, "name": { "title": "Name", "type": "string" }, "credentials_prefix": { "title": "Credentials Prefix", "type": "string" }, "twilio_sid": { "title": "Twilio SID", "type": "string" }, "twilio_auth_token": { "title": "Twilio Auth Token", "type": "string" }, "is_billable": { "title": "Is Billable", "type": "integer" }, "created_at": { "title": "Create Date", "type": "string" }, "updated_at": { "title": "Update Date", "type": "string" } }, "type": "object" }, "number_caller_id": { "title": "Twilio Caller ID Verification", "properties": { "caller_id_sid": { "title": "Caller Id Verification Id", "type": "string" }, "verified": { "title": "Verified", "type": "boolean" }, "failed_reason": { "title": "Failed Reason", "type": "string" } }, "type": "object" }, "call_forwarding": { "title": "Call Forwarding", "properties": { "id": { "title": "ID", "type": "integer" }, "number_id": { "title": "Number ID", "type": "integer" }, "is_active": { "title": "Is Active", "type": "boolean" }, "is_screening": { "title": "Is Screening", "type": "boolean" }, "is_call_whisper": { "title": "Is Call Whisper", "type": "boolean" }, "call_whisper": { "title": "Call Whisper", "type": "string" }, "country": { "title": "Country", "type": "string" }, "number": { "title": "Number", "type": "string" }, "country_calling_code": { "title": "Calling Code", "type": "string" }, "national_number": { "title": "National Number", "type": "string" }, "formatted_number": { "title": "Formatted Number", "type": "string" }, "extension": { "title": "Extension", "type": "string" }, "created_at": { "title": "Create Date", "type": "string" }, "updated_at": { "title": "Update Date", "type": "string" } }, "type": "object" }, "numberable_id": { "title": "Numberable ID", "type": "integer" }, "numberable_type": { "title": "Numberable Type", "type": "string" }, "numberable": { "oneOf": [ { "title": "Team", "properties": { "id": { "title": "ID", "type": "integer" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "owner_id": { "title": "Owner ID", "type": "integer" }, "team_id": { "title": "Team ID", "type": "integer" }, "name": { "title": "Name", "type": "string" }, "created_at": { "title": "Create Date", "type": "string" }, "updated_at": { "title": "Update Date", "type": "string" } }, "type": "object" }, { "title": "Shortcode", "properties": { "id": { "title": "ID", "type": "integer" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "owner_id": { "title": "Owner ID", "type": "integer" }, "name": { "title": "Name", "type": "string" }, "inbox_identifier": { "title": "Inbox Identifier", "type": "string" }, "last_assigned_user_id": { "title": "Last Assigned User ID", "type": "integer" }, "default_assigned_user_id": { "title": "Default Assigne User ID", "type": "integer" } }, "type": "object" } ] } }, "type": "object", "xml": { "name": "NumberResource" } }, "OrganizationResource": { "description": "Class OrganizationResource", "properties": { "id": { "title": "ID", "type": "integer" }, "owner_id": { "title": "Owner ID", "type": "integer" }, "number_vendor_id": { "title": "Number Vendor ID", "type": "integer" }, "name": { "title": "Name", "type": "string" }, "photo_url": { "title": "Photo url", "type": "string" } }, "type": "object", "xml": { "name": "OrganizationResource" } }, "ReassignLogResource": { "description": "Class ReassignLogResource", "properties": { "id": { "title": "ID", "type": "integer" }, "conversation_id": { "title": "Conversation ID", "type": "integer" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "changer_user": { "title": "Change User", "type": "array", "items": { "properties": { "user_id": { "title": "User ID", "type": "integer" }, "first_name": { "title": "First Name", "type": "string" }, "last_name": { "title": "Last Name", "type": "string" } }, "type": "object" } }, "current_user": { "title": "Current User", "type": "array", "items": { "properties": { "user_id": { "title": "User ID", "type": "integer" }, "first_name": { "title": "First Name", "type": "string" }, "last_name": { "title": "Last Name", "type": "string" } }, "type": "object" } }, "created_at": { "title": "Created At", "type": "string" } }, "type": "object", "xml": { "name": "ReassignLogResource" } }, "TagResource": { "description": "Class TagResource", "properties": { "id": { "title": "ID", "type": "integer" }, "owner_id": { "title": "Owner ID", "type": "integer" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "label": { "title": "Label", "type": "string" }, "name": { "title": "Name", "type": "string" }, "type": { "title": "Type", "type": "string" }, "classname": { "title": "Class Name", "type": "string" } }, "type": "object", "xml": { "name": "TagResource" } }, "UserDeviceResource": { "description": "Class UserDeviceResource", "properties": { "id": { "title": "ID", "type": "integer" }, "type": { "$ref": "#/components/schemas/UserDeviceTypeResource" }, "push_token": { "title": "Push Token", "type": "string" } }, "type": "object", "xml": { "name": "UserDeviceResource" } }, "UserDeviceTypeResource": { "description": "Class UserDeviceTypeResource", "properties": { "id": { "title": "ID", "type": "integer" }, "name": { "title": "Name", "type": "string" }, "slug": { "title": "Slug", "type": "integer" } }, "type": "object", "xml": { "name": "UserDeviceTypeResource" } }, "UserResource": { "description": "Class UserResource", "properties": { "id": { "title": "ID", "type": "integer" }, "email": { "title": "Email", "type": "string" }, "first_name": { "title": "First Name", "type": "string" }, "last_name": { "title": "Last Name", "type": "string" }, "full_name": { "title": "Full Name", "type": "string" }, "role": { "title": "Role", "type": "string" }, "inbox_id": { "title": "Inbox ID", "type": "integer" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "photo_url": { "title": "Photo URL", "type": "string" }, "unread": { "title": "Unread Total", "type": "integer" }, "number": { "title": "Number", "type": "string" }, "formatted_number": { "title": "Formatted Number", "type": "string" }, "isRingEverywhere": { "title": "Ring Everywhere", "type": "boolean" }, "organizationNumber": { "title": "Organization Number", "type": "array", "items": { "properties": { "id": { "title": "ID", "type": "integer" }, "country": { "title": "Country", "type": "string" }, "number": { "title": "Number", "type": "string" }, "formatted_number": { "title": "Formatted Number", "type": "string" }, "mms": { "title": "MMS", "type": "string" } }, "type": "object" } }, "userPermissions": { "title": "User Permissions", "type": "array", "items": { "type": "string" } } }, "type": "object", "xml": { "name": "UserResource" } }, "VoicemailDropResource": { "description": "Class VoicemailDropResource", "properties": { "id": { "title": "ID", "type": "integer" }, "user_id": { "title": "User ID", "type": "integer" }, "name": { "title": "Name", "type": "string" }, "content_type": { "title": "Content Type", "type": "string" }, "url": { "title": "URL", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" }, "duration": { "title": "Duration", "type": "integer" } }, "type": "object", "xml": { "name": "VoicemailDropResource" } }, "VoicemailSettingResource": { "description": "Class VoicemailSettingResource", "properties": { "id": { "title": "ID", "type": "integer" }, "owner_id": { "title": "Owner ID", "type": "integer" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "team_id": { "title": "Team ID", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "is_send_via_email": { "title": "Is send via email", "type": "boolean" }, "open_hours_greeting_id": { "title": "Open hours greeting ID", "type": "integer" }, "after_hours_greeting_id": { "title": "After hours greeting ID", "type": "integer" } }, "type": "object", "xml": { "name": "VoicemailSettingResource" } }, "AttachmentResource": { "properties": { "source": { "title": "Source", "description": "Transform the resource into an array.", "type": "string" }, "source_short": { "title": "Source Short", "type": "string" }, "content_type": { "title": "Content Type", "type": "string" } }, "type": "object", "xml": { "name": "AttachmentResource" } }, "AllBroadcast": { "xml": { "name": "AllBroadcast" } }, "Broadcast": { "description": "Class Broadcast", "properties": { "id": { "title": "ID", "description": "Transform the resource into an array.", "type": "integer" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "owner_id": { "title": "Owner ID", "type": "string" }, "number_id": { "title": "Number ID", "type": "string" }, "team_id": { "title": "Team ID", "type": "string" }, "is_send_now": { "title": "Is send now", "type": "string" }, "name": { "title": "Name", "type": "string" }, "status": { "title": "Status", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" }, "sent_at": { "title": "Sent At", "type": "string" }, "send_at": { "title": "Send At", "type": "string" }, "contacts": { "title": "Contacts", "type": "array", "items": { "$ref": "#/components/schemas/ContactResource" } } }, "type": "object", "xml": { "name": "Broadcast" } }, "FailedMessages": { "description": "Class FailedMessages", "properties": { "id": { "title": "ID", "description": "Transform the resource collection into an array.", "type": "integer" } }, "type": "object", "xml": { "name": "FailedMessages" } }, "ClickToTextLinkLeadResource": { "title": "Click-to-Text Link Lead Resource", "description": "Resource representing a click-to-text link lead", "properties": { "id": { "description": "The unique identifier of the lead", "type": "integer", "example": 1 }, "contact": { "description": "Contact information associated with the lead", "type": "object", "nullable": true }, "send_time": { "description": "ISO8601 formatted timestamp when the message was received", "type": "string", "format": "date-time", "example": "2024-03-20T10:00:00Z", "nullable": true } }, "type": "object" }, "ClickToTextLinkResource": { "xml": { "name": "ClickToTextLinkResource" } }, "ClickToTextLinkVisitResource": { "title": "Click-to-Text Link Visit Resource", "description": "Resource representing a click-to-text link visit", "properties": { "location": { "description": "Formatted location of the visit", "type": "string", "example": "New York, NY, USA" }, "device_type": { "description": "Type of device used for the visit", "type": "string", "example": "mobile" }, "link_opened_at": { "description": "ISO8601 formatted timestamp when the link was opened", "type": "string", "format": "date-time", "example": "2024-03-20T10:00:00Z" } }, "type": "object" }, "ComplianceSummaryResource": { "title": "Compliance Summary Resource", "description": "A Compliance Summary resource representation", "properties": { "organization_id": { "description": "Organization ID", "type": "integer", "example": 123 }, "has_tax_id": { "description": "Indicates if the organization has a tax ID", "type": "boolean", "example": true }, "target_country": { "description": "Target country for compliance", "type": "string", "example": "US" }, "numbers_type": { "description": "Type of numbers associated with compliance", "type": "string", "example": "ALL" }, "approved_campaigns": { "description": "List of approved campaigns", "type": "array", "items": { "properties": { "id": { "description": "Campaign ID", "type": "integer", "example": 123 }, "vendor_id": { "description": "Vendor ID associated with the campaign", "type": "string", "example": "C123345" }, "number_vendor_key": { "description": "Vendor ID associated with the campaign", "type": "string", "example": "twilio" } }, "type": "object" } }, "ten_dlc_limits_reached": { "description": "Indicates if the 10DLC limits have been reached", "type": "boolean", "example": false }, "ten_dlc_registration_submitted": { "description": "Indicates if the 10DLC registration has been submitted", "type": "boolean", "example": true }, "vetting_score": { "description": "Vetting score of the organization", "type": "integer", "example": 85 }, "banners_closed": { "description": "Indicates whether compliance banners are closed", "type": "boolean", "example": false }, "tax_id_banner_closed": { "description": "Indicates whether the Tax ID banner is closed", "type": "boolean", "example": false } }, "type": "object" }, "AppContactNoteResource": { "properties": { "id": { "description": "Note ID", "type": "integer" }, "text": { "description": "Note text", "type": "string" }, "contact_id": { "description": "Contact ID", "type": "integer" }, "created_by": { "properties": { "id": { "description": "User ID", "type": "integer" }, "first_name": { "description": "First name", "type": "string" }, "last_name": { "description": "Last name", "type": "string" }, "photo_url": { "description": "Photo URL", "type": "string" } }, "type": "object", "nullable": true }, "updated_by": { "properties": { "id": { "description": "User ID", "type": "integer" }, "first_name": { "description": "First name", "type": "string" }, "last_name": { "description": "Last name", "type": "string" }, "photo_url": { "description": "Photo URL", "type": "string" } }, "type": "object", "nullable": true }, "created_at": { "description": "Creation timestamp", "type": "string", "format": "date-time" }, "updated_at": { "description": "Last update timestamp", "type": "string", "format": "date-time" }, "isAutomated": { "description": "Indicates if the note is automated", "type": "boolean" }, "source_title": { "description": "Source title if automated", "type": "string", "nullable": true } }, "type": "object", "xml": { "name": "AppContactNoteResource" } }, "ConversationParticipantResource": { "properties": { "id": { "title": "ID", "type": "integer" }, "conversation_id": { "title": "Conversation ID", "type": "integer" }, "participant_type": { "title": "Participant type", "type": "string" }, "participant_id": { "title": "Participant ID", "type": "integer" }, "twilio_participant_id": { "title": "Twilio Participant ID", "type": "string" }, "contact": { "title": "Contact", "type": "object" }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" } }, "type": "object", "xml": { "name": "ConversationParticipantResource" } }, "ConversionResource": { "properties": { "id": { "title": "ID", "description": "Transform the resource into an array.", "type": "integer" }, "name": { "title": "Name", "type": "string" }, "currency": { "title": "Currency", "type": "string" }, "verified_at": { "title": "Verified At", "type": "string" }, "default_value": { "title": "Default Value", "type": "string" }, "conversion_url": { "title": "Conversion URL", "type": "string" }, "conversion_attribution": { "title": "Conversion Attribution", "type": "string" }, "analytics": { "title": "analytics", "type": "object" } }, "type": "object", "xml": { "name": "ConversionResource" } }, "FeatureResource": { "description": "Represents a feature resource", "properties": { "key": { "description": "The key of the feature", "type": "string" }, "settings": { "description": "The settings of the feature", "type": "object" } }, "type": "object" }, "GroupResource": { "title": "Group Resource", "description": "Group resource with detailed information", "properties": { "id": { "description": "The unique identifier of the group", "type": "integer", "example": 1 }, "name": { "description": "The name of the group", "type": "string", "example": "Development Team" }, "description": { "description": "The description of the group", "type": "string", "example": "This group handles all development tasks", "nullable": true }, "members": { "description": "List of group members (lightweight user info)", "type": "array", "items": { "properties": { "id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "full_name": { "type": "string" }, "photo_url": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } }, "type": "object" } }, "is_integration_team": { "description": "Indicates whether the group is an integration team", "type": "boolean", "example": false }, "integration_team": { "description": "Nested object if this group is linked to an integration team", "properties": { "id": { "description": "The unique identifier of the integration team", "type": "integer", "example": 10 }, "name": { "description": "The name of the integration team", "type": "string", "example": "Core Integration Team" } }, "type": "object" } }, "type": "object", "xml": { "name": "GroupResource" } }, "AutomationLogStepResource": { "properties": { "id": { "title": "ID", "type": "string" }, "url": { "title": "URL", "type": "string" }, "payload": { "title": "Payload", "type": "string" }, "action": { "title": "Action", "type": "string" }, "callback_id": { "title": "Request ID", "type": "string" }, "step": { "title": "Step", "type": "string" }, "entity_type": { "title": "Entity", "type": "string" }, "entity_id": { "title": "Entity ID", "type": "string" }, "contact_phone": { "title": "Contact Phone Number", "type": "string" }, "contact_name": { "title": "Contact Name", "type": "string" }, "status": { "title": "Status", "type": "string" }, "result": { "title": "Result", "properties": { "title": { "type": "string", "example": "Custom result title text" }, "type": { "type": "string", "example": "undelivered" } }, "type": "object" }, "executed_at": { "title": "Executed At", "type": "string" } }, "type": "object", "xml": { "name": "AutomationLogStepResource" } }, "IntegrationUserResource": { "title": "Integration User Resource", "properties": { "id": { "description": "Primary ID", "type": "integer", "example": 2 }, "integration_id": { "type": "integer", "example": 2 }, "user_id": { "type": "integer", "example": 20 }, "crm_user_id": { "type": "string", "example": "70026866" }, "organization_id": { "type": "integer", "example": 20 }, "credential_id": { "type": "integer", "example": 0 }, "crm_id": { "type": "string", "example": "47135164" }, "first_name": { "type": "string", "example": "Daniil" }, "last_name": { "type": "string", "example": "Pitertsev" }, "email": { "type": "string", "format": "email", "example": "dpitertsev@neklo.com" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-08-21T22:26:40.000000Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2024-09-17T10:36:50.000000Z" }, "provider_user_id": { "type": "string", "example": "70026866", "nullable": true }, "status": { "type": "string", "example": "invated", "nullable": true }, "user": { "properties": { "id": { "type": "integer", "example": 20 }, "organization_id": { "type": "integer", "example": 20 }, "settings": { "type": "string", "example": null, "nullable": true }, "current_tutorial_step": { "type": "string", "example": null, "nullable": true }, "tutorial_completed_at": { "type": "string", "format": "date-time", "example": null, "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2024-08-21T21:58:53.000000Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2024-10-01T10:46:21.000000Z" }, "disabled": { "type": "boolean", "example": null, "nullable": true }, "device_id": { "type": "string", "example": null, "nullable": true }, "device_type": { "type": "string", "example": null, "nullable": true }, "current_team_type_id": { "type": "integer", "example": 9 }, "current_team_type": { "type": "integer", "example": 2 }, "is_require_number": { "type": "boolean", "example": false }, "is_record_automatically": { "type": "boolean", "example": true }, "default_team_id": { "type": "integer", "example": null, "nullable": true }, "away_status_at": { "type": "string", "format": "date-time", "example": null, "nullable": true }, "dlc_banner_show_at": { "type": "string", "format": "date-time", "example": null, "nullable": true }, "is_require_pft_number": { "type": "boolean", "example": false }, "is_pft_trial_flow": { "type": "boolean", "example": false }, "profile_id": { "type": "integer", "example": 20 } }, "type": "object", "nullable": true }, "invitation": { "properties": { "id": { "type": "integer", "example": 1 }, "email": { "type": "string", "example": "test@example.com" }, "owner_id": { "type": "integer", "example": 111 }, "user_id": { "type": "integer", "example": 111 }, "team_id": { "type": "integer", "example": 111 } }, "type": "object" }, "meta": { "properties": { "id": { "type": "string", "example": "1544761277" }, "type": { "type": "string", "example": "PERSON" }, "userId": { "type": "integer", "example": 70026866 }, "userIdIncludingInactive": { "type": "integer", "example": 70026866 }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-08-21T09:27:23.642Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-08-21T09:27:23.642Z" }, "archived": { "type": "boolean", "example": false } }, "type": "object" }, "crm_owner_id": { "type": "string", "example": "1544761277" }, "has_duplicates": { "description": "Indicates if this CRM user has duplicates", "type": "boolean", "example": false } }, "type": "object" }, "KeywordResource": { "properties": { "id": { "title": "ID", "type": "integer" }, "owner_id": { "title": "Owner ID", "type": "integer" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "is_active": { "title": "Active", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "message": { "title": "Message", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" }, "disabled_at": { "title": "Disabled At", "type": "string" } }, "type": "object", "xml": { "name": "KeywordResource" } }, "KeywordSubscribedContactsResource": { "properties": { "id": { "title": "ID", "type": "integer" }, "owner_id": { "title": "Owner ID", "type": "integer" }, "organization_id": { "title": "Organization ID", "type": "integer" }, "archived_at": { "title": "Archived At", "type": "boolean" }, "area_code_id": { "title": "Area Code Id", "type": "integer" }, "carrier_name": { "title": "Carrier Name", "type": "string" }, "color": { "title": "Color", "type": "string" }, "color_index": { "title": "Color Index", "type": "integer" }, "country": { "title": "Country", "type": "string" }, "country_calling_code": { "title": "Country Calling Code", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "disabled": { "title": "Disabled", "type": "boolean" }, "first_name": { "title": "First Name", "type": "string" }, "formatted_number": { "title": "Formatted Number", "type": "string" }, "full_name": { "title": "Full Name", "type": "string" }, "integration_id": { "title": "Integration Id", "type": "integer" }, "invalid_reason": { "title": "Invalid Reason", "type": "string" }, "is_archived": { "title": "Is Archived", "type": "boolean" }, "is_blocked": { "title": "Is Blocked", "type": "boolean" }, "is_invalid": { "title": "Is Invalid", "type": "boolean" }, "is_subscribed": { "title": "Is Subscribed", "type": "boolean" }, "last_name": { "title": "Last Name", "type": "string" }, "lookup_type": { "title": "Lookup Type", "type": "string" }, "national_number": { "title": "National Number", "type": "string" }, "number": { "title": "Number", "type": "string" }, "opt_in_at": { "title": "Opt In At", "type": "string" }, "opt_in_request_at": { "title": "Opt In Request At", "type": "string" }, "opt_out": { "title": "Opt Out", "type": "string" }, "opt_out_at": { "title": "Opt Out At", "type": "string" }, "opt_out_status": { "title": "Opt Out Status", "type": "string" }, "photo_url": { "title": "Photo Url", "type": "string" }, "prevent_autolink": { "title": "Prevent Autolink", "type": "boolean" }, "source": { "title": "Source", "type": "string" }, "unlinked": { "title": "Unlinked", "type": "boolean" }, "updated_at": { "title": "Updated At", "type": "string" } }, "type": "object", "xml": { "name": "KeywordSubscribedContactsResource" } }, "NumberVendor": { "properties": { "id": { "title": "ID", "type": "number" }, "name": { "title": "Name", "type": "string" }, "text": { "title": "Text", "type": "string" }, "Key": { "title": "Key", "type": "string" } }, "type": "object", "xml": { "name": "NumberVendor" } }, "OrganizationLiteResource": { "title": "OrganizationLiteResource", "description": "A simplified representation of an Organization", "properties": { "id": { "description": "Unique identifier of the organization", "type": "integer", "example": 1 }, "name": { "description": "Name of the organization", "type": "string", "example": "SalesMessage Inc." }, "country": { "description": "Country where the organization is registered", "type": "string", "example": "US" }, "is_agency": { "description": "Indicates if the organization is an agency", "type": "boolean", "example": true }, "agency_id": { "description": "ID of the agency this organization belongs to", "type": "integer", "example": 321, "nullable": true }, "vendor_id": { "description": "Vendor ID associated with the organization", "type": "string", "example": "vnd-567", "nullable": true }, "stripe_id": { "description": "Stripe customer ID", "type": "string", "example": "stripe-5678", "nullable": true }, "created_at": { "description": "Timestamp when the organization was created", "type": "string", "format": "date-time", "example": "2024-03-18T14:23:00Z" }, "updated_at": { "description": "Timestamp when the organization was last updated", "type": "string", "format": "date-time", "example": "2024-03-19T10:15:00Z" } }, "type": "object" }, "QuietHoursSettingsResource": { "properties": { "is_active": { "title": "Is Active", "type": "boolean" }, "is_block_on_weekend": { "title": "Is Block on Weekend", "type": "boolean" }, "allowed_time_from": { "title": "Allowed Time From", "type": "string" }, "allowed_time_to": { "title": "Allowed Time To", "type": "string" } }, "type": "object", "xml": { "name": "QuietHoursSettingsResource" } }, "OrganizationFilter": { "description": "App\\Organizations\\OrganizationFilter", "xml": { "name": "OrganizationFilter" } }, "CampaignContactsResource": { "properties": { "id": { "type": "integer" }, "campaign_id": { "type": "integer" }, "contact_id": { "type": "integer" }, "status": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "contact": { "type": "array", "items": { "$ref": "#/components/schemas/ContactResource" } }, "campaign": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignResource" } }, "call_statistic": { "type": "array", "items": { "$ref": "#/components/schemas/CallingStatistic" } } }, "type": "object", "xml": { "name": "CampaignContactsResource" } }, "CampaignResource": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "status": { "type": "string" }, "filter": { "type": "array", "items": {} }, "contacts_id_processed": { "type": "array", "items": { "type": "integer" } }, "started_by": { "type": "integer" }, "send_from": { "description": "Send From", "properties": { "type": { "type": "string" }, "options": { "properties": { "number_id": { "type": "integer" } }, "type": "object" } }, "type": "object" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "enrolled": { "type": "integer" }, "contacted": { "type": "integer" }, "not_contacted": { "type": "integer" }, "answered": { "type": "integer" }, "no_answered": { "type": "integer" }, "skipped": { "type": "integer" } }, "type": "object", "xml": { "name": "CampaignResource" } }, "ProfileResource": { "title": "Profile Resource", "description": "Profile resource representation", "properties": { "id": { "type": "integer", "example": 1 }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "full_name": { "type": "string", "example": "John Doe" }, "photo_url": { "type": "string", "format": "url", "example": "https://example.com/photo.jpg" }, "formatted_number": { "type": "string", "example": "+1 (555) 123-4567" }, "number": { "type": "string", "example": "15551234567" }, "country": { "type": "string", "example": "US" }, "country_calling_code": { "type": "string", "example": "1" }, "email": { "type": "string", "format": "email", "example": "john.doe@example.com" }, "timezone": { "type": "string", "example": "America/New_York", "nullable": true } }, "type": "object" }, "RCSSender": { "properties": { "id": { "type": "integer" }, "organization_id": { "type": "integer" }, "inbox_id": { "type": "integer", "nullable": true }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "vendor_id": { "type": "string", "nullable": true }, "fallback_inbox_id": { "type": "integer", "nullable": true }, "logo_path": { "type": "string", "nullable": true }, "accent_color": { "type": "string", "nullable": true }, "banner_path": { "type": "string", "nullable": true }, "contact_phones": { "type": "array", "items": { "type": "string" } }, "contact_emails": { "type": "array", "items": { "type": "string" } }, "website_urls": { "type": "array", "items": { "type": "string" } }, "privacy_policy_url": { "type": "string", "nullable": true }, "terms_url": { "type": "string", "nullable": true }, "organization_number_vendor_service_id": { "type": "integer", "nullable": true }, "compliance_status": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "SmartViewResource": { "title": "Smart View", "description": "Smart view resource", "properties": { "id": { "description": "Smart view ID", "type": "integer", "example": 1 }, "name": { "description": "Smart view name", "type": "string", "example": "My contacts" }, "filters": { "description": "Filter configuration (JSON object)", "type": "object" }, "is_favorite": { "description": "Whether the smart view is marked as favorite", "type": "boolean", "example": false }, "unread_count": { "description": "Unread messages count", "type": "integer", "example": 10 } }, "type": "object" }, "StatusServiceResource": { "properties": { "id": { "title": "ID", "type": "number" }, "name": { "title": "Name", "type": "string" }, "online": { "title": "Online", "type": "boolean" } }, "type": "object", "xml": { "name": "StatusServiceResource" } }, "TeamMessagingChannelResource": { "xml": { "name": "TeamMessagingChannelResource" }, "allOf": [ { "$ref": "#/components/schemas/TeamResource" }, { "description": "Extends TeamResource while deprecating per-channel fields in favor of unified messaging_channel payload.", "properties": { "number": { "description": "Deprecated; not returned in this resource.", "readOnly": true, "example": null, "nullable": true, "deprecated": true }, "numbers": { "description": "Deprecated; not returned in this resource.", "type": "array", "items": { "$ref": "#/components/schemas/NumberResource" }, "readOnly": true, "deprecated": true }, "numbers_count": { "description": "Deprecated; not returned in this resource.", "readOnly": true, "example": null, "nullable": true, "deprecated": true }, "rcs_sender": { "description": "Deprecated; not returned in this resource.", "readOnly": true, "example": null, "nullable": true, "deprecated": true }, "messaging_channel_type": { "description": "Type of messaging channel currently assigned to the team.", "type": "string", "enum": [ "number", "shortcode_number", "rcs_sender" ] }, "messaging_channel_entity": { "description": "Messaging channel payload that corresponds to messaging_channel_type.", "oneOf": [ { "$ref": "#/components/schemas/RCSSender" }, { "required": [ "number", "numbers" ], "properties": { "number": { "$ref": "#/components/schemas/NumberResource" }, "numbers": { "type": "array", "items": { "$ref": "#/components/schemas/NumberResource" } } }, "type": "object" } ] } }, "type": "object" } ] }, "TeamResource": { "description": "Class TeamResource", "properties": { "id": { "type": "integer" }, "organization_id": { "type": "integer" }, "owner_id": { "type": "integer" }, "default_assigned_user_id": { "type": "integer" }, "is_smart": { "type": "boolean" }, "is_round_robin": { "type": "boolean" }, "color_coding_enabled": { "type": "boolean" }, "use_global_conversation_history": { "type": "boolean" }, "use_conversation_history": { "type": "boolean" }, "round_robin_users": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "deprioritized_numbers": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "is_geomatch": { "type": "boolean" }, "is_hubspot_assignment": { "type": "boolean" }, "name": { "type": "string" }, "inbox_identifier": { "type": "string" }, "email_to_sms": { "type": "string", "example": null, "nullable": true }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "disabled": { "type": "boolean", "example": null, "nullable": true }, "users_count": { "type": "integer" }, "member_ids": { "type": "array", "items": { "type": "integer" } }, "business_hours": { "type": "object", "example": null, "nullable": true }, "unread": { "type": "integer", "example": 0 }, "unread_calls": { "type": "integer", "example": 4 }, "unread_messages_count": { "type": "integer", "example": 7 }, "unread_mentions_count": { "type": "integer", "example": 2 }, "number": { "$ref": "#/components/schemas/NumberResource" }, "call_via_aircall": { "type": "boolean", "example": null, "nullable": true }, "numbers": { "type": "array", "items": { "$ref": "#/components/schemas/NumberResource" } }, "numbers_count": { "type": "integer" }, "voicemail": { "type": "object", "example": null, "nullable": true }, "ivr": { "type": "object", "example": null, "nullable": true }, "owner": { "type": "object", "example": null, "nullable": true }, "is_favorite": { "type": "boolean", "example": false }, "type": { "type": "string", "example": "inbox" }, "followup": { "type": "object", "example": null, "nullable": true } }, "type": "object", "xml": { "name": "TeamResource" } }, "TeamsGroupResource": { "properties": { "id": { "type": "integer" }, "organization_id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object", "xml": { "name": "TeamsGroupResource" } }, "Trigger": { "title": "Trigger", "description": "Trigger resource", "properties": { "id": { "description": "ID of the trigger", "type": "integer" }, "organization_id": { "description": "ID of the organization", "type": "integer" }, "integration_id": { "description": "ID of the integration", "type": "string" }, "owner_id": { "description": "ID of the owner", "type": "integer" }, "organization_number_id": { "description": "ID of the organization number", "type": "integer" }, "number_id": { "description": "ID of the number", "type": "integer" }, "team_id": { "description": "ID of the team", "type": "integer" }, "is_active": { "description": "Indicates if the trigger is active", "type": "boolean" }, "name": { "description": "Name of the trigger", "type": "string" }, "type": { "description": "Type of the trigger", "type": "string" }, "service_property": { "description": "Service property of the trigger", "type": "string" }, "owner_property": { "description": "Owner property of the trigger", "type": "string" }, "message": { "description": "Message of the trigger", "type": "string" }, "media_url": { "description": "Media URL of the trigger", "type": "array", "items": { "type": "string" } }, "last_received_date": { "description": "Last received date of the trigger", "type": "string", "format": "date-time" }, "disabled_at": { "description": "Disabled date of the trigger", "type": "string", "format": "date-time" }, "created_at": { "description": "Creation date of the trigger", "type": "string", "format": "date-time" }, "updated_at": { "description": "Last update date of the trigger", "type": "string", "format": "date-time" }, "integration_name": { "description": "Name of the integration", "type": "string" }, "tag_ids": { "description": "IDs of the tags", "type": "array", "items": { "type": "integer" } }, "integration": { "description": "Integration details", "type": "object" }, "webhook": { "description": "Webhook details", "type": "object" }, "number": { "description": "Number details", "type": "object" }, "team": { "description": "Team details", "type": "object" }, "tags": { "description": "Tags details", "type": "array", "items": { "type": "object" } }, "statistics": { "description": "Statistics details", "type": "array", "items": { "type": "object" } }, "short_urls": { "description": "Short URLs details", "type": "array", "items": { "type": "object" } }, "owner": { "description": "Owner details", "type": "object" }, "analytics": { "description": "Analytics details", "type": "object" }, "is_track_conversion": { "description": "Indicates if the trigger tracks conversion", "type": "boolean" }, "conversion_id": { "description": "ID of the conversion", "type": "integer" }, "is_rvm": { "description": "Indicates if the trigger is RVM", "type": "boolean" }, "send_form": { "description": "Send frim information", "type": "array", "items": { "type": "integer" } }, "all_statistics": { "description": "Statistics", "type": "array", "items": { "type": "integer" } } }, "type": "object" }, "BusinessInformationResource": { "title": "Business Information Resource", "description": "Business information resource", "required": [ "business_name", "street_address_1", "city", "state", "country", "postal_code" ], "properties": { "business_name": { "description": "Business name", "type": "string" }, "business_type": { "description": "Type of business", "type": "string" }, "business_type_id": { "description": "ID of business type", "type": "string" }, "city": { "description": "City", "type": "string" }, "country": { "description": "Country", "type": "string" }, "industry": { "description": "Business industry", "type": "string" }, "street_address_1": { "description": "Primary street address", "type": "string" }, "street_address_2": { "description": "Secondary street address", "type": "string" }, "business_industry": { "description": "Business industry", "type": "string" }, "ein": { "description": "Employer Identification Number", "type": "string" }, "street_address": { "description": "Street address", "type": "string" }, "reg_progress_status": { "description": "Registration Progress Status", "type": "string" }, "social_media_url": { "description": "Social media URL", "type": "string" }, "state": { "description": "State", "type": "string" }, "state_id": { "description": "ID of state", "type": "string" }, "postal_code": { "description": "Postal code", "type": "string" }, "business_registration_type": { "description": "Business registration type", "type": "string" }, "business_region": { "description": "Business region", "type": "string" }, "website_url": { "description": "Business website URL", "type": "string" }, "regions_of_operation": { "description": "Regions of operation", "type": "string" }, "business_location": { "description": "Business location", "type": "string" }, "contact_person": { "description": "Contact person information", "properties": { "first_name": { "description": "First name", "type": "string" }, "last_name": { "description": "Last name", "type": "string" }, "email": { "description": "Email address", "type": "string", "format": "email" }, "phone_number": { "description": "Phone number", "type": "string" } }, "type": "object" } }, "type": "object" }, "TollFreeProfileResource": { "title": "Toll Free Profile Resource", "description": "Toll free profile resource", "properties": { "id": { "description": "Profile ID", "type": "integer" }, "organization_id": { "description": "Organization ID", "type": "integer" }, "title": { "description": "Profile title", "type": "string" }, "monthly_volume": { "description": "Monthly message volume", "type": "string" }, "use_case_description": { "description": "Use case description", "type": "string" }, "use_case_id": { "description": "Use case ID", "type": "integer" }, "sample_message_1": { "description": "First sample message", "type": "string" }, "sample_message_2": { "description": "Second sample message", "type": "string" }, "privacy_policy_url": { "description": "Privacy Policy URL", "type": "string" }, "terms_url": { "description": "Terms and Conditions URL", "type": "string" }, "completed": { "description": "Whether profile is completed", "type": "boolean" }, "created_at": { "description": "Creation timestamp", "type": "string", "format": "date-time" }, "updated_at": { "description": "Last update timestamp", "type": "string", "format": "date-time" }, "explanation_description": { "description": "Explanation description", "type": "string" }, "use_case": { "description": "Use case information", "properties": { "id": { "description": "Use case ID", "type": "integer" }, "name": { "description": "Use case name", "type": "string" }, "description": { "description": "Use case description", "type": "string" } }, "type": "object" }, "opt_in_methods": { "description": "Opt-in methods", "type": "array", "items": { "properties": { "id": { "description": "Method ID", "type": "integer" }, "name": { "description": "Method name", "type": "string" }, "description": { "description": "Method description", "type": "string" } }, "type": "object" } }, "opt_in_data": { "description": "Opt-in data", "type": "array", "items": { "properties": { "id": { "description": "Data ID", "type": "integer" }, "type": { "description": "Data type", "type": "string" }, "value": { "description": "Data value", "type": "string" } }, "type": "object" } }, "is_parent": { "description": "Whether this is a parent profile", "type": "boolean" }, "step": { "description": "Current registration step", "type": "string" }, "numbers": { "description": "Associated numbers", "type": "array", "items": { "properties": { "id": { "description": "Number ID", "type": "integer" }, "number": { "description": "Phone number", "type": "string" }, "status": { "description": "Number status", "type": "string" } }, "type": "object" } } }, "type": "object" }, "TollFreeProfileWithBusinessInfoResource": { "title": "Toll Free Profile With Business Info Resource", "description": "Combined toll free profile and business information resource", "type": "object", "allOf": [ { "$ref": "#/components/schemas/TollFreeProfileResource" }, { "properties": { "business_information": { "oneOf": [ { "$ref": "#/components/schemas/BusinessInformationResource" } ], "nullable": true } }, "type": "object" } ] }, "UISettingsResource": { "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer" }, "organization_id": { "type": "integer" }, "items": { "oneOf": [ { "type": "array", "items": {} }, { "type": "object" } ] } }, "type": "object" }, "Me": { "description": "Class Me", "properties": { "unread": { "title": "Unread Count", "type": "integer" } }, "type": "object", "xml": { "name": "Me" } }, "CallSettingsResource": { "title": "Call Settings Resource", "description": "Resource representing call settings", "properties": { "id": { "description": "The unique identifier of the call setting", "type": "integer" }, "title": { "description": "The title of the call setting", "type": "string" }, "organization_id": { "description": "The ID of the organization associated with this call setting", "type": "integer" }, "is_active": { "description": "Whether the call setting is active or not", "type": "boolean" }, "settings": { "description": "The actual settings for this call setting", "type": "object" } }, "type": "object" }, "AiCallingAgentCallItem": { "title": "AI Calling Agent Call Item", "description": "A single AI Calling Agent call item (derived from a call message).", "properties": { "message": { "properties": { "id": { "type": "integer", "example": 123 } }, "type": "object" }, "conversation": { "properties": { "id": { "type": "integer", "example": 456 } }, "type": "object" }, "call": { "properties": { "duration": { "description": "Answered call duration in seconds; 0 for non-completed calls.", "type": "integer", "example": 42 }, "record_url": { "type": "string", "example": "https://api.twilio.com/2010-04-01/Accounts/.../Recordings/...", "nullable": true }, "record_duration": { "type": "integer", "example": 42, "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2026-01-14T12:34:56Z" } }, "type": "object" }, "contact": { "properties": { "id": { "type": "integer", "example": 789 }, "name": { "type": "string", "example": "John Doe" }, "number": { "type": "string", "example": "+15205550123" }, "formatted_number": { "type": "string", "example": "+1 (520) 555-0123", "nullable": true }, "national_number": { "type": "string", "example": "(520) 555-0123", "nullable": true }, "photo_url": { "type": "string", "example": "https://cdn.example.com/avatar.png", "nullable": true }, "color": { "type": "string", "example": "#FF9900", "nullable": true }, "color_index": { "type": "integer", "example": 3, "nullable": true } }, "type": "object", "nullable": true }, "inbox": { "properties": { "id": { "type": "integer", "example": 12 }, "name": { "type": "string", "example": "Sales Inbox" }, "number": { "properties": { "id": { "type": "integer", "example": 34 }, "number": { "type": "string", "example": "+15205550999" }, "formatted_number": { "type": "string", "example": "+1 (520) 555-0999", "nullable": true } }, "type": "object", "nullable": true } }, "type": "object", "nullable": true } }, "type": "object" }, "CallingAgentSettingResource": { "properties": { "id": { "type": "integer", "example": 1 }, "organization_id": { "type": "integer", "example": 1 }, "team_id": { "type": "integer", "example": 1 }, "team_name": { "type": "string", "example": "Sales" }, "is_active": { "type": "boolean", "example": true }, "agent_id": { "type": "string", "example": "123", "nullable": true }, "call_path": { "type": "string", "example": "ring_then_ai", "nullable": true }, "ring_duration": { "type": "integer", "example": 15, "nullable": true }, "record_via_email": { "type": "boolean", "example": false }, "escalate_to_human": { "type": "boolean", "example": false } }, "type": "object", "xml": { "name": "CallingAgentSettingResource" } }, "IvrSettingRequest": { "required": [ "is_active", "menu_options", "default_action" ], "properties": { "is_active": { "description": "Whether the IVR setting is active", "type": "boolean" }, "use_after_hours": { "description": "Whether to use after hours settings", "type": "boolean", "nullable": true }, "menu_options": { "type": "array", "items": { "properties": { "keys": { "type": "array", "items": { "required": [ "key", "destination", "value" ], "properties": { "key": { "type": "integer", "maximum": 9, "minimum": 0 }, "destination": { "type": "string", "enum": [ "ENUM_VALUES_HERE" ] }, "value": { "description": "For send_sms destination: object with message, media_url, images_url, etc." } }, "type": "object" } } }, "type": "object" } }, "default_action": { "description": "The default action for the IVR", "type": "string", "enum": [ "ENUM_VALUES_HERE" ] } }, "type": "object" }, "IvrSettingsResource": { "properties": { "id": { "description": "The unique identifier of the IVR setting", "type": "integer" }, "organization_id": { "description": "The ID of the organization this IVR setting belongs to", "type": "integer" }, "team_id": { "description": "The ID of the team this IVR setting belongs to", "type": "integer" }, "organization_ivr_greeting_id": { "description": "The ID of the organization's IVR greeting", "type": "integer", "nullable": true }, "is_active": { "description": "Whether the IVR setting is active", "type": "boolean" }, "use_after_hours": { "description": "Whether to use after hours settings", "type": "boolean" }, "default_action": { "description": "The default action for the IVR", "type": "string" }, "menu_options": { "description": "The menu options for the IVR", "type": "array", "items": { "properties": { "keys": { "type": "array", "items": { "properties": { "key": { "type": "integer" }, "destination": { "type": "string" }, "value": { "type": "string" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" }, "WebsiteChatResource": { "properties": { "id": { "title": "ID", "type": "integer" }, "button": { "title": "Button", "type": "string" }, "color": { "title": "Color", "type": "string" }, "position": { "title": "Position", "type": "string" }, "header": { "title": "Header", "type": "string" }, "organization_name": { "title": "Organization Name", "type": "string" }, "status": { "title": "Status", "type": "string" }, "team_number": { "title": "Team Number", "type": "string" }, "uuid": { "title": "UUID", "type": "string" }, "domains": { "title": "Domains", "type": "array", "items": { "properties": { "website_chat_id": { "title": "Website chat ID", "type": "integer" }, "domain": { "title": "Domain", "type": "string" } }, "type": "object" } }, "tags": { "title": "Tags", "type": "array", "items": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" } }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" } }, "type": "object", "xml": { "name": "WebsiteChatResource" } }, "WebsiteChatSettingsResource": { "properties": { "cdn_url": { "title": "CDN URL", "type": "string" }, "button": { "title": "Button", "type": "string" }, "color": { "title": "Color", "type": "string" }, "position": { "title": "Position", "type": "string" }, "header": { "title": "Header", "type": "string" }, "organization_name": { "title": "Organization Name", "type": "string" }, "status": { "title": "Status", "type": "string" }, "team_number": { "title": "Team Number", "type": "string" }, "uuid": { "title": "UUID", "type": "string" }, "domains": { "title": "Domains", "type": "array", "items": { "properties": { "website_chat_id": { "title": "Website chat ID", "type": "integer" }, "domain": { "title": "Domain", "type": "string" } }, "type": "object" } } }, "type": "object", "xml": { "name": "WebsiteChatSettingsResource" } }, "ContactNoteResource": { "properties": { "text": { "title": "Text", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "is_automated": { "title": "Is automated", "type": "boolean" } }, "type": "object", "xml": { "name": "ContactNoteResource" } } }, "securitySchemes": { "apiAuth": { "type": "http", "description": "Login with email and password to get the authentication token", "bearerFormat": "JWT", "scheme": "bearer" } } }, "tags": [ { "name": "Authorization", "description": "The SalesMessage APIs are used to implement the standard account workflows. Supported authorization methods include: Personal Access Token (PAT) and OAuth2.

In both, you acquire an Access Token which is a string that enables the application to verify that a request belongs to an authorized session." }, { "name": "Contacts", "description": "Contacts are users added to the system and who you’re in contact with within your application.

Contacts block serves as a contact book for conversations, a crm for interacting with leads, a contact base for email marketing, etc.

The Contacts APIs enable your application to manage and interact with the Contacs block." }, { "name": "Conversations", "description": "When the first private message is sent to an app user or received from an app user, a conversation is automatically created for them. The SalesMessage Conversations API includes endpoints related to working with conversations.

The API endpoints enable your application to act as a chat agent for message exchange between users. Thus, it allows for managing conversations." }, { "name": "Messages", "description": "SalesMsg’s Messages API allows for sending and receiving SMS messages to and from any user within the system.

Send regular texts, share images and gifs, url links, hyperlinks to book appointments, files, vcards, .pdf attachments and more." }, { "name": "Saved Replies", "description": "Saved replies represent short templates of message fragments that can be used during message composition. They are created, saved and triggered using shortcuts. Saved replies can be used within various sections in the app, such as: Conversations, Broadcasts, Triggers, Keywords, Business Hours, etc.

Saved Replies is a powerful tool to automate responses for frequent chat queries and conversation scenarios to help save time on common replies. SalesMsg’s Saved Replies APIs enable your application to manage and interact with pre-written message fragments." }, { "name": "Teams", "description": "Teams are message inboxes which can be viewed by multiple authorized users, also called team members. Team members are users who have access to a particular inbox.

Team members can invite a user by their id to join a team, change team member roles, delete a member, become assigned for a conversations within a particular team.

The Teams APIs enable your application to manage and interact with message inboxes." }, { "name": "Users", "description": "The user is the one that is associated with the authorization within the system. It is the currently authorized, authenticated user having a token. Users belong to the system and are not visible by other systems or APIs.

The Users APIs enable your application to manage and interact with specific data about the current user." }, { "name": "Tags", "description": "SalesMsg’s Tags API is for creating tags and adding them to your contacts.

Tags serve for identification of contacts and searching for contacts via associated tags, filtering messages, analytics, conversations, and more. For example, you’ve got a contact that had come from Instagram. By adding the ‘instagram’ tag to the contact, we can then filter and search that exact contact much easier.

Tags section is found in the Settings.

The Tags APIs enable your application to manage and interact with tags." }, { "name": "Custom Fields", "description": "Custom fields API brings the ability to personalize a message even more through saving valuable dynamic information in custom properties. Custom properties are the best way to save unique contact information and keep all the personalized details about contacts at your fingertips.

4 already existing fields normally associated with the contacts include: First name, Last name, Phone Number, Email address.

In addition to these, this API helps to save, for instance, their pet's name, anniversary, shoe size, favorite color, or even a link to their website.

Besides, it’s possible to choose whether to show this specific information in a conversation within the contact card or not.

A new contact property field will be created for all contacts." }, { "name": "Analytics", "description": "The Analytics APIs provide access to statistics and performance data across messages, conversations, contacts, calls, and conversions. Use these endpoints to retrieve time-series charts and aggregated metrics filtered by date range, members, inboxes, numbers, and tags.

All Analytics endpoints require the analytics:read scope." }, { "name": "Attachments", "description": "Attachments" }, { "name": "Billing", "description": "Billing" }, { "name": "Broadcasts", "description": "Broadcasts" }, { "name": "Broadcasts Recurring", "description": "Broadcasts Recurring" }, { "name": "TollFree", "description": "TollFree" }, { "name": "Contact Import", "description": "Contact Import" }, { "name": "Integrations", "description": "Integrations" }, { "name": "Conversions", "description": "Conversions" }, { "name": "Follow Up", "description": "Follow Up" }, { "name": "Groups", "description": "Groups" }, { "name": "Keywords", "description": "Keywords" }, { "name": "Numbers", "description": "Numbers" }, { "name": "Numbers Landline", "description": "Numbers Landline" }, { "name": "Off Hours", "description": "Off Hours" }, { "name": "Organizations Agency", "description": "Organizations Agency" }, { "name": "Organizations", "description": "Organizations" }, { "name": "Organizations Invitations", "description": "Organizations Invitations" }, { "name": "Role Permissions", "description": "Role Permissions" }, { "name": "Triggers", "description": "Triggers" }, { "name": "Opt-In Data Files", "description": "Opt-In Data Files" }, { "name": "Call History", "description": "Call History" }, { "name": "Voice", "description": "Voice" }, { "name": "Website Chat", "description": "Website Chat" } ] }