This API documentation will start with an overview of the Salesmsg authorization methods and flows, followed by reference information about each specific endpoint.
\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
Supported authorization methods include: Personal Access Token (PAT) and OAuth2.\nWhether to use PAT or regular OAuth2 tokens highly depends on your use case.
\nOAuth2 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.
\nPAT 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.
\nThe first step in implementing OAuth2 is registering an oauth application 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 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:
Authorization code grant flow
\nImplicit grant flow
\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.
\nThe integration consists of the following steps:
\nBelow, you can find the description of the authorization code grant flow in detail.
\nThe application sends the user to a browser to get their permission. To begin the authorization flow, construct and open a URL like:
\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# 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\nHere’s each query parameter explained:
\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.
\nThe user will be redirected back to an URL such as:
\nhttps://example.app/callback?code=g0ZGZmNjVmOWIjNTk2NTk4ZTYyZGI3&state=xcoiv98y2kd22vusuye3kch
Where:
\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.
\nThe body of this POST request must contain the following parameters encoded in application/x-www-form-urlencoded:
POST `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`=<my-authorization-code>\n\n&`client_id`=<client_id>\n\n&`client_secret`=<client_secret>\n\n&`redirect_uri`=<https://example.app/callback>\nWhere:
\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.
\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}\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.
\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.
\nTo refresh the token, a POST request must be sent with the following body parameters encoded in application/x-www-form-urlencoded:
POST https://api.salesmessage.com/pub/v2.3/oauth/token/refresh\nContent-Type: application/x-www-form-urlencoded\ngrant_type=refresh_token\n&client_id=<client_id>\n&client_secret=<client_secret>\n&refresh_token=<refresh_token>\n&scope=public-api\nWhere:
\nThis flow is meant for apps that don’t use a server, such as client-side JavaScript apps or mobile apps.
\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:
Below find an example of the URI that you’ll navigate to in your web browser control:
\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\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.
\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):
http://localhost:3000/\n#access_token=73d0f8mkabpbmjp921asv2jaidwxn\n&scope=channel%3Amanage%3Apolls+channel%3Aread%3Apolls\n&state=c3ab8aa609ea11e793ae92361f002671\n&token_type=bearer\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).
http://localhost:3000/\n?error=access_denied\n&error_description=The+user+denied+you+access\n&state=c3ab8aa609ea11e793ae92361f002671\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 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.
\nUse the following set of HTTP response status codes:
\nEach endpoint of our API returns responses in a JSON format.
\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.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"13783878","collectionId":"dadeaf6b-8159-4ec6-97c1-085b26bee24f","publishedId":"2sBYApyDGF","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-08-14T06:52:50.000Z"},"item":[{"name":"contacts","item":[{"name":"opt-in","item":[{"name":"{contact}","item":[{"name":"Opt-in contact","id":"a1821904-908b-4232-b6a4-dd2cc8286884","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.salesmessage.com/pub/v2.3/contacts/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.
Contact id
\n","type":"text/plain"},"type":"any","value":"1","key":"contact"}]}},"response":[{"id":"0eb4f763-2ec2-4afb-b523-8e8a72b35c50","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED 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.
Conversation id
\n","type":"text/plain"},"type":"any","value":"1","key":"conversation"}]}},"response":[{"id":"24bc3ab9-8061-4583-bd1b-f08b763b3b15","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED 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.
Contact id
\n","type":"text/plain"},"type":"any","value":"1","key":"contact"}]}},"response":[{"id":"731c31cd-066f-44b4-ae11-07fce75015dc","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:write']
Bulk opt-out to contact
REQUIRED SCOPES ['contacts:write']
Make contact opt-out
REQUIRED SCOPES ['contacts:read']
Get conversation by contact
The ID of the Contact
\n","type":"text/plain"},"type":"any","value":"","key":"contact"}]}},"response":[{"id":"138433d5-778c-4964-ba02-705f22960849","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:read']
ID of the contact
\n","type":"text/plain"},"type":"any","value":"2491","key":"contact"}]}},"response":[{"id":"2dddbd92-5c6a-44b9-b944-32d04edf36e3","name":"Successful operation","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED 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.
Custom Field Key
\n","type":"text/plain"},"key":"custom_field_key","value":"custom.email"},{"description":{"content":"Value
\n","type":"text/plain"},"key":"value","value":"email@example.com"}],"variable":[{"id":"1822e3ff-1545-45c3-a7bf-0cd569af65b1","description":{"content":"ID of contact
\n","type":"text/plain"},"type":"any","value":"2491","key":"contact"}]}},"response":[{"id":"e1051aab-a18f-4cbd-938b-600e22df22fc","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:write', 'integrations:write']
ID of the contact
\n","type":"text/plain"},"type":"any","value":"2491","key":"contact"}]}},"response":[{"id":"562c7613-343c-447b-9dc9-048b05ad58ee","name":"Successful operation","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:write']
This API request attaches a tag or multiple tags provided by tag ids to contacts with given ids.
Contact id
\n","type":"text/plain"},"type":"any","value":"1","key":"contact"}]}},"response":[{"id":"145547df-4884-4daa-a87e-4fe0d5c78f8b","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:write']
ID of the contact
\n","type":"text/plain"},"type":"any","value":"2491","key":"contact"}]}},"response":[{"id":"adb4208d-bbbc-4fba-89e1-031912a4389f","name":"Successful operation","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED 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.
ID of contact
\n","type":"text/plain"},"type":"any","value":"2491","key":"contact"}]}},"response":[{"id":"acd0d576-f819-4c0a-bdc0-fd1ce5b65d96","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED 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.
Contact id
\n","type":"text/plain"},"type":"any","value":"1","key":"contact"}]}},"response":[{"id":"74c6ea39-af3f-4b3c-a04a-8f15861cc834","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED 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.
Contact id
\n","type":"text/plain"},"type":"any","value":"","key":"contact"}]}},"response":[{"id":"fb55f9d1-3bed-4faa-96ec-47c30313747a","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED 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.
Attribute
\n","type":"text/plain"},"key":"attribute","value":"string"},{"description":{"content":"Value
\n","type":"text/plain"},"key":"value","value":"string"}],"variable":[{"id":"f184d766-4af2-46ae-b430-dd1590ce60ec","description":{"content":"The ID of the Contact
\n","type":"text/plain"},"type":"any","value":"","key":"contact"}]}},"response":[{"id":"2a678983-211c-42b0-aab9-413470b2773b","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:write']
Bulk to contact
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.
The IDs of the Contacts
\n","type":"text/plain"},"key":"contact_ids","value":"1786"},{"description":{"content":"The IDs of the Contacts
\n","type":"text/plain"},"key":"contact_ids","value":"1861"},{"description":{"content":"The IDs of the Tags
\n","type":"text/plain"},"key":"tags","value":"1786"},{"description":{"content":"The IDs of the Tags
\n","type":"text/plain"},"key":"tags","value":"1861"},{"description":{"content":"Remove All
\n","type":"text/plain"},"key":"remove_all","value":"true"},{"description":{"content":"Remove All
\n","type":"text/plain"},"key":"conversation_filter","value":"string"},{"description":{"content":"Team id
\n","type":"text/plain"},"key":"team_id","value":"2491"}],"variable":[]}},"response":[{"id":"5d1529be-9a7c-45e8-8dcc-d39dff4fc42b","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:read']
Get paginated contacts which have provided tag
The page of a collection to return.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"The string to search for..
\n","type":"text/plain"},"key":"search","value":"string"},{"description":{"content":"The number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"20"}],"variable":[{"id":"4d5b86b3-cea2-4a0b-bbfc-ca24d55345ef","description":{"content":"The ID of the Tag
\n","type":"text/plain"},"type":"any","value":"","key":"tag"}]}},"response":[{"id":"22eb0ab4-a3b8-4eb9-8af9-5a6a138a3467","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:write']
Add tags to contact
REQUIRED SCOPES ['contacts:write']
The request blocks an existing contact with a given id from the contact list.
The ID of the Contact
\n","type":"text/plain"},"type":"any","value":"","key":"contact"}]}},"response":[{"id":"bedae1a9-19db-41b8-9b10-ca78dda38aac","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:write']
The request allows for unblocking a contact by the blocked contact id and adds it back to the contact list.
The ID of the Contact
\n","type":"text/plain"},"type":"any","value":"","key":"contact"}]}},"response":[{"id":"f4bb614b-c803-4545-a746-b78820733715","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:write']
Set the list of contact fields to display on Contacts page for current user
The List of contact fields
\n","type":"text/plain"},"key":"contact_fields[]","value":"name"},{"description":{"content":"The List of contact fields
\n","type":"text/plain"},"key":"contact_fields[]","value":"name"}],"variable":[]}},"response":[{"id":"fb392080-8194-4ac1-96e9-2500f3f01a67","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED 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:
ID of contact
\n","type":"text/plain"},"type":"any","value":"2491","key":"contact"}]}},"response":[{"id":"18861a91-20f9-4e87-a1ec-3d4ffda68cd0","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED 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.
REQUIRED SCOPES ['contacts:write']
REQUIRED SCOPES ['contacts:read']
This request returnes a list of filter values by filter key
Field key
\n","type":"text/plain"},"type":"any","value":"string","key":"fieldKey"}]}},"response":[{"id":"a1c41287-0615-4f04-a3c3-16bc02c42bef","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:read']
This request returnes a list of selected filter values by filter key
Selected filter values keys
\n","type":"text/plain"},"key":"keys[]","value":"string"},{"description":{"content":"Selected filter values keys
\n","type":"text/plain"},"key":"keys[]","value":"string"}],"variable":[{"id":"c231fbcf-d68e-4acb-b21d-06aef94f87aa","description":{"content":"Field key
\n","type":"text/plain"},"type":"any","value":"string","key":"fieldKey"}]}},"response":[{"id":"d2db5e88-e14f-4780-bd2f-9d9de5f32541","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:read']
This request returnes a list of default states that are used for filtering and search in the Contacts section.
REQUIRED SCOPES ['contacts:read']
This request returnes a list of world time zones that are used for filtering and search in the Contacts section.
REQUIRED SCOPES ['contacts:read']
Get Opt-In statuses for filter
REQUIRED SCOPES ['contacts:read']
Fetches the exact count of contacts in a filtered contact package.
Package Count
\n","type":"text/plain"},"key":"package_count","value":"2491"}],"variable":[]}},"response":[{"id":"7ece9eae-ef26-4216-ba7e-83e99247e60f","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:write']
Fetches the exact count of contacts in a filtered contact package.
Package Count
\n","type":"text/plain"},"key":"package_count","value":"2491"},{"description":{"content":"Number id
\n","type":"text/plain"},"key":"number_id","value":"2491"}],"variable":[]}},"response":[{"id":"77d2f016-aebf-4362-a097-e00e5afd4899","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:write']
Fetches the exact count of contacts in a filtered contact package.
Package Count
\n","type":"text/plain"},"key":"package_count","value":"2491"},{"description":{"content":"Number id
\n","type":"text/plain"},"key":"number_id","value":"2491"}],"variable":[]}},"response":[{"id":"5c09b925-a816-4306-a7d1-ebe8668eb1eb","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:read']
This request returnes a list of filters that belong to the Contacts section by default and are used there for search.
Show values for contact filters
\n","type":"text/plain"},"key":"withValues","value":"true"},{"description":{"content":"Do not display values for passed filters keys. Works only when query param withValues equals true
\n","type":"text/plain"},"key":"skipValues[]","value":"string"},{"description":{"content":"Do not display values for passed filters keys. Works only when query param withValues equals true
\n","type":"text/plain"},"key":"skipValues[]","value":"string"},{"description":{"content":"Show custom fields filter
\n","type":"text/plain"},"key":"withCustomFields","value":"true"},{"description":{"content":"Workflow Source
\n","type":"text/plain"},"key":"workflowSource","value":"string"},{"description":{"content":"Show workflow list filter
\n","type":"text/plain"},"key":"withWorkflowFields","value":"true"},{"description":{"content":"Show integration list filter
\n","type":"text/plain"},"key":"withIntegrationList","value":"true"},{"description":{"content":"Show HubSpot list filter
\n","type":"text/plain"},"key":"withFullHubSpotList","value":"true"}],"variable":[]}},"response":[{"id":"e27f1149-fb04-4f3e-8609-802153013c5d","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contact-imports:write']
Upload file with contacts. See example and file format here: https://help.salesmessage.com/en/articles/3192286-import-your-contacts
REQUIRED SCOPES ['contact-imports:write']
Update contacts imports
REQUIRED SCOPES ['contact-imports:write']
Delete contacts import
The ID of the Contact Import
\n","type":"text/plain"},"type":"any","value":"","key":"contactImport"}]}},"response":[{"id":"00dbaa1a-8dff-469b-9c1e-cf16f3500893","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contact-imports:read']
Download contact import list as CSV
ID of the contact import
\n","type":"text/plain"},"type":"any","value":"2491","key":"contactImport"}]}},"response":[{"id":"87561cbb-f763-4970-81b7-600365522daa","name":"Successful operation","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contact-imports:write']
Finish a contact import process
ID of the contact import
\n","type":"text/plain"},"type":"any","value":"2491","key":"contactImport"}]}},"response":[{"id":"cc4bc573-2a81-4d0b-b590-39042a78d855","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contact-imports:read']
Get contact contacts import progress
The ID of the Contact Import
\n","type":"text/plain"},"type":"any","value":"","key":"contactImport"}]}},"response":[{"id":"a40c85b2-1f7e-445b-bc7c-2ae1622ee3e4","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contact-imports:write']
Request review for a contact import
ID of the contact import
\n","type":"text/plain"},"type":"any","value":"2491","key":"contactImport"}]}},"response":[{"id":"4c759bad-759e-4cdc-88f7-e119988704d3","name":"Successful operation","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contact-imports:write']
Start a contact import process
ID of the contact import
\n","type":"text/plain"},"type":"any","value":"2491","key":"contactImport"}]}},"response":[{"id":"1e5dcfb7-62e3-46db-89aa-96bcd14a1e89","name":"Successful operation","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contact-imports:read']
Get contacts import status
REQUIRED SCOPES ['contact-imports:read']
Get list of contact imports
Page number
\n","type":"text/plain"},"key":"page","value":"2491"},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"limit","value":"2491"}],"variable":[]}},"response":[{"id":"39be18b2-51aa-4587-87c5-ee1fc3a09c18","name":"Successful operation","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:write']
REQUIRED SCOPES ['contacts:write']
REQUIRED SCOPES ['contacts:write']
REQUIRED SCOPES ['contacts:read']
Phone number to check for duplicates
\n","type":"text/plain"},"key":"number","value":"string"},{"description":{"content":"Offset for pagination
\n","type":"text/plain"},"key":"offset","value":"2491"}],"variable":[]}},"response":[{"id":"ff714285-6982-42fc-a315-9c05b28abcfb","name":"Successful operation","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:read']
Page number
\n","type":"text/plain"},"key":"page","value":"2491"},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"length","value":"2491"},{"description":{"content":"Use Short Response
\n","type":"text/plain"},"key":"useShortResponse","value":"true"},{"description":{"content":"Search String
\n","type":"text/plain"},"key":"search","value":"string"},{"description":{"content":"Sort by field (name, label, etc)
\n","type":"text/plain"},"key":"sortBy","value":"string"},{"description":{"content":"Sorting order
\n","type":"text/plain"},"key":"sortOrder","value":"asc"}],"variable":[]}},"response":[{"id":"f66c9626-416e-4eb3-8b1f-6139578503ef","name":"Successful operation","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:read']
REQUIRED SCOPES ['contacts:read']
Page number
\n","type":"text/plain"},"key":"page","value":"2491"},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"length","value":"2491"},{"description":{"content":"Use Short Response
\n","type":"text/plain"},"key":"useShortResponse","value":"true"},{"description":{"content":"Search String
\n","type":"text/plain"},"key":"search","value":"string"},{"description":{"content":"Sort by field (name, label, etc)
\n","type":"text/plain"},"key":"sortBy","value":"string"},{"description":{"content":"Sorting order
\n","type":"text/plain"},"key":"sortOrder","value":"asc"}],"variable":[]}},"response":[{"id":"0e72dd79-8cca-43a0-a05f-8902afe9c836","name":"Successful operation","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED 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.
Package Count
\n","type":"text/plain"},"key":"text","value":"string"}],"variable":[{"id":"5b8a6a97-64c4-41da-bf8b-3d0ba46ea548","description":{"content":"The ID of the Contact
\n","type":"text/plain"},"type":"any","value":"","key":"contact"}]}},"response":[{"id":"47e4f5f6-4118-4e1b-88c3-d7285430fba0","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:write']
This request enables you to permanently remove an existing note indicated by the id of the note.
The ID of the Note
\n","type":"text/plain"},"type":"any","value":"","key":"note"}]}},"response":[{"id":"d9282f30-71fe-4c26-89b3-2651e62eea4d","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED 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.
Package Count
\n","type":"text/plain"},"key":"text","value":"string"}],"variable":[{"id":"fbc771ff-b2a0-4b69-ace1-45419a9ef5de","description":{"content":"The ID of the Note
\n","type":"text/plain"},"type":"any","value":"","key":"note"}]}},"response":[{"id":"11209648-a2c7-492f-8175-df3c42867c06","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:write']
REQUIRED SCOPES ['contacts:write']
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.
The maximum number of messages that you want returned from this call.
\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"The string to search for.
\n","type":"text/plain"},"key":"term","value":"string"}],"variable":[]}},"response":[{"id":"e19fe3b1-4773-4ec6-9172-67cc395f99d0","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:write']
Comma-separated list of tag IDs
\n","type":"text/plain"},"key":"tags","value":"string"},{"description":{"content":"Exclude opt-out contacts
\n","type":"text/plain"},"key":"exclude_opt_outs","value":"true"}],"variable":[]}},"response":[{"id":"0004e15d-b661-4df0-9a8d-2312b1e1822c","name":"Successful operation","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:write']
REQUIRED SCOPES ['contacts:write']
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.
Filter by first_name, last_name, email, number, formatted_number, tag label
\n","type":"text/plain"},"key":"search","value":""},{"description":{"content":"Results per page
\n","type":"text/plain"},"key":"length","value":"10"},{"description":{"content":"Page
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Sort by field (first_name, last_name, email, number, formatted_number, tag label, etc)
\n","type":"text/plain"},"key":"sortBy","value":"string"},{"description":{"content":"Sorting order
\n","type":"text/plain"},"key":"sortOrder","value":"asc"},{"description":{"content":"List of filters to apply
\n","type":"text/plain"},"key":"filtersList","value":"[object Object]"},{"description":{"content":"List of filters to apply
\n","type":"text/plain"},"key":"filtersList","value":"[object Object]"}],"variable":[]}},"response":[{"id":"dc376c3e-48ba-4c6d-8dab-138c537f673c","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED 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..
Number
\n","type":"text/plain"},"key":"number","value":""},{"description":{"content":"Integration id
\n","type":"text/plain"},"key":"integration_id","value":""},{"description":{"content":"First name
\n","type":"text/plain"},"key":"first_name","value":""},{"description":{"content":"Last name
\n","type":"text/plain"},"key":"last_name","value":""},{"description":{"content":"Color index
\n","type":"text/plain"},"key":"color_index","value":""},{"description":{"content":"Contact integration id
\n","type":"text/plain"},"key":"contact_integration_id","value":""},{"description":{"content":"Phone type (phone, etc)
\n","type":"text/plain"},"key":"phone_type","value":""},{"description":{"content":"Owner id
\n","type":"text/plain"},"key":"owner_id","value":""},{"description":{"content":"Source
\n","type":"text/plain"},"key":"source","value":""}],"variable":[]}},"response":[{"id":"356fe5cf-80ec-4ec4-a508-7c7e29427d33","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['contacts:write']
Delete contacts
The IDs of the Contacts
\n","type":"text/plain"},"key":"ids[]","value":"1786"},{"description":{"content":"The IDs of the Contacts
\n","type":"text/plain"},"key":"ids[]","value":"1861"},{"description":{"content":"Bulk All
\n","type":"text/plain"},"key":"bulk_all","value":"0"}],"variable":[]}},"response":[{"id":"e16dae2c-f2b4-4509-85f7-8f317b5a8465","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED 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.
Device type
\n","type":"text/plain"},"key":"type","value":"apple"},{"description":{"content":"Push token
\n","type":"text/plain"},"key":"token","value":"token"}],"variable":[]}},"response":[{"id":"7f8c47f6-f29a-4ab9-bb6c-e757de3e5131","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED 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.
Push token
\n","type":"text/plain"},"key":"push_token","value":"token"}],"variable":[]}},"response":[{"id":"999873c8-a7c5-4b05-a4cc-d3c6f8cdc7a3","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['users:read']
Get user's message signature
REQUIRED SCOPES ['users:write']
Create or update a message signature
REQUIRED SCOPES ['users:read']
Get profile details
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:
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.
\n","urlObject":{"path":["users","profile"],"host":["https://api.salesmessage.com/pub/v2.3"],"query":[{"description":{"content":"First name
\n","type":"text/plain"},"key":"first_name","value":""},{"description":{"content":"Last name
\n","type":"text/plain"},"key":"last_name","value":""},{"description":{"content":"Number
\n","type":"text/plain"},"key":"number","value":""}],"variable":[]}},"response":[{"id":"e6102ac4-d1e5-48bf-9fa1-a8326c987b41","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['users:write']
Update user's away status
REQUIRED SCOPES ['users:read']
Get business hours
REQUIRED SCOPES ['users:read']
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.
Password
\n","type":"text/plain"},"key":"current_password","value":"string"},{"description":{"content":"REQUIRED SCOPES ['users:write']
Submit user feedback
REQUIRED SCOPES ['users:read']
Get integration
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:
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:
New password
\n","type":"text/plain"},"key":"password","value":"string"},{"description":{"content":"Confirm new password
\n","type":"text/plain"},"key":"password_confirmation","value":"string"},{"description":{"content":"Current password
\n","type":"text/plain"},"key":"current_password","value":"string"}],"variable":[]}},"response":[{"id":"fd34ee9f-34f8-4850-b95f-dd003cc3e872","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['users:read']
Get permissions
REQUIRED SCOPES ['users:read']
Get users assign inbox request
REQUIRED SCOPES ['users:write']
Update user assign inbox request
REQUIRED SCOPES ['users:read']
Get user access requests
REQUIRED SCOPES ['users:read']
Search members in current organization
Term
\n","type":"text/plain"},"key":"term","value":"string"},{"description":{"content":"Per Page
\n","type":"text/plain"},"key":"per_page","value":"50"},{"description":{"content":"Page
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"The IDs of the Contacts
\n","type":"text/plain"},"key":"exclude[]","value":"1786"},{"description":{"content":"The IDs of the Contacts
\n","type":"text/plain"},"key":"exclude[]","value":"1861"}],"variable":[]}},"response":[{"id":"6ad2e741-61de-4186-98e5-598244f9fc6f","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['users:read']
Get settings
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.
Key of the feature
\n","type":"text/plain"},"key":"featureKey","value":"string"},{"description":{"content":"Settings key
\n","type":"text/plain"},"key":"settingsKey","value":"string"},{"description":{"content":"Settings value
\n","type":"text/plain"},"key":"value","value":"string"}],"variable":[]}},"response":[{"id":"ba41e49b-26b9-4504-a53d-e2dfff2179a6","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['users:write']
Update multiple user settings
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.
Team ID
\n","type":"text/plain"},"key":"id","value":"2491"}],"variable":[]}},"response":[{"id":"e91a0441-02b8-4121-958b-cbe4eac14602","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['users:write']
Update users toggle record automatically
REQUIRED SCOPES ['users:read']
Get user's UI settings for the provided type
UI Settings Type
\n","type":"text/plain"},"type":"any","value":"contacts-table-columns","key":"type"}]}},"response":[{"id":"26d4d0df-de63-4d92-9047-7a2e5b29f708","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['users:write']
Sync User's UI Settings: Create OR Update.
REQUIRED SCOPES ['users:read']
Get list of user's UI settings
REQUIRED SCOPES ['users:read']
Get users
REQUIRED SCOPES ['attachments:read']
Get attachments size-limits
REQUIRED SCOPES ['attachments:write']
Download selected attachments by link
The IDs of the Attachments
\n","type":"text/plain"},"key":"attachment_ids[]","value":"1786"},{"description":{"content":"The IDs of the Attachments
\n","type":"text/plain"},"key":"attachment_ids[]","value":"1861"}],"variable":[]}},"response":[{"id":"55a54679-5c07-4f44-89ce-136f6f9c6261","name":"Ok","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['attachments:write']
Download selected attachments
The IDs of the Attachments
\n","type":"text/plain"},"key":"attachment_ids[]","value":"1786"},{"description":{"content":"The IDs of the Attachments
\n","type":"text/plain"},"key":"attachment_ids[]","value":"1861"}],"variable":[]}},"response":[{"id":"63a5370a-69cb-4523-ba7d-dc476cea72d1","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/zip"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['attachments:write']
Convert attachment file
REQUIRED SCOPES ['attachments:read']
Get all attachments with pagination and filtering options
Search term to filter attachments
\n","type":"text/plain"},"key":"term","value":"string"},{"description":{"content":"Number of attachments per page
\n","type":"text/plain"},"key":"per_page","value":"428"},{"description":{"content":"Page number
\n","type":"text/plain"},"key":"page","value":"428"},{"description":{"content":"Filter attachments by type
\n","type":"text/plain"},"key":"type","value":"string"}],"variable":[]}},"response":[{"id":"a5e3c799-2c27-4c21-97e3-059f7c98bcbb","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['attachments:read']
Get preview file
Short Urls
\n","type":"text/plain"},"key":"urls[]","value":"string"},{"description":{"content":"Short Urls
\n","type":"text/plain"},"key":"urls[]","value":"string"}],"variable":[]}},"response":[{"id":"3a1a0ba5-4990-427c-848c-e2c311d6e3f0","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['attachments:read']
Get Recently attachments
REQUIRED SCOPES ['attachments:read']
Search attachments
Number of attachments to return
\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"Filter for Aircall attachments
\n","type":"text/plain"},"key":"is_aircall","value":"true"},{"description":{"content":"Search term
\n","type":"text/plain"},"key":"term","value":"string"}],"variable":[]}},"response":[{"id":"70f620a3-db1e-447b-b5dc-87ac5fb2ced1","name":"Successful operation","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['attachments:write']
Update an attachment
ID of the attachment to update
\n","type":"text/plain"},"type":"any","value":"2491","key":"attachment"}]}},"response":[{"id":"98e029ec-197a-4e11-98fe-f24317d9d1e7","name":"Successful operation","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['attachments:write']
Upload attachment
REQUIRED SCOPES ['attachments:write']
Delete selected attachments
The IDs of the Attachments
\n","type":"text/plain"},"key":"attachment_ids[]","value":"1786"},{"description":{"content":"The IDs of the Attachments
\n","type":"text/plain"},"key":"attachment_ids[]","value":"1861"}],"variable":[]}},"response":[{"id":"adc2f278-cd5f-4b8e-b159-20b4f9346f81","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerMust be set to refresh_token.
The client_id is the identifier for the app. Find it on the OAuth Applications page.
\n","key":"client_id","value":""},{"description":"The client_id is the secret of the app. Find it on the OAuth Applications page.
\n","key":"client_secret","value":""},{"description":"The refresh token to refresh.
\n","key":"refresh_token","value":""}]},"url":"https://api.salesmessage.com/pub/v2.3/oauth/token/refresh","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.
Must be set to authorization_code.
The authorization code returned from the Get the User’s Permission request.
\n","key":"code","value":""},{"description":"The client_id is the identifier for the app. Find it on the OAuth Applications page.
\n","key":"client_id","value":""},{"description":"The client_secret is the secret of the app. Find it on the OAuth Applications page.
\n","key":"client_secret","value":""},{"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.
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.
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_token_0b1z}} token in the headers.
REQUIRED SCOPES ['billing:read']
Get auto recharge configuration for the authenticated user
REQUIRED SCOPES ['broadcasts:read']
Get all broadcasts filters
REQUIRED SCOPES ['broadcasts:read']
Get all broadcasts filters
REQUIRED SCOPES ['broadcasts:write']
Get all broadcasts
Sort by
\n","type":"text/plain"},"key":"sortBy","value":"string"},{"description":{"content":"Sort order
\n","type":"text/plain"},"key":"sortOrder","value":"string"},{"description":{"content":"The page of a collection to return.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"The string to search for..
\n","type":"text/plain"},"key":"search","value":"string"},{"description":{"content":"The number of items to return per page.
\n","type":"text/plain"},"key":"length","value":"10"}],"variable":[]}},"response":[{"id":"571ac126-501b-43df-9010-555ba569426f","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['broadcasts:write']
Change status of a broadcast
ID of the broadcast
\n","type":"text/plain"},"type":"any","value":"2491","key":"broadcast"},{"id":"72ea06a1-f33f-4ab6-ada7-050fc985feb2","description":{"content":"New status for the broadcast
\n","type":"text/plain"},"type":"any","value":"string","key":"status"}]}},"response":[{"id":"22c3fdff-fc56-4423-8bb5-ccc5f3700e9f","name":"Successful operation","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['broadcasts:read']
Export broadcast contacts
Filter
\n","type":"text/plain"},"key":"filter","value":"string"}],"variable":[{"id":"0654534d-e58f-47f4-bddb-a449e5cf8218","description":{"content":"The ID of the Broadcast
\n","type":"text/plain"},"type":"any","value":"","key":"broadcast"}]}},"response":[{"id":"1f4e2beb-ee4b-4641-bad4-989e421a3e0d","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['broadcasts:read']
Get contacts broadcasts
Filter
\n","type":"text/plain"},"key":"filter","value":"string"},{"description":{"content":"The page of a collection to return.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"The number of items to return per page.
\n","type":"text/plain"},"key":"length","value":"10"}],"variable":[{"id":"ed5ad655-7fd6-428f-b130-553df56a6294","description":{"content":"The ID of the Broadcast
\n","type":"text/plain"},"type":"any","value":"","key":"broadcast"}]}},"response":[{"id":"b64a309c-d873-44a3-b237-c17a3928ecf1","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['broadcasts:write']
REQUIRED SCOPES ['broadcasts:read']
Get broadcast by start and finish date
Packages
\n","type":"text/plain"},"key":"packages","value":"2491"},{"description":{"content":"Start date
\n","type":"text/plain"},"key":"start_date","value":""},{"description":{"content":"Days for the broadcast to run
\n","type":"text/plain"},"key":"schedule","value":""},{"description":{"content":"Count of package
\n","type":"text/plain"},"key":"package_count","value":"2491"}],"variable":[]}},"response":[{"id":"f00fc6c1-53e7-49e3-a2ac-24bd165de46e","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['broadcasts:read']
Get broadcast
The ID of the Broadcast
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"56110328-93a5-4ad8-9de6-588d46583f52","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['broadcasts:write']
Delete broadcast
The ID of the Broadcast
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"006a7886-3126-418a-9fac-f2f71f88ae8f","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['broadcasts:read']
Get failed broadcasts
The ID of the Broadcast
\n","type":"text/plain"},"type":"any","value":"","key":"broadcastId"}]}},"response":[{"id":"646d0480-9a0d-46b2-8799-6cc19f4c6533","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['broadcasts:write']
Update broadcast fields settings
REQUIRED SCOPES ['broadcasts-recurring:write']
Activate recurring template
The ID of the Recurring Template Broadcast
\n","type":"text/plain"},"type":"any","value":"","key":"templateBroadcast"}]}},"response":[{"id":"116e3a00-065e-45b5-8eee-524f71f6c631","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['broadcasts-recurring:write']
Delete recurring template
The ID of the Recurring Template Broadcast
\n","type":"text/plain"},"type":"any","value":"","key":"templateBroadcast"}]}},"response":[{"id":"92a3b8fb-b999-43e1-adb8-d2bbdd44298d","name":"OK","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['broadcasts-recurring:write']
Finish recurring template
The ID of the Recurring Template Broadcast
\n","type":"text/plain"},"type":"any","value":"","key":"templateBroadcast"}]}},"response":[{"id":"f0a586cb-fe70-4a36-9782-305cb1db2b2e","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['broadcasts-recurring:write']
Inactivate recurring template
The ID of the Recurring Template Broadcast
\n","type":"text/plain"},"type":"any","value":"","key":"templateBroadcast"}]}},"response":[{"id":"8e4a1d77-37c9-4884-b2f4-dced45da956d","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['broadcasts-recurring:write']
Rename recurring template
Name
\n","type":"text/plain"},"key":"name","value":"string"}],"variable":[{"id":"95c0bf3d-22ea-4b4c-a32e-d7490884a9fb","description":{"content":"The ID of the Recurring Template Broadcast
\n","type":"text/plain"},"type":"any","value":"","key":"templateBroadcast"}]}},"response":[{"id":"aa68671b-668d-448c-b0c9-1b5b98d0bccd","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['broadcasts-recurring:read']
Get all recurring broadcasts filters
REQUIRED SCOPES ['broadcasts-recurring:write']
Stop all future recurring broadcasts
ID of the broadcast
\n","type":"text/plain"},"type":"any","value":"2491","key":"broadcast"}]}},"response":[{"id":"d398d40a-577a-4ad7-96dc-f830fef9e9c3","name":"Successful operation","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['broadcasts-recurring:read']
Get broadcasts list related to recurring template
The page of a collection to return.
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[{"id":"d39643dc-da33-405c-abfe-aec57eee1c97","description":{"content":"The ID of the Recurring Template Broadcast
\n","type":"text/plain"},"type":"any","value":"","key":"templateBroadcastId"}]}},"response":[{"id":"acb11882-53ab-405f-a753-a55510dae4a8","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['broadcasts-recurring:read']
Get all recurring templates
The page of a collection to return.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"The string to search for..
\n","type":"text/plain"},"key":"search","value":"string"},{"description":{"content":"The number of items to return per page.
\n","type":"text/plain"},"key":"length","value":"10"}],"variable":[]}},"response":[{"id":"c0986e56-7024-4677-a735-96366953aa77","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['broadcasts:write']
Broadcast test
Number
\n","type":"text/plain"},"key":"number","value":"string"},{"description":{"content":"The ID of the Number
\n","type":"text/plain"},"key":"number_id","value":"2491"},{"description":{"content":"Message
\n","type":"text/plain"},"key":"message","value":"string"},{"description":{"content":"The url of the media
\n","type":"text/plain"},"key":"media_url[]","value":"string"},{"description":{"content":"The url of the media
\n","type":"text/plain"},"key":"media_url[]","value":"string"}],"variable":[]}},"response":[{"id":"854161b5-552e-43a5-88a5-8a2df11be3ee","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['broadcasts:write']
Update broadcast
The ID of the Broadcast
\n","type":"text/plain"},"type":"any","value":"","key":"broadcastId"}]}},"response":[{"id":"105622aa-44ec-4cfc-8308-558ed0c9c172","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['broadcasts:read']
Get all broadcasts
Sort by
\n","type":"text/plain"},"key":"sortBy","value":"string"},{"description":{"content":"Sort order
\n","type":"text/plain"},"key":"sortOrder","value":"string"},{"description":{"content":"The page of a collection to return.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"The string to search for..
\n","type":"text/plain"},"key":"search","value":"string"},{"description":{"content":"The number of items to return per page.
\n","type":"text/plain"},"key":"length","value":"10"}],"variable":[]}},"response":[{"id":"75c6b765-e2a6-440c-89a5-f8c06c4c1fac","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES ['broadcasts:write']
Create broadcast
REQUIRED SCOPES ['saved-replies:write']
You can use this API endpoint to toggle favorite for reply.
Canned Message ID
\n","type":"text/plain"},"type":"any","value":"1","key":"cannedMessage"}]}},"response":[{"id":"e5d7f4aa-6682-4990-9f3f-506e40cfe21b","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED 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.
Canned message id
\n","type":"text/plain"},"type":"any","value":"","key":"cannedMessage"}]}},"response":[{"id":"76bff3e4-cf6f-40c3-a878-c64e23395bc0","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED 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:
Any parameters not provided will be left unchanged.
\n","urlObject":{"path":["canned-messages",":cannedMessage"],"host":["https://api.salesmessage.com/pub/v2.3"],"query":[{"description":{"content":"Title
\n","type":"text/plain"},"key":"title","value":""},{"description":{"content":"Message
\n","type":"text/plain"},"key":"message","value":""},{"description":{"content":"Public
\n","type":"text/plain"},"key":"public","value":"true"},{"description":{"content":"Integration id
\n","type":"text/plain"},"key":"integration_id","value":""},{"description":{"content":"Media url
\n","type":"text/plain"},"key":"media_url","value":""},{"description":{"content":"Contact id
\n","type":"text/plain"},"key":"contact_id","value":""}],"variable":[{"id":"978f68ae-972d-4482-81c7-5bed03017535","description":{"content":"Canned message id
\n","type":"text/plain"},"type":"any","value":"","key":"cannedMessage"}]}},"response":[{"id":"a53e7a9f-7173-4d34-a308-6aaf65bc7122","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED 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.
Canned message id
\n","type":"text/plain"},"type":"any","value":"","key":"cannedMessage"}]}},"response":[{"id":"27d33d6a-4ef6-4394-bfd5-af9593c01410","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED 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.
Integration id
\n","type":"text/plain"},"key":"integration_id","value":""},{"description":{"content":"Filter by title, message
\n","type":"text/plain"},"key":"search","value":""},{"description":{"content":"Results per page
\n","type":"text/plain"},"key":"length","value":""},{"description":{"content":"Page
\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"Contact id
\n","type":"text/plain"},"key":"contact_id","value":""}],"variable":[]}},"response":[{"id":"c48a2538-2aec-4c06-8f6e-ffe9268ed6dd","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerREQUIRED SCOPES