Skip to main content
POST
This endpoint tests the connection to a CRM provider (Close or Bullhorn) using the provided API key. Use this to validate credentials before saving CRM settings or to verify that existing credentials are still working.

Authentication

This endpoint requires authentication. The request must include a valid session with an associated organization.

Request

Body Parameters

string
required
The CRM provider to connect to. Allowed values: close, bullhorn
string
required
The API key for authenticating with the CRM provider. Must be at least 1 character. - For Close: Use your Close API key from Settings > API Keys - For Bullhorn: Use your Bullhorn REST API credentials

Response

boolean
required
Indicates whether the connection test was successful. - true: The API key is valid and connection was established - false: The connection failed (see error field for details)
string
Error message describing why the connection test failed. Only present when success is false. Common errors include: - Invalid API key - Network connectivity issues - CRM service unavailable

Error Codes

Supported CRM Providers

Close CRM

  • Provider value: close
  • API Key format: Starts with api_ followed by alphanumeric characters
  • Documentation: Close API Documentation

Bullhorn CRM

  • Provider value: bullhorn
  • API Key format: REST API credentials from Bullhorn
  • Documentation: Bullhorn REST API

Notes

  • This endpoint only tests the connection; it does not save credentials
  • To save CRM settings after a successful test, use the CRM settings endpoint
  • The connection test verifies API key validity by making a lightweight request to the CRM provider
  • Rate limiting may apply based on your CRM provider’s API limits