API Test Keys

Contacts Entity

The Contacts Entity has the following parameters:

Is this page helpful?

Entity

1{
2  "id": "cont_00000000000001",
3  "entity": "contact",
4  "name": "Gaurav Kumar",
5  "contact": "9000090000",
6  "email": "gaurav.kumar@example.com",
7  "type": "employee",
8  "reference_id": "Acme Contact ID 12345",
9  "batch_id": null,
10  "active": true,
11  "notes": {
12    "notes_key_1": "Tea, Earl Grey, Hot",
13    "notes_key_2": "Tea, Earl Grey… decaf."
14  },
15  "created_at": 1545320320
16}

id

string

The unique identifier linked to the contact. For example, cont_00000000000001.

entity

string

The entity being created. Here, it is contact.

name

string

The contact's name. For example, Gaurav Kumar.

contact

string

The contact's phone number. For example, 9000090000.

email

string

The contact's email address. For example, gaurav.kumar@example.com.

type

string

A classification for the contact being created. For example, employee.

reference_id

string

A user-entered reference for the contact. For example, Acme Contact ID 12345.

batch_id

string

This value is returned if the contact was created as part of a bulk upload. For example, batch_00000000000001.

active

boolean

Possible values:

true (default) : active
false : inactive

notes

object

Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

created_at

integer

Timestamp, in Unix, when the contact was created. For example, 1545320320.

Contacts Entity

The Contacts Entity has the following parameters:

Is this page helpful?

id

string

The unique identifier linked to the contact. For example, cont_00000000000001.

entity

string

The entity being created. Here, it is contact.

name

string

The contact's name. For example, Gaurav Kumar.

contact

string

The contact's phone number. For example, 9000090000.

email

string

The contact's email address. For example, gaurav.kumar@example.com.

type

string

A classification for the contact being created. For example, employee.

reference_id

string

A user-entered reference for the contact. For example, Acme Contact ID 12345.

batch_id

string

This value is returned if the contact was created as part of a bulk upload. For example, batch_00000000000001.

active

boolean

Possible values:

true (default) : active
false : inactive

notes

object

Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

created_at

integer

Timestamp, in Unix, when the contact was created. For example, 1545320320.

Entity

1{
2  "id": "cont_00000000000001",
3  "entity": "contact",
4  "name": "Gaurav Kumar",
5  "contact": "9000090000",
6  "email": "gaurav.kumar@example.com",
7  "type": "employee",
8  "reference_id": "Acme Contact ID 12345",
9  "batch_id": null,
10  "active": true,
11  "notes": {
12    "notes_key_1": "Tea, Earl Grey, Hot",
13    "notes_key_2": "Tea, Earl Grey… decaf."
14  },
15  "created_at": 1545320320
16}