Query Parameters
Integration ID to validate against
Authentication method ID
Body
application/json · Request Body · object
Response
Successful Response
The response is of type any.
Validate connection credentials without creating a connection.
This endpoint allows you to validate credentials and configuration before attempting to create a connection. Useful for providing real-time validation feedback in forms.
Example:
POST /connections/validate?integration_id=gmail
Request Body:
{
"credentials": {
"api_key": "abc123",
"email": "user@example.com"
},
"config": {}
}
Success Response:
{
"valid": true,
"errors": []
}
Validation Error Response:
{
"valid": false,
"errors": [
"Field 'API Key' must be at least 20 characters",
"Field 'Email' must be a valid email address"
]
}
Integration ID to validate against
Authentication method ID
Successful Response
The response is of type any.