Contacts

Get Contact

get

https://api.dmchamp.com/v1https://us-central1-whatzaidev.cloudfunctions.net/api/v1

/contacts

Get a contact by phone number or email

Authorizations

ApiKeyAuthUserIdAuth

apiKeystringRequired

Your DM Champ API key. Obtain from Settings → API Keys.

Query parameters

apiKeystringOptional

API key for authentication. At least one of apiKey or userId is required for protected endpoints.

Example: your_api_key

phoneNumberstringOptional

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

Example: [phone]

emailstring · emailOptional

Contact's email address

Example: [email protected]

Responses

200

Contact found

application/json

successbooleanOptionalExample: true

contactIdstringOptionalExample: abc123

400

Invalid request

application/json

401

Unauthorized

application/json

404

Contact not found

application/json

500

Server error

application/json

get

/contacts

HTTPcURLJavaScriptPython

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

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

Create New Contact

post

https://api.dmchamp.com/v1https://us-central1-whatzaidev.cloudfunctions.net/api/v1

/contacts

Create a new contact with phone number and optional information.

New Feature: You can now optionally add the contact to one or more lists upon creation.

List Assignment Options:

• Use listId for adding to a single list (simpler for single list case)

• Use listIds for adding to multiple lists (array format)

• If both are provided, listIds takes precedence

The API will:

• Validate that all lists exist

• Verify you have permission to add contacts to each list

• Create the contact and add it to the specified lists atomically

If any list validation fails, the contact will not be created.

Authorizations

ApiKeyAuthUserIdAuth

apiKeystringRequired

Your DM Champ API key. Obtain from Settings → API Keys.

Query parameters

apiKeystringOptional

API key for authentication. At least one of apiKey or userId is required for protected endpoints.

Example: your_api_key

Body

application/json

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: [email protected]

is_bot_activebooleanOptional

Whether the bot is active for this contact

Default: true

listIdstringOptional

Single list ID to add the contact to upon creation

Example: list123

listIdsstring[]Optional

Multiple list IDs to add the contact to upon creation (takes precedence over listId)

Example: ["list123","list456"]

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

do_not_disturbbooleanOptional

Whether the contact should not be disturbed

Default: false

Responses

200

Contact created successfully

application/json

successbooleanOptionalExample: true

400

Invalid request

application/json

401

Unauthorized

application/json

403

Permission denied

application/json

404

List not found

application/json

409

Contact already exists

application/json

post

/contacts

HTTPcURLJavaScriptPython

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

{
  "phoneNumber": "[phone]",
  "firstName": "John",
  "lastName": "Doe",
  "email": "[email protected]",
  "is_bot_active": true
}

Create contact without listsCreate contact with single list (using listId)Create contact with multiple lists (using listIds)

{
  "success": true,
  "data": {
    "message": "Successfully created new contact",
    "contactId": "abc123",
    "listsAdded": [
      "list123",
      "list456"
    ]
  }
}

Update Contact

put

https://api.dmchamp.com/v1https://us-central1-whatzaidev.cloudfunctions.net/api/v1

/contacts/{contactId}

Update an existing contact's information

Authorizations

ApiKeyAuthUserIdAuth

apiKeystringRequired

Your DM Champ API key. Obtain from Settings → API Keys.

Path parameters

contactIdstringRequired

ID of the contact to update

Query parameters

apiKeystringOptional

API key for authentication. At least one of apiKey or userId is required for protected endpoints.

Example: your_api_key

Body

application/json

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

successbooleanOptionalExample: true

messagestringOptionalExample: Contact updated successfully

400

Invalid request

application/json

401

Unauthorized

application/json

404

Contact not found

application/json

500

Server error

application/json

put

/contacts/{contactId}

HTTPcURLJavaScriptPython

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 Contact To List

post

https://api.dmchamp.com/v1https://us-central1-whatzaidev.cloudfunctions.net/api/v1

/contacts/lists

Add a specific contact to a list

Authorizations

ApiKeyAuthUserIdAuth

apiKeystringRequired

Your DM Champ API key. Obtain from Settings → API Keys.

Query parameters

apiKeystringOptional

API key for authentication. At least one of apiKey or userId is required for protected endpoints.

Example: your_api_key

Body

application/json

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

successbooleanOptionalExample: true

messagestringOptionalExample: Contact successfully added to list My List

400

Missing required parameters

application/json

401

Unauthorized

application/json

403

Permission denied

application/json

500

Server error

application/json

post

/contacts/lists

HTTPcURLJavaScriptPython

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

https://api.dmchamp.com/v1https://us-central1-whatzaidev.cloudfunctions.net/api/v1

/contacts/lists

Remove a specific contact from a list

Authorizations

ApiKeyAuthUserIdAuth

apiKeystringRequired

Your DM Champ API key. Obtain from Settings → API Keys.

Query parameters

apiKeystringOptional

API key for authentication. At least one of apiKey or userId is required for protected endpoints.

Example: your_api_key

contactIdstringRequired

ID of the contact to remove from the list

Example: contact123

listIdstringRequired

ID of the list to remove the contact from

Example: list456

Responses

200

Contact removed from list successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Contact successfully removed from list My List

400

Missing required parameters

application/json

401

Unauthorized

application/json

403

Permission denied

application/json

500

Server error

application/json

delete

/contacts/lists

HTTPcURLJavaScriptPython

DELETE /v1/contacts/lists?contactId=text&listId=text HTTP/1.1
Host: api.dmchamp.com
Accept: */*

{
  "success": true,
  "message": "Contact successfully removed from list My List"
}

Get Contact Tags

get

https://api.dmchamp.com/v1https://us-central1-whatzaidev.cloudfunctions.net/api/v1

/contacts/tags/{contactId}

Get all tags associated with a contact

Authorizations

ApiKeyAuthUserIdAuth

apiKeystringRequired

Your DM Champ API key. Obtain from Settings → API Keys.

Path parameters

contactIdstringRequired

ID of the contact to get tags for

Query parameters

apiKeystringOptional

API key for authentication. At least one of apiKey or userId is required for protected endpoints.

Example: your_api_key

Responses

200

List of contact tags

application/json

namestringRequired

Tag name

descriptionstringOptional

Tag description

400

Missing contact ID

application/json

401

Unauthorized

application/json

404

Contact not found

application/json

get

/contacts/tags/{contactId}

HTTPcURLJavaScriptPython

GET /v1/contacts/tags/{contactId} HTTP/1.1
Host: api.dmchamp.com
Accept: */*

[
  {
    "name": "text",
    "description": "text"
  }
]

Get Contact Messages

get

https://api.dmchamp.com/v1https://us-central1-whatzaidev.cloudfunctions.net/api/v1

/contacts/messages/{contactId}

Retrieve messages for a specific contact

Authorizations

ApiKeyAuthUserIdAuth

apiKeystringRequired

Your DM Champ API key. Obtain from Settings → API Keys.

Path parameters

contactIdstringRequired

ID of the contact to get messages for

Query parameters

apiKeystringOptional

API key for authentication. At least one of apiKey or userId is required for protected endpoints.

Example: your_api_key

Responses

200

List of messages

application/json

successbooleanOptionalExample: true

400

Missing contact ID

application/json

401

Unauthorized

application/json

404

Contact not found

application/json

get

/contacts/messages/{contactId}

HTTPcURLJavaScriptPython

GET /v1/contacts/messages/{contactId} HTTP/1.1
Host: api.dmchamp.com
Accept: */*

{
  "success": true,
  "data": [
    {
      "content": "text",
      "timestamp": "2026-02-27T20:31:11.425Z",
      "sender": "text",
      "channel": "text"
    }
  ]
}