Skip to main content
POST
Test Boulevard API connection

Authorizations

x-auth-apikey
string
header
required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme
enum<string>
default:api-token
required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options:
api-token,
api,
partner-api-token,
partner-api

Body

application/json

Request object for testing Boulevard API connection.

apiToken
string | null

Boulevard API token to test

boulevardBusinessId
string | null

Boulevard business ID to test

Response

200 - application/json

OK

Response object for testing Boulevard API connection.

error
boolean | null
errorMessage
string | null

Error message if connection test failed

errorMsg
string | null
locations
object[] | null

List of Boulevard locations available for the business

success
boolean | null

Whether the connection test was successful

warningMsg
string | null
Last modified on August 19, 2026