Unlock the power of business messaging through the Salesmsg API. This API documentation will give an in-depth explanation to help you get up and running quickly, complete with reference information for each endpoint.
Followed by reference information about each specific endpoint.
The following API documentation is a comprehensive guidebook that helps developers utilize the Salesmsg API to the fullest extent. It includes detailed tutorials, helpful code examples and useful visuals.
Salesmsg's API documentation provides you with all the information you need to get started using our public API. Our easy-to-use interface makes it simple to get the data you need, when you need it.
Customize your texting experience or integrate Salesmsg into your App or a Platform.
Salesmsg API Access
Almost anything you can do in Salesmsg, you can do with our RESTful API. See everything you can do in our docs.
See API Documentation
Experiment with the Salesmsg API in real-time and find details of each endpoint.
Test Salesmsg APIIntegration with an external API can be a daunting task. This guide provides step-by-step instructions on how to use Salesmsg API in your projects. By following these instructions, you will be able to quickly and easily get Salesmsg integration up and running.
Supported authorization methods include: Personal Access Token (PAT) and OAuth2. Whether to use PAT or regular OAuth2 tokens highly depends on your use case.
Salesmsg's API documentation is designed to help you get the most out of our platform. Each step of the process contains a code example.
All endpoints use Tokens to authenticate Users, and all responses are in JSON format. To get started, use the GET /api/v4/contacts method to get a list of contacts for the User.
The previous step will provide you a view of 10 contacts per page. Next, you can choose a contact to retrieve by ID, using GET /api/v4/contacts/{contact}.
You will get Contact object in return.
Let’s change some Contact’s properties: first_name to Newname and email newemail@example.com. To do this use PUT /api/v4/contacts/{contact}.
Let’s send a Message to this Contact. To do this we need to create a Conversation object.
Creating Conversation is done by POST /api/v4/conversations method. It will either create new conversation or return existing conversation with our Contact.
Now that you have our Conversation you can send a Message. To do this use POST /api/v4/messages/{conversation} endpoint. Let’s send “My text message” Message using this code:
Let’s review our new Message in the Conversation. To do this you should use GET /api/v4/messages/{conversation} method.
As you can see in the response below the Contact has replied to your Message.
Enjoy integrating with Salemsg Open API.
Additionally, if you want to try Salesmsg API without creating an account you can do so using our Mock Server.
1. Signup for a free Postman account https://www.postman.com.
2. Set baseUrl variable in your collection as https://e33e4a6a-ff9d-419f-a378-ec53560c0bb7.mock.pstmn.io and you are good to go.
The new API 2.2 introduces a major update with an expanded batch of endpoints, now totaling 500! This new version builds on the success of API 2.1, which fully replaced version 1.0 and introduced 200 endpoints.
The 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.Each endpoint of our API returns responses in a JSON format.
