Contacts
Get a contact by phone number or email
API key for authentication
your_api_keyContact's phone number (must include valid country code)
+1234567890Contact found
Invalid request
Unauthorized
Contact not found
Server error
GET /v1/contacts HTTP/1.1
Host: api.dmchamp.com
Accept: */*
{
"success": true,
"contactId": "abc123"
}Create a new contact with phone number and optional information
API key for authentication
your_api_keyContact's phone number (must include valid country code)
Contact's first name
UnknownContact's last name
UnknownContact's Instagram ID
Current campaign identifier
Data associated with current campaign
Communication channel
Whether chat window is open
falseExternal identifier
Custom channel identifier
Chat widget identifier
Whether the bot is active for this contact
trueWhether the contact should not be disturbed
falseContact created successfully
Invalid request
Unauthorized
Contact already exists
POST /v1/contacts HTTP/1.1
Host: api.dmchamp.com
Content-Type: application/json
Accept: */*
Content-Length: 136
{
"phoneNumber": "+1234567890",
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"is_bot_active": true,
"do_not_disturb": false
}{
"success": true,
"data": {
"message": "Successfully created new contact",
"contactId": "abc123"
}
}Update an existing contact's information
ID of the contact to update
API key for authentication
your_api_keyContact's first name
Contact's last name
Contact's email address
Whether the bot is active for this contact
Whether the contact should not be disturbed
Contact updated successfully
Invalid request
Unauthorized
Contact not found
Server error
PUT /v1/contacts/{contactId} HTTP/1.1
Host: api.dmchamp.com
Content-Type: application/json
Accept: */*
Content-Length: 108
{
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"is_bot_active": false,
"do_not_disturb": true
}{
"success": true,
"message": "Contact updated successfully"
}Add a specific contact to a list
API key for authentication
your_api_keyID of the contact to add to the list
ID of the list to add the contact to
Contact added to list successfully
Missing required parameters
Unauthorized
Permission denied
Server error
POST /v1/contacts/lists HTTP/1.1
Host: api.dmchamp.com
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"contactId": "contact123",
"listId": "list456"
}{
"success": true,
"message": "Contact successfully added to list My List"
}Remove a specific contact from a list
API key for authentication
your_api_keyID of the contact to remove from the list
ID of the list to remove the contact from
Contact removed from list successfully
Missing required parameters
Unauthorized
Permission denied
Server error
DELETE /v1/contacts/lists HTTP/1.1
Host: api.dmchamp.com
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"contactId": "contact123",
"listId": "list456"
}{
"success": true,
"message": "Contact successfully removed from list My List"
}Get all tags associated with a contact
ID of the contact to get tags for
API key for authentication
your_api_keyList of contact tags
Missing contact ID
Unauthorized
Contact not found
GET /v1/contacts/tags/{contactId} HTTP/1.1
Host: api.dmchamp.com
Accept: */*
[
{
"name": "text",
"description": "text"
}
]Retrieve messages for a specific contact
ID of the contact to get messages for
API key for authentication
your_api_keyList of messages
Missing contact ID
Unauthorized
Contact not found
GET /v1/contacts/messages/{contactId} HTTP/1.1
Host: api.dmchamp.com
Accept: */*
{
"success": true,
"data": [
{
"content": "text",
"timestamp": "2025-10-30T16:37:18.910Z",
"sender": "text",
"channel": "text"
}
]
}Was this helpful?

