Create a contact - Dialbird API

A valid request URL is required to generate request examples

{
  "id": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "primary_phone": "<string>",
  "primary_email": "<string>",
  "notes": "<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>"
  }
}

{
  "error": {
    "code": "validation_error",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>"
  }
}

POST

/

contacts

A valid request URL is required to generate request examples

{
  "id": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "primary_phone": "<string>",
  "primary_email": "<string>",
  "notes": "<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>"
  }
}

{
  "error": {
    "code": "validation_error",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>"
  }
}

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.

Headers

Idempotency-Key

string

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

Maximum string length: 255

Body

application/json

At least one of primary_phone / primary_email is required on create.

first_name

string

last_name

string

primary_phone

string

E.164.

Example:

"+15551234567"

primary_email

string<email>

notes

string

Response

Contact created.

id

string

first_name

string | null

last_name

string | null

primary_phone

string | null

primary_email

string | null

notes

string | null