Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

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

Idempotency-Key
string

Client-generated key (≤255 chars) to make a write request safely retriable.

Maximum string length: 255

Path Parameters

id
string
required

The campaign id.

Body

application/json
contacts
object[]
required
Required array length: 1 - 500 elements

Response

Contacts added.

imported
integer
duplicates
integer
skipped
integer

Contacts with no usable phone number.

import_id
string

The campaign's API import these contacts were added to.