SMS - Verify credentials

Verifies credentials provided in custom defined headers. Returns 200 OK if credentials are valid. Returns a non-200 status code otherwise and can provide a detailed error message, which will be displayed to the user on integration screen.

🚧

Disclaimer: Intended Use of Channel API

The Channel API documentation is designed exclusively for partners who have established commercial agreements with Bloomreach, including CPaaS vendors (Communications Platform as a Service) and MTAs (Mail Transfer Agents, also known as ESPs), such as Mailgun, Sinch, Infobip, Omnivery and others. This API enables our partners to build connectors to their systems effectively and aligns with our service offerings.
Please note that this API is not intended for general client use. If you are an existing client and are interested in Channel API, please contact your account manager.

Headers
string
required
Defaults to 123

An example header (one of multiple) containing account identity or authorization data. The actual headers to be sent can be customized to provider's needs, by default BR will send each setting field as a separate header with the prefix Chan- added to the name.

An API key is a token that you provide when making API calls. Include the token in a header parameter called Chan-Example-Token.

Example: Chan-Example-Token: 123

Responses

Language
Response
Choose an example:
application/json

© Bloomreach, Inc. All rights reserved.