Introduction
Welcome to the API documentation for SmartReach APIs. Our API infrastructure is built upon the principles of REST. Requests made to our API should be formatted with data encoded in application/json within the request body while the responses are returned in JSON format.
For communicating the status of requests, we employ standard HTTP response codes such as 200 for successful requests, 204 for successful requests with no content, and 400, 403, and 500 for various error scenarios.
Within our API ecosystem, we maintain a well-defined structure for objects like prospect, team, campaign etc.
Furthermore, our listing APIs are designed with pagination in mind, ensuring efficient navigation and retrieval of data, particularly when dealing with large datasets.
When demonstrating various examples using our API - we will use the well known curl command line utility ( https://curl.se/ ) for making the API calls. The options described will be parameters for the curl command.
Let’s begin with authenticating the API calls.