.png)
Error
A valid request URL is required to generate request examples{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "active",
"contact_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"last_called_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}Campaigns
Create a campaign
Creates an empty, active campaign that calls and texts from the inboxes in
inbox_ids (ids from GET /inboxes); its dialer sessions and broadcasts can
use only those. Add contacts with POST /campaigns/{id}/contacts.
POST
/
campaigns
Error
A valid request URL is required to generate request examples{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "active",
"contact_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"last_called_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}Authorizations
Authorization Code flow against Dialbird's OIDC provider. The issued
access token is a JWT with aud: "public-api", verified against the
issuer JWKS.
FlowAuthorization Code
- Authorization URL
- https://app-staging.dialbird.io/oidc/auth
- Token URL
- https://app-staging.dialbird.io/oidc/token
- Refresh URL
- https://app-staging.dialbird.io/oidc/token
Scopes1
api:campaigns:write
Create campaigns and add, update, and remove their contacts.
Headers
Client-generated key (≤255 chars) to make a write request safely retriable.
Maximum string length:
255Body
application/json
Example:
"Q4 outbound"
The inboxes the campaign calls and texts from, in the order its dialer rotates through them. At least one, up to 10. Inboxes the API key's user can use (admins: any).
Required array length:
1 - 10 elementsExample:
["b3f1c8a2-5d1e-4c7a-9a43-2f6d0e8b1c55"]
Was this page helpful?