Skip to main content
The BluBash API lets you connect your application directly to the platform so you can send messages through channels, manage campaign audiences, and automate customer communication workflows. All API access is authenticated with a Workspace API Key that you obtain from the admin panel.

​
Available APIs

Channels API

Send text, image, audio, video, and document messages through a configured API channel. Responses are handled by your workspace AI agent.

Campaigns API

Add contacts to evergreen campaigns individually or in bulk, schedule sends per contact, cancel queued messages, and inspect message status.

​
Authentication

Every request to the BluBash API must include your Workspace API Key in the X-API-Key header. 
X-API-Key: your_workspace_api_key
Content-Type: application/json
Keep your API key secret. Never expose it in client-side code or public repositories. Treat it with the same care as a password.

​
Obtain your API key

1

Open your workspace admin panel

Log in to BluBash and navigate to your workspace.
2

Go to Settings → API Keys

Find the API Keys section under workspace settings.
3

Generate or copy a key

Create a new key or copy an existing one to use in your requests.

​
Idempotency

To prevent duplicate messages when retrying failed requests, include the optional X-Idempotency-Key header with a unique value per request. 
X-Idempotency-Key: your_unique_idempotency_key
Use a UUID or a hash derived from the request payload as your idempotency key so the same logical operation is never processed twice.

​
Developer tips

  • Always use the same contactIdentifier value for the same contact to avoid creating duplicates.
  • Implement proper error handling for HTTP error responses (400, 401, 404, 500).
  • Test integrations in a development environment before pointing traffic at production.
  • Respect API rate limits — configure your retry logic with exponential backoff.

​
Support

If you need help, contact the BluBash support team at suporte@blubash.io.