Skip to main content
PATCH
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.

Path Parameters

id
string
required

The campaign id.

contactId
string
required

The campaign contact id.

Body

application/json

At least one field is required.

first_name
string | null
last_name
string | null
company
string | null
title
string | null
email
string | null
linkedin_url
string | null
due_at
string<date-time> | null
phones
string[]
Required array length: 1 - 5 elements
status
enum<string>
Available options:
not_called,
do_not_call

Response

Contact updated.

id
string
campaign_id
string
first_name
string | null
last_name
string | null
company
string | null
title
string | null
email
string | null
linkedin_url
string | null
phones
object[]

In dial order, E.164.

primary_number
string
status
enum<string>

completed once a disposition that completes the contact is picked; do_not_call contacts are never dialed.

Available options:
not_called,
in_progress,
called,
completed,
do_not_call
call_count
integer
last_called_at
string<date-time> | null
last_disposition
object | null
extra_fields
object | null
customer_id
string | null

The saved Dialbird contact this campaign contact is linked to, if any.

due_at
string<date-time> | null
created_at
string<date-time>