Skip to main content
POST
Test Connection Endpoint

Authorizations

X-API-Key
string
header
required

Your organization's API key (account in the bottom-left of the dashboard → Brosbots API).

Headers

authorization
string | null
X-API-Key
string | null

Path Parameters

connection_id
string
required

Body

application/json

Test an unsaved form. Omit to test the stored connection as-is.

config
object | null

Response

Successful Response

Result of a check. code and params let you render the outcome in your own language; message is the English text.

ok
boolean
required
message
string
required
code
string
default:""
params
object