Import Leads Directly Into The CRM

Import leads from your website using the API

Customer Database App Restful API

The API is an easy way to add new customers to your CRM from another application like a website. You'll probably only need to create a customer, but should you want to add additional tasks/notes you can do that too.

CREATE A CUSTOMER

POST https://account.customerdatabase.app/api/customer/add
BODY formdata
forename
Richard
Required
surame
Hendricks
Required
email[0]
[email protected]
Required
email[1]
[email protected]
phone[0]
01271444555
keys[0]
f-4bc9a801-f63d-4b9c-b527-a0cbe902828b
keys[1]
f-7515a3ca-b5ef-4f74-9c30-621f502886de
values[0]
Blue
values[1]
43

EXAMPLE REQUEST
Example Request
curl -H "Apikey:YourAPIKey" --location --request POST 'https://account.customerdatabase.app/api/customer/add' \
--form 'forename="Richard"' \
--form 'surname="Hendricks"' \
--form 'email[0]="[email protected]"' \
--form 'email[1]="[email protected]"' \
--form 'phone[0]="01271444555"' \
--form 'keys[0]="f-4bc9a801-f63d-4b9c-b527-a0cbe902828b"' \
--form 'values[0]="Blue"' \
--form 'keys[1]="f-7515a3ca-b5ef-4f74-9c30-621f502886de"' \
--form 'values[1]="43"'

RESPONSE

If a customer has been created successfully the result will be set to true and the message will contain the ID of the customer.

Response
{
    "message":"10428",
    "result":true
}

CREATE A PIPELINE

POST https://account.customerdatabase.app/api/pipeline/add
BODY formdata
customerid
10428
Required
reference
abc123
Required
pipelinetypeid
1
Required
stageid
1
userid
1
keys[0]
f-e0c124cb-b838-4f39-a078-4ef489995b6f
keys[1]
f-c25257rd-a542-6f36-n072-1fa585935b6f
values[0]
Comment from website
values[1]
1400

EXAMPLE REQUEST
Example Request
curl -H "Apikey:YourAPIKey" --location --request POST 'https://account.customerdatabase.app/api/pipeline/add' \
--form 'customerid="10428"' \
--form 'reference="abc123"' \
--form 'pipelinetypeid="1"' \
--form 'stageid="1"' \
--form 'userid="1"' \
--form 'keys[0]="f-e0c124cb-b838-4f39-a078-4ef489995b6f"' \
--form 'keys[1]="f-c25257rd-a542-6f36-n072-1fa585935b6f"' \
--form 'values[0]="Comment from website"' \
--form 'userid="1400"'

RESPONSE

If a pipeline has been created successfully the result will be set to true and the message will contain the ID of the pipeline.

Response
{
    "message":"1337",
    "result":true
}

CREATE A CUSTOMER NOTE

POST https://account.customerdatabase.app/api/customer/note/add
BODY formdata
customerid
10428
Required
note
Customer enquiry from marketing website.
Required

EXAMPLE REQUEST
Example Request
curl -H "Apikey:YourAPIKey" --location --request POST 'https://account.customerdatabase.app/api/customer/note/add' \
--form 'customerid="10428"' \
--form 'note="Customer enquiry from marketing website."'

RESPONSE

If a note has been created successfully the result will be set to true and the message will contain the ID of the note.

Response
{
    "message":"431",
    "result":true
}

CREATE A CUSTOMER EVENT

POST https://account.customerdatabase.app/api/customer/event/add
BODY formdata
customerid
10428
Required
startdatetime
31/10/2022 09:00:00
Required
enddatetime
31/10/2022 17:00:00
Required
name
Meeting with Richard
Required
location
Sheffield Office
description
Meeting to discuss requirements
attendees[0]
50
attendees[1]
51
attendees[2]
52
attendeeuser[0]
1
attendeeuser[1]
2

EXAMPLE REQUEST
Example Request
curl -H "Apikey:YourAPIKey" --location --request POST 'https://account.customerdatabase.app/api/customer/event/add' \
--form 'customerid="10428"' \
--form 'startdatetime="31/10/2022 09:00:00"' \
--form 'enddatetime="31/10/2022 17:00:00"' \
--form 'name="Meeting with Richard"' \
--form 'location="Sheffield Office"' \
--form 'description="Meeting to discuss requirements"' \
--form 'attendees[0]="50"' \
--form 'attendees[1]="51"' \
--form 'attendees[2]="52"' \
--form 'attendeesuser[0]="1"' \
--form 'attendeesuser[1]="2"'

RESPONSE

If a event has been created successfully the result will be set to true and the message will contain the ID of the event.

Response
{
    "message":"564",
    "result":true
}

CREATE A CUSTOMER TASK

POST https://account.customerdatabase.app/api/customer/task/add
BODY formdata
customerid
10428
Required
datedue
31/10/2022
Required
name
Arrange a meeting with Richard
Required
description
Arrange first meeting
users[0]
1
users[1]
2

EXAMPLE REQUEST
Example Request
curl -H "Apikey:YourAPIKey" --location --request POST 'https://account.customerdatabase.app/api/customer/event/add' \
--form 'customerid="10428"' \
--form 'datedue="31/10/2022"' \
--form 'name="Arrange a meeting with Richard"' \
--form 'description="Arrange first meeting"' \
--form 'users[0]="1"' \
--form 'users[1]="2"'

RESPONSE

If a task has been created successfully the result will be set to true and the message will contain the ID of the task.

Response
{
    "message":"743",
    "result":true
}

CREATE A PIPELINE NOTE

POST https://account.customerdatabase.app/api/pipeline/note/add
BODY formdata
pipelineid
1337
Required
note
Enquiry for product XYZ from marketing website.
Required

EXAMPLE REQUEST
Example Request
curl -H "Apikey:YourAPIKey" --location --request POST 'https://account.customerdatabase.app/api/pipeline/note/add' \
--form 'pipeline="1337"' \
--form 'note="Enquiry for product XYZ from marketing website."'

RESPONSE

If a note has been created successfully the result will be set to true and the message will contain the ID of the note.

Response
{
    "message":"834",
    "result":true
}

CREATE A PIPELINE TASK

POST https://account.customerdatabase.app/api/pipeline/task/add
BODY formdata
pipelineid
1337
Required
datedue
31/10/2022
Required
name
Arrange a meeting with Richard
Required
description
Arrange first meeting
users[0]
1
users[1]
2

EXAMPLE REQUEST
Example Request
curl -H "Apikey:YourAPIKey" --location --request POST 'https://account.customerdatabase.app/api/pipeline/event/add' \
--form 'pipelineid="1337"' \
--form 'datedue="31/10/2022"' \
--form 'name="Arrange a meeting with Richard"' \
--form 'description="Arrange first meeting"' \
--form 'users[0]="1"' \
--form 'users[1]="2"'

RESPONSE

If a task has been created successfully the result will be set to true and the message will contain the ID of the task.

Response
{
    "message":"863",
    "result":true
}

For videos and tips take a look at our CRM help page.

About the Author

Sarah Jones

Sarah Jones

Sarah writes the documentation for Customer Database App. She has a background of CRM product design and has done various marketing roles in the past.

Twitter YouTube

Manage Your Customer Relationships Like A Pro

Designed for small business the Customer Database App can help you communicate with your customers more effectively. Open up sales opportunities that may have otherwise been missed or taken to much time to pursue before.
Create Account (it's free)