LogoLogo
Roadmap
  • ๐ŸŒWelcome
  • Get Started
    • ๐Ÿš€DM Champ Accelerator
    • ๐Ÿ“žConnecting Phone
    • ๐Ÿ‘คCreating Contacts
    • ๐Ÿ“šList and Contact Management
    • โฌ†๏ธImporting Contacts
    • โฌ‡๏ธExporting Contacts
    • ๐Ÿ“…Connecting Google Calendar
    • ๐Ÿ”ขBilling System
    • ๐Ÿ“Creating Campaigns
    • ๐Ÿท๏ธCreating Tags
    • ๐ŸชSetting Up Webhooks
    • ๐ŸงฎAgency Accounts
    • ๐Ÿค–GHL (and others) Integration
    • โณFunnels
    • Connecting Facebook and Instagram
    • ๐Ÿ’ฌChats
    • ๐Ÿ’ฌChat Widget
    • WhatsApp Widget
    • ๐Ÿ“ŠDashboard
  • ๐Ÿ–Œ๏ธWebhooks + Custom Functions
  • ๐Ÿ”งMastering Custom Functions and Integrations
  • ๐Ÿท๏ธTags and Custom Functions
  • ๐Ÿ”ŽReal-time Web Search
  • Instagram DM Flow
  • Facebook Messenger DM Flow
  • API
    • System
    • Contacts
    • Tags
    • Summaries
    • Chat Widget
    • WhatsApp Templates
    • WhatsApp Widget
    • Messages
    • SubAccounts
    • Users
Powered by GitBook
On this page

Was this helpful?

  1. API

Contacts

PreviousSystemNextTags

Was this helpful?

Get Contact Tags

get

Get all tags associated with a contact

Path parameters
contactIdstringRequired

ID of the contact to get tags for

Query parameters
apiKeystringOptional

API key for authentication

Example: your_api_key
Responses
200
List of contact tags
application/json
400
Missing contact ID
application/json
401
Unauthorized
application/json
404
Contact not found
application/json
get
GET /v1/contacts/tags/{contactId} HTTP/1.1
Host: api.dmchamp.com
Accept: */*
[
  {
    "name": "text",
    "description": "text"
  }
]

Get Contact Messages

get

Retrieve messages for a specific contact

Path parameters
contactIdstringRequired

ID of the contact to get messages for

Query parameters
apiKeystringOptional

API key for authentication

Example: your_api_key
Responses
200
List of messages
application/json
400
Missing contact ID
application/json
401
Unauthorized
application/json
404
Contact not found
application/json
get
GET /v1/contacts/messages/{contactId} HTTP/1.1
Host: api.dmchamp.com
Accept: */*
{
  "success": true,
  "data": [
    {
      "content": "text",
      "timestamp": "2025-06-13T11:26:28.019Z",
      "sender": "text",
      "channel": "text"
    }
  ]
}
  • GETGet Contact
  • POSTCreate New Contact
  • PUTUpdate Contact
  • POSTAdd Contact To List
  • DELETERemove Contact From List
  • GETGet Contact Tags
  • GETGet Contact Messages

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: +1234567890
emailstring ยท emailOptional

Contact's email address

Example: john@example.com
Responses
200
Contact found
application/json
400
Invalid request
application/json
401
Unauthorized
application/json
404
Contact not found
application/json
500
Server error
application/json
get
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: unknown@unknown.com
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
200
Contact created successfully
application/json
400
Invalid request
application/json
401
Unauthorized
application/json
409
Contact already exists
application/json
post
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": "john@example.com",
  "is_bot_active": true,
  "do_not_disturb": false
}
{
  "success": true,
  "data": {
    "message": "Successfully created new contact",
    "contactId": "abc123"
  }
}

Update Contact

put

Update an existing contact's information

Path parameters
contactIdstringRequired

ID of the contact to update

Query parameters
apiKeystringOptional

API key for authentication

Example: your_api_key
Body
firstNamestringOptional

Contact's first name

lastNamestringOptional

Contact's last name

emailstring ยท emailOptional

Contact's email address

is_bot_activebooleanOptional

Whether the bot is active for this contact

do_not_disturbbooleanOptional

Whether the contact should not be disturbed

Responses
200
Contact updated successfully
application/json
400
Invalid request
application/json
401
Unauthorized
application/json
404
Contact not found
application/json
500
Server error
application/json
put
PUT /v1/contacts/{contactId} HTTP/1.1
Host: api.dmchamp.com
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "is_bot_active": false,
  "do_not_disturb": true
}
{
  "success": true,
  "message": "Contact updated successfully"
}

Add Contact To List

post

Add a specific contact to a list

Query parameters
apiKeystringOptional

API key for authentication

Example: your_api_key
Body
contactIdstringRequired

ID of the contact to add to the list

listIdstringRequired

ID of the list to add the contact to

Responses
200
Contact added to list successfully
application/json
400
Missing required parameters
application/json
401
Unauthorized
application/json
403
Permission denied
application/json
500
Server error
application/json
post
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 Contact From List

delete

Remove a specific contact from a list

Query parameters
apiKeystringOptional

API key for authentication

Example: your_api_key
Body
contactIdstringRequired

ID of the contact to remove from the list

listIdstringRequired

ID of the list to remove the contact from

Responses
200
Contact removed from list successfully
application/json
400
Missing required parameters
application/json
401
Unauthorized
application/json
403
Permission denied
application/json
500
Server error
application/json
delete
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"
}