Contact

Get Contact

get

Get a contact by phone number or email

Query parameters

apiKeystringOptional

API key for authentication

Example: your_api_key

phoneNumberstringOptional

Contact's phone number (must include valid country code)

Example: [phone]

emailstring · emailOptional

Contact's email address

Example: [e-mail]

Responses

get

HTTPcURLJavaScriptPython

GET /v1/contacts HTTP/1.1
Host: api.dmchamp.com
Accept: */*

{
  "success": true,
  "contactId": "abc123"
}

Create New Contact

post

Create a new contact with phone number and optional information

Query parameters

apiKeystringOptional

API key for authentication

Example: your_api_key

Body

phoneNumberstringRequired

Contact's phone number (must include valid country code)

firstNamestringOptional

Contact's first name

Default: Unknown

lastNamestringOptional

Contact's last name

Default: Unknown

emailstring · emailOptional

Contact's email address

Default: [e-mail]

instagramIdstring | nullableOptional

Contact's Instagram ID

currentCampaignstring | nullableOptional

Current campaign identifier

currentCampaignDataobject | nullableOptional

Data associated with current campaign

channelstring | nullableOptional

Communication channel

isChatWindowOpenbooleanOptional

Whether chat window is open

Default: false

externalIdstring | nullableOptional

External identifier

customChannelstring | nullableOptional

Custom channel identifier

chatWidgetIdstring | nullableOptional

Chat widget identifier

is_bot_activebooleanOptional

Whether the bot is active for this contact

Default: true

do_not_disturbbooleanOptional

Whether the contact should not be disturbed

Default: false

Responses

post

HTTPcURLJavaScriptPython

POST /v1/contacts HTTP/1.1
Host: api.dmchamp.com
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "phoneNumber": "[phone]",
  "firstName": "John",
  "lastName": "Doe",
  "email": "[e-mail]",
  "is_bot_active": true,
  "do_not_disturb": false
}

{
  "success": true,
  "data": {
    "message": "Successfully created new contact",
    "contactId": "abc123"
  }
}