Add contact to dynamic campaign
Push a single contact into a dynamic bulk-call campaign in real time. Dynamic campaigns are created from the dashboard (Bulk Call > Create New Campaign > Dynamic Campaign) and stay alive waiting for contacts, so this webhook is how you feed them from a CRM, form, or automation platform. The contact is queued immediately, and the campaign starts calling it as soon as it is within operating hours.
campaign_idrequiredContact phone number in international format (e.g., +15551234567).
Key-value pairs passed to the agent as context for this call, so the agent can reference them during the conversation (e.g. the contact's name or reason for the call). Match these keys to the variables used in your agent's welcome message or prompt.
Key-value pairs stored on the contact for your own tracking (e.g. CRM or lead IDs). Not shared with the agent.
curl -X POST 'https://backend.omnidim.io/api/v1/calls/bulk_call/{campaign_id}/add_contact' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "to_number": "+15551234567", "custom_variables": { "name": "Demo User", "interest": "Home Insurance" }, "metadata": { "crm_lead_id": "lead_9876", "source": "website_form" } }'
{ "status": "success", "message": "Contact added successfully", "campaign_id": 123, "line_id": 4567, "campaign_status": "in_progress", "to_number": "+15551234567" }
Authorization
BearerAuth Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
In: header
Path Parameters
ID of the dynamic campaign to add the contact to.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json