API Documentation
Contacts ¶
Overview
A Contact is an object, belonging to a user which holds various information about another person, ranging from phone numbers and email to birthdays and company information. A contact is a personal object, meaning each user has a set of them individually.
Contact
A Contact is a simple and small object that contains an actual Attributes.
| Field | Type | association | Description |
|---|---|---|---|
| id | uuid | Internal identifier of the contact | |
| created_at | number | ||
| updated_at | number | ||
| deleted_at | number | ||
| created_by | User | contact.created_by | User who created this contact |
| updated_by | User | contact.updated_by | User who created this contact |
| ios_address_book_id | string | Address book id of this contact on iOS device | |
| android_address_book_id | string | Address book id of this contact on Android device | |
| user | User | contact.user | Owner of the contact. association: contact.user |
| brand | Brand | contact.brand | The team this object belongs to |
| attributes | Attribute[] | contact.attributes | List of contact’s attributes |
| summary | Summary | contact.summary | A plain simple object containing some of the global attribute values of the contact |
| lists | ContactList[] | contact.lists | List of the contact lists this contact is a member of |
| users | User[] | contact.users | Users matching credential fields of this contact |
| deals | Deal[] | contact.deals | Deals that have a role matching credential fields of this contact |
| flows | Flow[] | contact.flows | Flows that this contact has been enrolled into |
Contact’s available model associations are as follows:
-
contact.attributes -
contact.flows -
contact.summary -
contact.lists -
contact.users -
contact.deals -
contact.brand -
contact.user -
contact.created_by -
contact.updated_by
Get all user contacts ¶
Get all user contactsGET/contacts
Example URI
GET /contacts
URI Parameters
- start
number(optional)- limit
number(optional) Default: 10- order
string(optional) Example: created_atPut a minus sign before field name for descending order
- Members:
display_namesort_fieldlast_touchnext_touchcreated_atupdated_at
- Members:
Response
200Body
{
"code": "OK",
"data": [
{
"id": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"display_name": "Johnny",
"partner_name": "Jane Doe",
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Johnny",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": null,
"android_address_book_id": null,
"created_at": 1791656411.19719,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "direct_request",
"updated_for": "direct_request",
"deleted_for": null,
"title": null,
"first_name": "John",
"partner_first_name": "Jane",
"middle_name": "M.",
"last_name": "Doe",
"partner_last_name": "Doe",
"marketing_name": null,
"nickname": "Johnny",
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": "[email protected]",
"phone_number": "+989124834198",
"primary_phone_number": "+989124834198",
"phone_numbers": [
"+989124834198"
],
"company": "Rechat",
"birthday": "1970-01-12T00:00:00.000Z",
"profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"job_title": "Contact Test Subject",
"source_type": "ExplicitlyCreated",
"source": null,
"website": [
"http://www.gholi.com"
],
"tags": [
"poo",
"foo",
"New"
],
"address": [
{
"city": "Dallas",
"full": "Street, Dallas Texas 72890",
"name": "Street",
"type": "stdaddr",
"extra": "Office",
"line1": "Street",
"line2": "Dallas Texas 72890",
"state": "Texas",
"country": "US",
"postcode": "72890"
}
],
"type": "contact"
},
{
"id": "9aca45ab-843e-4ee5-983a-73b9de6c0570",
"display_name": "ACME Corporation",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "ACME Corporation",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": null,
"android_address_book_id": null,
"created_at": 1791656411.259699,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "direct_request",
"updated_for": "direct_request",
"deleted_for": null,
"title": null,
"first_name": null,
"partner_first_name": null,
"middle_name": null,
"last_name": null,
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": null,
"primary_email": null,
"emails": null,
"parked": false,
"partner_email": null,
"phone_number": null,
"primary_phone_number": null,
"phone_numbers": null,
"company": "ACME Corporation",
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": null,
"source": null,
"website": null,
"tags": null,
"address": null,
"type": "contact"
},
{
"id": "9af2447d-e98f-4526-89f1-bf5c56e6db0d",
"display_name": "Kate Bell",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Bell Kate",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": "177C371E-701D-42F8-A03B-C61CA31627F6",
"android_address_book_id": null,
"created_at": 1791656411.402803,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": "Kate",
"partner_first_name": null,
"middle_name": null,
"last_name": "Bell",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": "(415) 555-3695",
"primary_phone_number": "(415) 555-3695",
"phone_numbers": [
"(415) 555-3695",
"(555) 564-8583"
],
"company": null,
"birthday": "1978-01-13T00:00:00.000Z",
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": null,
"address": [
{
"city": "Hillsborough",
"full": "165 Davis Street, Hillsborough CA 94010",
"name": "Davis",
"type": "stdaddr",
"line1": "165 Davis Street",
"line2": "Hillsborough CA 94010",
"state": "CA",
"suftype": "Street",
"postcode": "94010",
"house_num": "165"
}
],
"type": "contact"
},
{
"id": "ae2d782c-79aa-4d4f-a05d-bbbdfc59f906",
"display_name": "Daniel Higgins",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Higgins Daniel",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": "AB211C5F-9EC9-429F-9466-B9382FF61035",
"android_address_book_id": null,
"created_at": 1791656411.402864,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": "Daniel",
"partner_first_name": null,
"middle_name": null,
"last_name": "Higgins",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": "(408) 555-3514",
"primary_phone_number": "(408) 555-3514",
"phone_numbers": [
"(408) 555-3514",
"(408) 555-5270",
"555-478-7672"
],
"company": null,
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": null,
"address": [
{
"city": "Corte Madera",
"full": "322 Laguna Street, Corte Madera CA 94925",
"name": "Laguna",
"type": "stdaddr",
"line1": "322 Laguna Street",
"line2": "Corte Madera CA 94925",
"state": "CA",
"suftype": "Street",
"postcode": "94925",
"house_num": "322"
}
],
"type": "contact"
},
{
"id": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"display_name": "John Appleseed",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Appleseed John",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": "410FE041-5C4E-48DA-B4DE-04C15EA3DBAC",
"android_address_book_id": null,
"created_at": 1791656411.402881,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": "John",
"partner_first_name": null,
"middle_name": null,
"last_name": "Appleseed",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]",
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": "888-555-1212",
"primary_phone_number": "888-555-1212",
"phone_numbers": [
"888-555-1212",
"888-555-5512"
],
"company": null,
"birthday": "1980-06-17T00:00:00.000Z",
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": null,
"address": [
{
"city": "Atlanta",
"full": "3494 Kuhl Avenue, Atlanta GA 30303",
"name": "Kuhl",
"type": "stdaddr",
"line1": "3494 Kuhl Avenue",
"line2": "Atlanta GA 30303",
"state": "GA",
"suftype": "Avenue",
"postcode": "30303",
"house_num": "3494"
}
],
"type": "contact"
},
{
"id": "ba15442d-4fb5-4e3f-9437-5b44bdd0bc09",
"display_name": "Anna Haro",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Haro Anna",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": "F57C8277-585D-4327-88A6-B5689FF69DFE",
"android_address_book_id": null,
"created_at": 1791656411.402895,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": "Anna",
"partner_first_name": null,
"middle_name": null,
"last_name": "Haro",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": "555-522-8243",
"primary_phone_number": "555-522-8243",
"phone_numbers": [
"555-522-8243"
],
"company": null,
"birthday": "1985-08-22T00:00:00.000Z",
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": null,
"address": [
{
"city": "Sausalito",
"full": "1001 Leavenworth Street, Sausalito CA 94965",
"name": "Leavenworth",
"type": "stdaddr",
"line1": "1001 Leavenworth Street",
"line2": "Sausalito CA 94965",
"state": "CA",
"suftype": "Street",
"postcode": "94965",
"house_num": "1001"
}
],
"type": "contact"
},
{
"id": "e85fa0eb-5342-4aa6-983d-464a22eab7e0",
"display_name": "Zakroff",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Zakroff",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": null,
"android_address_book_id": null,
"created_at": 1791656411.402907,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": null,
"partner_first_name": null,
"middle_name": null,
"last_name": "Zakroff",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": null,
"primary_phone_number": null,
"phone_numbers": null,
"company": null,
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": null,
"source": null,
"website": null,
"tags": null,
"address": null,
"type": "contact"
},
{
"id": "3a5c5367-ea58-4b39-a40a-9c5c475cd721",
"display_name": "Hank Zakroff",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Zakroff Hank",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": "2E73EE73-C03F-4D5F-B1E8-44E85A70F170",
"android_address_book_id": null,
"created_at": 1791656411.402919,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": "Hank",
"partner_first_name": null,
"middle_name": null,
"last_name": "Zakroff",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": "(707) 555-1854",
"primary_phone_number": "(707) 555-1854",
"phone_numbers": [
"(707) 555-1854",
"(555) 766-4823"
],
"company": null,
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": null,
"address": [
{
"city": "San Rafael",
"full": "1741 Kearny Street, San Rafael CA 94901",
"name": "Kearny",
"type": "stdaddr",
"line1": "1741 Kearny Street",
"line2": "San Rafael CA 94901",
"state": "CA",
"suftype": "Street",
"postcode": "94901",
"house_num": "1741"
}
],
"type": "contact"
},
{
"id": "09d95c20-f514-4484-acf3-923d8535970b",
"display_name": "David",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "David",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": "E94CD15C-7964-4A9B-8AC4-10D7CFB791FD",
"android_address_book_id": null,
"created_at": 1791656411.402931,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": "David",
"partner_first_name": null,
"middle_name": null,
"last_name": null,
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": null,
"primary_email": null,
"emails": null,
"parked": false,
"partner_email": null,
"phone_number": "555-610-6679",
"primary_phone_number": "555-610-6679",
"phone_numbers": [
"555-610-6679"
],
"company": null,
"birthday": "1998-06-15T00:00:00.000Z",
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": null,
"address": null,
"type": "contact"
},
{
"id": "0b6a0ea4-a364-443f-a28e-5f3a3a66b0ab",
"display_name": "David Taylor",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Taylor David",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": "E94CD15C-7964-4A9B-8AC4-10D7CFB791FD",
"android_address_book_id": null,
"created_at": 1791656411.402943,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": "David",
"partner_first_name": null,
"middle_name": null,
"last_name": "Taylor",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": null,
"primary_email": null,
"emails": null,
"parked": false,
"partner_email": null,
"phone_number": "555-610-6679",
"primary_phone_number": "555-610-6679",
"phone_numbers": [
"555-610-6679"
],
"company": null,
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": null,
"address": [
{
"city": "Tiburon",
"full": "1747 Steuart Street, Tiburon CA 94920",
"name": "Steuart",
"type": "stdaddr",
"line1": "1747 Steuart Street",
"line2": "Tiburon CA 94920",
"state": "CA",
"suftype": "Street",
"postcode": "94920",
"house_num": "1747"
}
],
"type": "contact"
},
{
"id": "1c99784d-71e7-4c2c-8f6c-0f6eb0ad5bee",
"display_name": "Goat Boy",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Boy Goat",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": "52EAB13E-733F-4153-B019-9A83EE67171D:ABPerson",
"android_address_book_id": null,
"created_at": 1791656411.402955,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": "Goat",
"partner_first_name": null,
"middle_name": null,
"last_name": "Boy",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": null,
"primary_phone_number": null,
"phone_numbers": null,
"company": null,
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": null,
"address": [
{
"city": "Union",
"full": "50 Park, Union 33333",
"name": "50 Park",
"type": "stdaddr",
"line1": "50 Park",
"line2": "Union 33333",
"state": "33333"
}
],
"type": "contact"
},
{
"id": "e73d21b9-1a37-4b73-9e2b-c496d05f3ddb",
"display_name": "Goat Boy 2",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Boy 2 Goat",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": "52EAB13E-733F-4153-B019-9A83EE67171D:ABPerson",
"android_address_book_id": null,
"created_at": 1791656411.402966,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": "Goat",
"partner_first_name": null,
"middle_name": null,
"last_name": "Boy 2",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": null,
"primary_phone_number": null,
"phone_numbers": null,
"company": null,
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": null,
"address": [
{
"city": "Union",
"full": "50 Park, Union 33333",
"name": "50 Park",
"type": "stdaddr",
"line1": "50 Park",
"line2": "Union 33333",
"state": "33333"
}
],
"type": "contact"
}
],
"info": {
"count": 12,
"total": 12
}
}Create a new contact ¶
Create a new contactPOST/contacts
Example URI
POST /contacts
URI Parameters
- get
string(required) Example: true- relax
string(required) Example: false- activity
string(required) Example: true- associations
array(optional) Example: contact_attribute.attribute_def,contact.attributes,contact.summary
Request
Body
{
"contacts": [
{
"attributes": [
{
"text": "[email protected]",
"label": "Work",
"is_primary": true,
"attribute_def": "d5b21d60-d87a-4eec-ad11-7e50252f57d0"
},
{
"text": "[email protected]",
"label": "Work",
"is_primary": true,
"is_partner": true,
"attribute_def": "d5b21d60-d87a-4eec-ad11-7e50252f57d0"
},
{
"text": "+989124834198",
"label": "Mobile",
"is_primary": true,
"attribute_def": "7c6b51bc-ee90-4f34-972f-d85f7d7c7f44"
},
{
"text": "John",
"attribute_def": "36fd9fd2-b672-41c0-966f-2c7673421a4e"
},
{
"text": "Jane",
"is_partner": true,
"attribute_def": "36fd9fd2-b672-41c0-966f-2c7673421a4e"
},
{
"text": "M.",
"attribute_def": "e49439d9-0887-4b17-b05b-22831cb34906"
},
{
"text": "Doe",
"attribute_def": "2df407b0-9283-4e06-84ca-1cd765903987"
},
{
"text": "Doe",
"is_partner": true,
"attribute_def": "2df407b0-9283-4e06-84ca-1cd765903987"
},
{
"text": "Johnny",
"attribute_def": "cd148024-757a-4b51-9925-159363a6dfe2"
},
{
"text": "New",
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7"
},
{
"text": "foo",
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7"
},
{
"text": "poo",
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7"
},
{
"date": 1000000,
"attribute_def": "fec55617-ade5-4a11-b416-05f282e28617"
},
{
"text": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"attribute_def": "177b4025-f189-4514-b1f8-40b524320e8c"
},
{
"text": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"attribute_def": "8adf799e-2663-469e-8f29-84fc05a9944b"
},
{
"text": "Rechat",
"attribute_def": "a49339a0-c224-49aa-a7f2-e08817e4dea3"
},
{
"is_primary": true,
"is_partner": false,
"index": 1,
"label": "Office",
"address": {
"name": "Street",
"city": "Dallas",
"state": "Texas",
"country": "US",
"postcode": "72890",
"extra": "Office"
},
"attribute_def": "dfa8db7f-6b62-4cc5-8b1b-96b2b0d3e703"
},
{
"text": "ExplicitlyCreated",
"attribute_def": "10b9382e-cc08-4c08-b74c-bd8019a1cea0"
},
{
"text": "This is a sample note",
"attribute_def": "6d05310d-f7a8-45d8-92c5-33af32d856aa"
},
{
"text": "This is another note",
"attribute_def": "6d05310d-f7a8-45d8-92c5-33af32d856aa"
},
{
"text": "Contact Test Subject",
"attribute_def": "f43b8c78-a1e3-4719-98d7-84e23aa73cbd"
},
{
"label": "Personal",
"text": "http://www.gholi.com",
"attribute_def": "b1a4ad11-9197-46df-a6b1-060d42495822"
}
],
"user": "bbb99667-2107-4812-9520-1f5bbbcb5d91"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"display_name": "Johnny",
"partner_name": "Jane Doe",
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Johnny",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"summary": {
"id": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"is_partner": false,
"title": null,
"first_name": "John",
"middle_name": "M.",
"last_name": "Doe",
"marketing_name": null,
"nickname": "Johnny",
"email": "[email protected]",
"phone_number": "+989124834198",
"company": "Rechat",
"birthday": 950400,
"profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"job_title": "Contact Test Subject",
"source_type": "ExplicitlyCreated",
"source": null,
"tags": [
"New",
"foo",
"poo"
],
"display_name": "John Doe",
"abbreviated_display_name": "Johnny",
"type": "contact_summary"
},
"ios_address_book_id": null,
"android_address_book_id": null,
"created_at": 1791656411.19719,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "direct_request",
"updated_for": "direct_request",
"deleted_for": null,
"title": null,
"first_name": "John",
"partner_first_name": "Jane",
"middle_name": "M.",
"last_name": "Doe",
"partner_last_name": "Doe",
"marketing_name": null,
"nickname": "Johnny",
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": "[email protected]",
"phone_number": "+989124834198",
"primary_phone_number": "+989124834198",
"phone_numbers": [
"+989124834198"
],
"company": "Rechat",
"birthday": "1970-01-12T00:00:00.000Z",
"profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"job_title": "Contact Test Subject",
"source_type": "ExplicitlyCreated",
"source": null,
"website": [
"http://www.gholi.com"
],
"tags": [
"poo",
"foo",
"New"
],
"address": [
{
"city": "Dallas",
"full": "Street, Dallas Texas 72890",
"name": "Street",
"type": "stdaddr",
"extra": "Office",
"line1": "Street",
"line2": "Dallas Texas 72890",
"state": "Texas",
"country": "US",
"postcode": "72890"
}
],
"attributes": [
{
"id": "6fd1327e-01f5-430e-94e0-116e27b123fd",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "d5b21d60-d87a-4eec-ad11-7e50252f57d0",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "email",
"data_type": "text",
"label": "Email",
"section": "Contact Info",
"required": false,
"global": true,
"singular": false,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": true,
"labels": [
"Personal",
"Work",
"Other"
],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.20048,
"updated_at": 1791656411.20048,
"deleted_at": null,
"label": "Work",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "617d1c94-b175-45fa-8424-9ca1f38bf0bd",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "d5b21d60-d87a-4eec-ad11-7e50252f57d0",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "email",
"data_type": "text",
"label": "Email",
"section": "Contact Info",
"required": false,
"global": true,
"singular": false,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": true,
"labels": [
"Personal",
"Work",
"Other"
],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200546,
"updated_at": 1791656411.200546,
"deleted_at": null,
"label": "Work",
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "b266eafe-6f5c-453e-9746-4b8229633ae5",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "7c6b51bc-ee90-4f34-972f-d85f7d7c7f44",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "phone_number",
"data_type": "text",
"label": "Phone",
"section": "Contact Info",
"required": false,
"global": true,
"singular": false,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": true,
"labels": [
"Home",
"Mobile",
"Work",
"Fax",
"WhatsApp",
"Other"
],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200558,
"updated_at": 1791656411.200558,
"deleted_at": null,
"label": "Mobile",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "phone_number",
"text": "+989124834198",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "eb46aa4a-f837-43ab-ae72-73308aa2940e",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "36fd9fd2-b672-41c0-966f-2c7673421a4e",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "first_name",
"data_type": "text",
"label": "First Name",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200568,
"updated_at": 1791656411.200568,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "first_name",
"text": "John",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "51475792-db42-4ed8-bf78-b0f66de32884",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "36fd9fd2-b672-41c0-966f-2c7673421a4e",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "first_name",
"data_type": "text",
"label": "First Name",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200576,
"updated_at": 1791656411.200576,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "first_name",
"text": "Jane",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "57be47e0-eb17-4c97-8a68-fe47a6972d18",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "e49439d9-0887-4b17-b05b-22831cb34906",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "middle_name",
"data_type": "text",
"label": "Middle Name",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200584,
"updated_at": 1791656411.200584,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "middle_name",
"text": "M.",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "729a56d3-7553-40ff-a3a8-d02449961fdd",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "2df407b0-9283-4e06-84ca-1cd765903987",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "last_name",
"data_type": "text",
"label": "Last Name",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200592,
"updated_at": 1791656411.200592,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "last_name",
"text": "Doe",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "829d3189-88f0-4681-ada8-52f19060e07a",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "2df407b0-9283-4e06-84ca-1cd765903987",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "last_name",
"data_type": "text",
"label": "Last Name",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.2006,
"updated_at": 1791656411.2006,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "last_name",
"text": "Doe",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "9070d8f6-910a-4bf0-b763-ead880e3d32c",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "cd148024-757a-4b51-9925-159363a6dfe2",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "nickname",
"data_type": "text",
"label": "Nickname",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200607,
"updated_at": 1791656411.200607,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "nickname",
"text": "Johnny",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "66aa86e8-31b1-49a7-947f-638dff64addb",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "tag",
"data_type": "text",
"label": "Tag",
"section": "Tags",
"required": false,
"global": true,
"singular": false,
"show": false,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200615,
"updated_at": 1791656411.200616,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "tag",
"text": "New",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "c2797130-a0a2-4fd5-89b0-62f6c83f2c0b",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "tag",
"data_type": "text",
"label": "Tag",
"section": "Tags",
"required": false,
"global": true,
"singular": false,
"show": false,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200626,
"updated_at": 1791656411.200626,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "tag",
"text": "foo",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "51538c5e-b77b-460a-b8b1-10b4ee72f40f",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "tag",
"data_type": "text",
"label": "Tag",
"section": "Tags",
"required": false,
"global": true,
"singular": false,
"show": false,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200634,
"updated_at": 1791656411.200634,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "tag",
"text": "poo",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "b0857e4b-f21f-45e1-b644-c7fd2d97d815",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "fec55617-ade5-4a11-b416-05f282e28617",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "birthday",
"data_type": "date",
"label": "Birthday",
"section": "Dates",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200642,
"updated_at": 1791656411.200642,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "birthday",
"text": null,
"date": 950400,
"address": null,
"type": "contact_attribute"
},
{
"id": "c2fc01da-e4aa-4300-bd07-a7ec94897626",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "177b4025-f189-4514-b1f8-40b524320e8c",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "profile_image_url",
"data_type": "text",
"label": "Profile Picture URL",
"section": "Header",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200681,
"updated_at": 1791656411.200681,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "profile_image_url",
"text": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "7563c6e4-746b-473a-ae1d-ba9c613f5543",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "8adf799e-2663-469e-8f29-84fc05a9944b",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "cover_image_url",
"data_type": "text",
"label": "Cover Image URL",
"section": "Header",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.20069,
"updated_at": 1791656411.20069,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "cover_image_url",
"text": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "e9f7b84f-0b80-42d8-a7d8-8c3aeae25e1c",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "a49339a0-c224-49aa-a7f2-e08817e4dea3",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "company",
"data_type": "text",
"label": "Company",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200772,
"updated_at": 1791656411.200772,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "company",
"text": "Rechat",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "36a7352e-1d4a-4d58-ac39-4698c72da449",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "dfa8db7f-6b62-4cc5-8b1b-96b2b0d3e703",
"created_at": 1791656220.283694,
"updated_at": 1791656220.283694,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "address",
"data_type": "address",
"label": "Address",
"section": "Addresses",
"required": false,
"global": true,
"singular": false,
"show": true,
"filterable": true,
"editable": true,
"searchable": false,
"has_label": false,
"labels": [
"Home",
"Work",
"Investment Property",
"Other"
],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.20078,
"updated_at": 1791656411.20078,
"deleted_at": null,
"label": "Office",
"is_primary": true,
"is_partner": false,
"index": 1,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "address",
"text": null,
"date": null,
"address": {
"city": "Dallas",
"full": "Street, Dallas Texas 72890",
"name": "Street",
"type": "stdaddr",
"extra": "Office",
"line1": "Street",
"line2": "Dallas Texas 72890",
"state": "Texas",
"country": "US",
"postcode": "72890"
},
"type": "contact_attribute"
},
{
"id": "ca9b7899-ec32-4ce3-b761-81dbfc365740",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "10b9382e-cc08-4c08-b74c-bd8019a1cea0",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "source_type",
"data_type": "text",
"label": "Origin",
"section": "Contact Info",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": false,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200801,
"updated_at": 1791656411.200801,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "source_type",
"text": "ExplicitlyCreated",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "1284f246-7046-41d6-aad1-c13ed90f718a",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "6d05310d-f7a8-45d8-92c5-33af32d856aa",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "note",
"data_type": "text",
"label": "Note",
"section": "Notes",
"required": false,
"global": true,
"singular": false,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200809,
"updated_at": 1791656411.200809,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "note",
"text": "This is a sample note",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "e5caa145-690d-44e0-97e0-59c5bb478cec",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "6d05310d-f7a8-45d8-92c5-33af32d856aa",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "note",
"data_type": "text",
"label": "Note",
"section": "Notes",
"required": false,
"global": true,
"singular": false,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200816,
"updated_at": 1791656411.200816,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "note",
"text": "This is another note",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "56ffdeda-d7d5-40d2-a8f9-5f76c4b0cf0e",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "f43b8c78-a1e3-4719-98d7-84e23aa73cbd",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "job_title",
"data_type": "text",
"label": "Job Title",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200824,
"updated_at": 1791656411.200824,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "job_title",
"text": "Contact Test Subject",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "d977e74d-129a-43fa-90cf-df629e4fe860",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "b1a4ad11-9197-46df-a6b1-060d42495822",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "website",
"data_type": "text",
"label": "Website",
"section": "Contact Info",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200832,
"updated_at": 1791656411.200832,
"deleted_at": null,
"label": "Personal",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "website",
"text": "http://www.gholi.com",
"date": null,
"address": null,
"type": "contact_attribute"
}
],
"type": "contact"
}
],
"info": {
"count": 1,
"total": 0
}
}Update multiple contacts ¶
Update multiple contactsPATCH/contacts
Updates multiple contacts and their attributes. If attributes have id, they are updated; otherwise, they will be added as new attributes.
Example URI
PATCH /contacts
URI Parameters
- get
string(required) Example: true- associations
array(optional) Example: contact.attributes
Request
Body
{
"contacts": [
{
"id": "9af2447d-e98f-4526-89f1-bf5c56e6db0d",
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "ManyContacts"
}
]
},
{
"id": "ae2d782c-79aa-4d4f-a05d-bbbdfc59f906",
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "ManyContacts"
}
]
},
{
"id": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "ManyContacts"
}
]
},
{
"id": "ba15442d-4fb5-4e3f-9437-5b44bdd0bc09",
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "ManyContacts"
}
]
},
{
"id": "e85fa0eb-5342-4aa6-983d-464a22eab7e0",
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "ManyContacts"
}
]
},
{
"id": "3a5c5367-ea58-4b39-a40a-9c5c475cd721",
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "ManyContacts"
}
]
},
{
"id": "09d95c20-f514-4484-acf3-923d8535970b",
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "ManyContacts"
}
]
},
{
"id": "0b6a0ea4-a364-443f-a28e-5f3a3a66b0ab",
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "ManyContacts"
}
]
},
{
"id": "1c99784d-71e7-4c2c-8f6c-0f6eb0ad5bee",
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "ManyContacts"
}
]
},
{
"id": "e73d21b9-1a37-4b73-9e2b-c496d05f3ddb",
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "ManyContacts"
}
]
}
]
}Response
204Delete multiple contacts ¶
Delete multiple contactsDELETE/contacts
Example URI
DELETE /contacts
Request
Body
{
"ids": [
"1c99784d-71e7-4c2c-8f6c-0f6eb0ad5bee",
"3a5c5367-ea58-4b39-a40a-9c5c475cd721"
]
}Response
204Search in contacts by query term ¶
Search in contacts by query termPOST/contacts/filter
Example URI
POST /contacts/filter
URI Parameters
- q
string(optional) Example: [email protected]String search in title and description
- alphabet
string(optional) Example: aFilter by first letter of last name (sort_field)
- users
string(optional)Owner of the contact
- crm_task
string(optional)CrmTask association query
- ids
string(optional)List of specific contact ids to include
- excludes
string(optional)List of specific contact ids to exclude
- created_by
string(optional)Creator of the contact
- updated_by
string(optional)The last person who has updated the contact
- lists
string(optional)Belongs to list
- flows
string(optional)Enrolled in some flows
- created_gte
number(optional)Created after
- created_lte
number(optional)Created before
- updated_gte
number(optional)Last updated after
- updated_lte
number(optional)Last updated before
- last_touch_gte
number(optional)Last touch after
- last_touch_lte
number(optional)Last touch before
- next_touch_gte
number(optional)Next touch after
- next_touch_lte
number(optional)Next touch before
- start
number(optional)- limit
number(optional) Default: 10- order
string(optional) Example: sort_fieldPut a minus sign before field name for descending order
- Members:
display_namesort_fieldlast_touchnext_touchcreated_atupdated_at
- Members:
Response
200Body
{
"code": "OK",
"data": [
{
"id": "9af2447d-e98f-4526-89f1-bf5c56e6db0d",
"display_name": "Kate Bell",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Bell Kate",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": "177C371E-701D-42F8-A03B-C61CA31627F6",
"android_address_book_id": null,
"created_at": 1791656411.402803,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": "Kate",
"partner_first_name": null,
"middle_name": null,
"last_name": "Bell",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": "(415) 555-3695",
"primary_phone_number": "(415) 555-3695",
"phone_numbers": [
"(415) 555-3695",
"(555) 564-8583"
],
"company": null,
"birthday": "1978-01-13T00:00:00.000Z",
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": null,
"address": [
{
"city": "Hillsborough",
"full": "165 Davis Street, Hillsborough CA 94010",
"name": "Davis",
"type": "stdaddr",
"line1": "165 Davis Street",
"line2": "Hillsborough CA 94010",
"state": "CA",
"suftype": "Street",
"postcode": "94010",
"house_num": "165"
}
],
"type": "contact"
}
],
"info": {
"count": 1,
"total": 1
}
}Filter contacts by attributes ¶
Filter contacts by attributesPOST/contacts/filter
Example URI
POST /contacts/filter
URI Parameters
- q
string(optional) Example: Hello WorldString search in title and description
- alphabet
string(optional) Example: aFilter by first letter of last name (sort_field)
- users
string(optional)Owner of the contact
- crm_task
string(optional)CrmTask association query
- ids
string(optional)List of specific contact ids to include
- excludes
string(optional)List of specific contact ids to exclude
- created_by
string(optional)Creator of the contact
- updated_by
string(optional)The last person who has updated the contact
- lists
string(optional)Belongs to list
- flows
string(optional)Enrolled in some flows
- created_gte
number(optional)Created after
- created_lte
number(optional)Created before
- updated_gte
number(optional)Last updated after
- updated_lte
number(optional)Last updated before
- last_touch_gte
number(optional)Last touch after
- last_touch_lte
number(optional)Last touch before
- next_touch_gte
number(optional)Next touch after
- next_touch_lte
number(optional)Next touch before
- start
number(optional)- limit
number(optional) Default: 10- order
string(optional) Example: sort_fieldPut a minus sign before field name for descending order
- Members:
display_namesort_fieldlast_touchnext_touchcreated_atupdated_at
- Members:
Request
Body
{
"filter": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"value": "New"
},
{
"attribute_def": "a49339a0-c224-49aa-a7f2-e08817e4dea3",
"value": "Rechat"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"display_name": "Johnny",
"partner_name": "Jane Doe",
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Johnny",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": null,
"android_address_book_id": null,
"created_at": 1791656411.19719,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "direct_request",
"updated_for": "direct_request",
"deleted_for": null,
"title": null,
"first_name": "John",
"partner_first_name": "Jane",
"middle_name": "M.",
"last_name": "Doe",
"partner_last_name": "Doe",
"marketing_name": null,
"nickname": "Johnny",
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": "[email protected]",
"phone_number": "+989124834198",
"primary_phone_number": "+989124834198",
"phone_numbers": [
"+989124834198"
],
"company": "Rechat",
"birthday": "1970-01-12T00:00:00.000Z",
"profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"job_title": "Contact Test Subject",
"source_type": "ExplicitlyCreated",
"source": null,
"website": [
"http://www.gholi.com"
],
"tags": [
"poo",
"foo",
"New"
],
"address": [
{
"city": "Dallas",
"full": "Street, Dallas Texas 72890",
"name": "Street",
"type": "stdaddr",
"extra": "Office",
"line1": "Street",
"line2": "Dallas Texas 72890",
"state": "Texas",
"country": "US",
"postcode": "72890"
}
],
"type": "contact"
}
],
"info": {
"count": 1,
"total": 1
}
}Filter contacts not having attributes ¶
Filter contacts not having attributesPOST/contacts/filter
Example URI
POST /contacts/filter
URI Parameters
- q
string(optional) Example: Hello WorldString search in title and description
- alphabet
string(optional) Example: aFilter by first letter of last name (sort_field)
- users
string(optional)Owner of the contact
- crm_task
string(optional)CrmTask association query
- ids
string(optional)List of specific contact ids to include
- excludes
string(optional)List of specific contact ids to exclude
- created_by
string(optional)Creator of the contact
- updated_by
string(optional)The last person who has updated the contact
- lists
string(optional)Belongs to list
- flows
string(optional)Enrolled in some flows
- created_gte
number(optional)Created after
- created_lte
number(optional)Created before
- updated_gte
number(optional)Last updated after
- updated_lte
number(optional)Last updated before
- last_touch_gte
number(optional)Last touch after
- last_touch_lte
number(optional)Last touch before
- next_touch_gte
number(optional)Next touch after
- next_touch_lte
number(optional)Next touch before
- start
number(optional)- limit
number(optional) Default: 10- order
string(optional) Example: sort_fieldPut a minus sign before field name for descending order
- Members:
display_namesort_fieldlast_touchnext_touchcreated_atupdated_at
- Members:
Request
Body
{
"filter": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"value": "New",
"invert": true
},
{
"attribute_type": "tag",
"value": "foo",
"invert": true,
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "09d95c20-f514-4484-acf3-923d8535970b",
"display_name": "David",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "David",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": "E94CD15C-7964-4A9B-8AC4-10D7CFB791FD",
"android_address_book_id": null,
"created_at": 1791656411.402931,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": "David",
"partner_first_name": null,
"middle_name": null,
"last_name": null,
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": null,
"primary_email": null,
"emails": null,
"parked": false,
"partner_email": null,
"phone_number": "555-610-6679",
"primary_phone_number": "555-610-6679",
"phone_numbers": [
"555-610-6679"
],
"company": null,
"birthday": "1998-06-15T00:00:00.000Z",
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": null,
"address": null,
"type": "contact"
},
{
"id": "0b6a0ea4-a364-443f-a28e-5f3a3a66b0ab",
"display_name": "David Taylor",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Taylor David",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": "E94CD15C-7964-4A9B-8AC4-10D7CFB791FD",
"android_address_book_id": null,
"created_at": 1791656411.402943,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": "David",
"partner_first_name": null,
"middle_name": null,
"last_name": "Taylor",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": null,
"primary_email": null,
"emails": null,
"parked": false,
"partner_email": null,
"phone_number": "555-610-6679",
"primary_phone_number": "555-610-6679",
"phone_numbers": [
"555-610-6679"
],
"company": null,
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": null,
"address": [
{
"city": "Tiburon",
"full": "1747 Steuart Street, Tiburon CA 94920",
"name": "Steuart",
"type": "stdaddr",
"line1": "1747 Steuart Street",
"line2": "Tiburon CA 94920",
"state": "CA",
"suftype": "Street",
"postcode": "94920",
"house_num": "1747"
}
],
"type": "contact"
},
{
"id": "1c99784d-71e7-4c2c-8f6c-0f6eb0ad5bee",
"display_name": "Goat Boy",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Boy Goat",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": "52EAB13E-733F-4153-B019-9A83EE67171D:ABPerson",
"android_address_book_id": null,
"created_at": 1791656411.402955,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": "Goat",
"partner_first_name": null,
"middle_name": null,
"last_name": "Boy",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": null,
"primary_phone_number": null,
"phone_numbers": null,
"company": null,
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": null,
"address": [
{
"city": "Union",
"full": "50 Park, Union 33333",
"name": "50 Park",
"type": "stdaddr",
"line1": "50 Park",
"line2": "Union 33333",
"state": "33333"
}
],
"type": "contact"
},
{
"id": "3a5c5367-ea58-4b39-a40a-9c5c475cd721",
"display_name": "Hank Zakroff",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Zakroff Hank",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": "2E73EE73-C03F-4D5F-B1E8-44E85A70F170",
"android_address_book_id": null,
"created_at": 1791656411.402919,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": "Hank",
"partner_first_name": null,
"middle_name": null,
"last_name": "Zakroff",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": "(707) 555-1854",
"primary_phone_number": "(707) 555-1854",
"phone_numbers": [
"(707) 555-1854",
"(555) 766-4823"
],
"company": null,
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": null,
"address": [
{
"city": "San Rafael",
"full": "1741 Kearny Street, San Rafael CA 94901",
"name": "Kearny",
"type": "stdaddr",
"line1": "1741 Kearny Street",
"line2": "San Rafael CA 94901",
"state": "CA",
"suftype": "Street",
"postcode": "94901",
"house_num": "1741"
}
],
"type": "contact"
},
{
"id": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"display_name": "John Appleseed",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Appleseed John",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": "410FE041-5C4E-48DA-B4DE-04C15EA3DBAC",
"android_address_book_id": null,
"created_at": 1791656411.402881,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": "John",
"partner_first_name": null,
"middle_name": null,
"last_name": "Appleseed",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]",
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": "888-555-1212",
"primary_phone_number": "888-555-1212",
"phone_numbers": [
"888-555-1212",
"888-555-5512"
],
"company": null,
"birthday": "1980-06-17T00:00:00.000Z",
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": null,
"address": [
{
"city": "Atlanta",
"full": "3494 Kuhl Avenue, Atlanta GA 30303",
"name": "Kuhl",
"type": "stdaddr",
"line1": "3494 Kuhl Avenue",
"line2": "Atlanta GA 30303",
"state": "GA",
"suftype": "Avenue",
"postcode": "30303",
"house_num": "3494"
}
],
"type": "contact"
},
{
"id": "9aca45ab-843e-4ee5-983a-73b9de6c0570",
"display_name": "ACME Corporation",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "ACME Corporation",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": null,
"android_address_book_id": null,
"created_at": 1791656411.259699,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "direct_request",
"updated_for": "direct_request",
"deleted_for": null,
"title": null,
"first_name": null,
"partner_first_name": null,
"middle_name": null,
"last_name": null,
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": null,
"primary_email": null,
"emails": null,
"parked": false,
"partner_email": null,
"phone_number": null,
"primary_phone_number": null,
"phone_numbers": null,
"company": "ACME Corporation",
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": null,
"source": null,
"website": null,
"tags": null,
"address": null,
"type": "contact"
},
{
"id": "9af2447d-e98f-4526-89f1-bf5c56e6db0d",
"display_name": "Kate Bell",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Bell Kate",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": "177C371E-701D-42F8-A03B-C61CA31627F6",
"android_address_book_id": null,
"created_at": 1791656411.402803,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": "Kate",
"partner_first_name": null,
"middle_name": null,
"last_name": "Bell",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": "(415) 555-3695",
"primary_phone_number": "(415) 555-3695",
"phone_numbers": [
"(415) 555-3695",
"(555) 564-8583"
],
"company": null,
"birthday": "1978-01-13T00:00:00.000Z",
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": null,
"address": [
{
"city": "Hillsborough",
"full": "165 Davis Street, Hillsborough CA 94010",
"name": "Davis",
"type": "stdaddr",
"line1": "165 Davis Street",
"line2": "Hillsborough CA 94010",
"state": "CA",
"suftype": "Street",
"postcode": "94010",
"house_num": "165"
}
],
"type": "contact"
},
{
"id": "ae2d782c-79aa-4d4f-a05d-bbbdfc59f906",
"display_name": "Daniel Higgins",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Higgins Daniel",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": "AB211C5F-9EC9-429F-9466-B9382FF61035",
"android_address_book_id": null,
"created_at": 1791656411.402864,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": "Daniel",
"partner_first_name": null,
"middle_name": null,
"last_name": "Higgins",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": "(408) 555-3514",
"primary_phone_number": "(408) 555-3514",
"phone_numbers": [
"(408) 555-3514",
"(408) 555-5270",
"555-478-7672"
],
"company": null,
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": null,
"address": [
{
"city": "Corte Madera",
"full": "322 Laguna Street, Corte Madera CA 94925",
"name": "Laguna",
"type": "stdaddr",
"line1": "322 Laguna Street",
"line2": "Corte Madera CA 94925",
"state": "CA",
"suftype": "Street",
"postcode": "94925",
"house_num": "322"
}
],
"type": "contact"
},
{
"id": "ba15442d-4fb5-4e3f-9437-5b44bdd0bc09",
"display_name": "Anna Haro",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Haro Anna",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": "F57C8277-585D-4327-88A6-B5689FF69DFE",
"android_address_book_id": null,
"created_at": 1791656411.402895,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": "Anna",
"partner_first_name": null,
"middle_name": null,
"last_name": "Haro",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": "555-522-8243",
"primary_phone_number": "555-522-8243",
"phone_numbers": [
"555-522-8243"
],
"company": null,
"birthday": "1985-08-22T00:00:00.000Z",
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": null,
"address": [
{
"city": "Sausalito",
"full": "1001 Leavenworth Street, Sausalito CA 94965",
"name": "Leavenworth",
"type": "stdaddr",
"line1": "1001 Leavenworth Street",
"line2": "Sausalito CA 94965",
"state": "CA",
"suftype": "Street",
"postcode": "94965",
"house_num": "1001"
}
],
"type": "contact"
},
{
"id": "e73d21b9-1a37-4b73-9e2b-c496d05f3ddb",
"display_name": "Goat Boy 2",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Boy 2 Goat",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": "52EAB13E-733F-4153-B019-9A83EE67171D:ABPerson",
"android_address_book_id": null,
"created_at": 1791656411.402966,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": "Goat",
"partner_first_name": null,
"middle_name": null,
"last_name": "Boy 2",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": null,
"primary_phone_number": null,
"phone_numbers": null,
"company": null,
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": null,
"address": [
{
"city": "Union",
"full": "50 Park, Union 33333",
"name": "50 Park",
"type": "stdaddr",
"line1": "50 Park",
"line2": "Union 33333",
"state": "33333"
}
],
"type": "contact"
},
{
"id": "e85fa0eb-5342-4aa6-983d-464a22eab7e0",
"display_name": "Zakroff",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Zakroff",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": null,
"android_address_book_id": null,
"created_at": 1791656411.402907,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "import_json",
"deleted_for": null,
"title": null,
"first_name": null,
"partner_first_name": null,
"middle_name": null,
"last_name": "Zakroff",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": null,
"primary_phone_number": null,
"phone_numbers": null,
"company": null,
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": null,
"source": null,
"website": null,
"tags": null,
"address": null,
"type": "contact"
}
],
"info": {
"count": 11,
"total": 11
}
}Get a contact ¶
Get a contactGET/contacts/:id
Example URI
GET /contacts/:id
URI Parameters
- id
string(required) Example: e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f- associations
array(optional) Example: contact_attribute.attribute_def,contact.attributes,contact.summary
Response
200Body
{
"code": "OK",
"data": {
"id": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"display_name": "Johnny",
"partner_name": "Jane Doe",
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Johnny",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"summary": {
"id": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"is_partner": false,
"title": null,
"first_name": "John",
"middle_name": "M.",
"last_name": "Doe",
"marketing_name": null,
"nickname": "Johnny",
"email": "[email protected]",
"phone_number": "+989124834198",
"company": "Rechat",
"birthday": 950400,
"profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"job_title": "Contact Test Subject",
"source_type": "ExplicitlyCreated",
"source": null,
"tags": [
"New",
"foo",
"poo"
],
"display_name": "John Doe",
"abbreviated_display_name": "Johnny",
"type": "contact_summary"
},
"ios_address_book_id": null,
"android_address_book_id": null,
"created_at": 1791656411.19719,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "direct_request",
"updated_for": "direct_request",
"deleted_for": null,
"title": null,
"first_name": "John",
"partner_first_name": "Jane",
"middle_name": "M.",
"last_name": "Doe",
"partner_last_name": "Doe",
"marketing_name": null,
"nickname": "Johnny",
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": "[email protected]",
"phone_number": "+989124834198",
"primary_phone_number": "+989124834198",
"phone_numbers": [
"+989124834198"
],
"company": "Rechat",
"birthday": "1970-01-12T00:00:00.000Z",
"profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"job_title": "Contact Test Subject",
"source_type": "ExplicitlyCreated",
"source": null,
"website": [
"http://www.gholi.com"
],
"tags": [
"poo",
"foo",
"New"
],
"address": [
{
"city": "Dallas",
"full": "Street, Dallas Texas 72890",
"name": "Street",
"type": "stdaddr",
"extra": "Office",
"line1": "Street",
"line2": "Dallas Texas 72890",
"state": "Texas",
"country": "US",
"postcode": "72890"
}
],
"attributes": [
{
"id": "6fd1327e-01f5-430e-94e0-116e27b123fd",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "d5b21d60-d87a-4eec-ad11-7e50252f57d0",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "email",
"data_type": "text",
"label": "Email",
"section": "Contact Info",
"required": false,
"global": true,
"singular": false,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": true,
"labels": [
"Personal",
"Work",
"Other"
],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.20048,
"updated_at": 1791656411.20048,
"deleted_at": null,
"label": "Work",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "617d1c94-b175-45fa-8424-9ca1f38bf0bd",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "d5b21d60-d87a-4eec-ad11-7e50252f57d0",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "email",
"data_type": "text",
"label": "Email",
"section": "Contact Info",
"required": false,
"global": true,
"singular": false,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": true,
"labels": [
"Personal",
"Work",
"Other"
],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200546,
"updated_at": 1791656411.200546,
"deleted_at": null,
"label": "Work",
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "b266eafe-6f5c-453e-9746-4b8229633ae5",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "7c6b51bc-ee90-4f34-972f-d85f7d7c7f44",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "phone_number",
"data_type": "text",
"label": "Phone",
"section": "Contact Info",
"required": false,
"global": true,
"singular": false,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": true,
"labels": [
"Home",
"Mobile",
"Work",
"Fax",
"WhatsApp",
"Other"
],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200558,
"updated_at": 1791656411.200558,
"deleted_at": null,
"label": "Mobile",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "phone_number",
"text": "+989124834198",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "eb46aa4a-f837-43ab-ae72-73308aa2940e",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "36fd9fd2-b672-41c0-966f-2c7673421a4e",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "first_name",
"data_type": "text",
"label": "First Name",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200568,
"updated_at": 1791656411.200568,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "first_name",
"text": "John",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "51475792-db42-4ed8-bf78-b0f66de32884",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "36fd9fd2-b672-41c0-966f-2c7673421a4e",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "first_name",
"data_type": "text",
"label": "First Name",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200576,
"updated_at": 1791656411.200576,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "first_name",
"text": "Jane",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "57be47e0-eb17-4c97-8a68-fe47a6972d18",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "e49439d9-0887-4b17-b05b-22831cb34906",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "middle_name",
"data_type": "text",
"label": "Middle Name",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200584,
"updated_at": 1791656411.200584,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "middle_name",
"text": "M.",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "729a56d3-7553-40ff-a3a8-d02449961fdd",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "2df407b0-9283-4e06-84ca-1cd765903987",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "last_name",
"data_type": "text",
"label": "Last Name",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200592,
"updated_at": 1791656411.200592,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "last_name",
"text": "Doe",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "829d3189-88f0-4681-ada8-52f19060e07a",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "2df407b0-9283-4e06-84ca-1cd765903987",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "last_name",
"data_type": "text",
"label": "Last Name",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.2006,
"updated_at": 1791656411.2006,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "last_name",
"text": "Doe",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "9070d8f6-910a-4bf0-b763-ead880e3d32c",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "cd148024-757a-4b51-9925-159363a6dfe2",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "nickname",
"data_type": "text",
"label": "Nickname",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200607,
"updated_at": 1791656411.200607,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "nickname",
"text": "Johnny",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "66aa86e8-31b1-49a7-947f-638dff64addb",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "tag",
"data_type": "text",
"label": "Tag",
"section": "Tags",
"required": false,
"global": true,
"singular": false,
"show": false,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200615,
"updated_at": 1791656411.200616,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "tag",
"text": "New",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "c2797130-a0a2-4fd5-89b0-62f6c83f2c0b",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "tag",
"data_type": "text",
"label": "Tag",
"section": "Tags",
"required": false,
"global": true,
"singular": false,
"show": false,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200626,
"updated_at": 1791656411.200626,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "tag",
"text": "foo",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "51538c5e-b77b-460a-b8b1-10b4ee72f40f",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "tag",
"data_type": "text",
"label": "Tag",
"section": "Tags",
"required": false,
"global": true,
"singular": false,
"show": false,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200634,
"updated_at": 1791656411.200634,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "tag",
"text": "poo",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "b0857e4b-f21f-45e1-b644-c7fd2d97d815",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "fec55617-ade5-4a11-b416-05f282e28617",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "birthday",
"data_type": "date",
"label": "Birthday",
"section": "Dates",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200642,
"updated_at": 1791656411.200642,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "birthday",
"text": null,
"date": 950400,
"address": null,
"type": "contact_attribute"
},
{
"id": "c2fc01da-e4aa-4300-bd07-a7ec94897626",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "177b4025-f189-4514-b1f8-40b524320e8c",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "profile_image_url",
"data_type": "text",
"label": "Profile Picture URL",
"section": "Header",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200681,
"updated_at": 1791656411.200681,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "profile_image_url",
"text": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "7563c6e4-746b-473a-ae1d-ba9c613f5543",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "8adf799e-2663-469e-8f29-84fc05a9944b",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "cover_image_url",
"data_type": "text",
"label": "Cover Image URL",
"section": "Header",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.20069,
"updated_at": 1791656411.20069,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "cover_image_url",
"text": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "e9f7b84f-0b80-42d8-a7d8-8c3aeae25e1c",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "a49339a0-c224-49aa-a7f2-e08817e4dea3",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "company",
"data_type": "text",
"label": "Company",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200772,
"updated_at": 1791656411.200772,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "company",
"text": "Rechat",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "36a7352e-1d4a-4d58-ac39-4698c72da449",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "dfa8db7f-6b62-4cc5-8b1b-96b2b0d3e703",
"created_at": 1791656220.283694,
"updated_at": 1791656220.283694,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "address",
"data_type": "address",
"label": "Address",
"section": "Addresses",
"required": false,
"global": true,
"singular": false,
"show": true,
"filterable": true,
"editable": true,
"searchable": false,
"has_label": false,
"labels": [
"Home",
"Work",
"Investment Property",
"Other"
],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.20078,
"updated_at": 1791656411.20078,
"deleted_at": null,
"label": "Office",
"is_primary": true,
"is_partner": false,
"index": 1,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "address",
"text": null,
"date": null,
"address": {
"city": "Dallas",
"full": "Street, Dallas Texas 72890",
"name": "Street",
"type": "stdaddr",
"extra": "Office",
"line1": "Street",
"line2": "Dallas Texas 72890",
"state": "Texas",
"country": "US",
"postcode": "72890"
},
"type": "contact_attribute"
},
{
"id": "ca9b7899-ec32-4ce3-b761-81dbfc365740",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "10b9382e-cc08-4c08-b74c-bd8019a1cea0",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "source_type",
"data_type": "text",
"label": "Origin",
"section": "Contact Info",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": false,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200801,
"updated_at": 1791656411.200801,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "source_type",
"text": "ExplicitlyCreated",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "1284f246-7046-41d6-aad1-c13ed90f718a",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "6d05310d-f7a8-45d8-92c5-33af32d856aa",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "note",
"data_type": "text",
"label": "Note",
"section": "Notes",
"required": false,
"global": true,
"singular": false,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200809,
"updated_at": 1791656411.200809,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "note",
"text": "This is a sample note",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "e5caa145-690d-44e0-97e0-59c5bb478cec",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "6d05310d-f7a8-45d8-92c5-33af32d856aa",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "note",
"data_type": "text",
"label": "Note",
"section": "Notes",
"required": false,
"global": true,
"singular": false,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200816,
"updated_at": 1791656411.200816,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "note",
"text": "This is another note",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "56ffdeda-d7d5-40d2-a8f9-5f76c4b0cf0e",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "f43b8c78-a1e3-4719-98d7-84e23aa73cbd",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "job_title",
"data_type": "text",
"label": "Job Title",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200824,
"updated_at": 1791656411.200824,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "job_title",
"text": "Contact Test Subject",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "d977e74d-129a-43fa-90cf-df629e4fe860",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "b1a4ad11-9197-46df-a6b1-060d42495822",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "website",
"data_type": "text",
"label": "Website",
"section": "Contact Info",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.200832,
"updated_at": 1791656411.200832,
"deleted_at": null,
"label": "Personal",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "website",
"text": "http://www.gholi.com",
"date": null,
"address": null,
"type": "contact_attribute"
}
],
"type": "contact"
}
}Update a contact ¶
Update a contactPATCH/contacts/:id
Updates a single contact and its attributes. If attributes have id, they are updated; otherwise, they will be added as new attributes.
Example URI
PATCH /contacts/:id
URI Parameters
- id
string(required) Example: e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f- associations
array(optional) Example: contact.attributes
Request
Body
{
"attributes": [
{
"id": "1a7882c3-987a-40e3-b67d-786764bf8bba",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.701003,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "tag",
"text": "General",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "1941df90-9dbe-49a5-b373-f12352646d24",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.843807,
"deleted_at": null,
"label": "Home-Line1",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "phone_number",
"text": "+989028202679",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "b5c36a01-7b89-4dcf-9f08-faab12b7b2db",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.894499,
"deleted_at": null,
"label": "Personal",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
}
]
}Response
200Body
{
"code": "OK",
"data": {
"id": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"display_name": "Johnny",
"partner_name": "Jane Doe",
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Johnny",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": null,
"android_address_book_id": null,
"created_at": 1791656411.19719,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "direct_request",
"updated_for": "direct_request",
"deleted_for": null,
"title": null,
"first_name": "John",
"partner_first_name": "Jane",
"middle_name": "M.",
"last_name": "Doe",
"partner_last_name": "Doe",
"marketing_name": null,
"nickname": "Johnny",
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]",
"[email protected]",
"[email protected]"
],
"parked": false,
"partner_email": "[email protected]",
"phone_number": "+989028202679",
"primary_phone_number": "+989028202679",
"phone_numbers": [
"+989028202679",
"+989124834198"
],
"company": "Rechat",
"birthday": "1970-01-12T00:00:00.000Z",
"profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"job_title": "Contact Test Subject",
"source_type": "ExplicitlyCreated",
"source": null,
"website": [
"http://www.gholi.com"
],
"tags": [
"BulkTag",
"poo",
"foo",
"New",
"General"
],
"address": [
{
"city": "Dallas",
"full": "Street, Dallas Texas 72890",
"name": "Street",
"type": "stdaddr",
"extra": "Office",
"line1": "Street",
"line2": "Dallas Texas 72890",
"state": "Texas",
"country": "US",
"postcode": "72890"
}
],
"attributes": [
{
"id": "6fd1327e-01f5-430e-94e0-116e27b123fd",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.20048,
"updated_at": 1791656411.20048,
"deleted_at": null,
"label": "Work",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "617d1c94-b175-45fa-8424-9ca1f38bf0bd",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200546,
"updated_at": 1791656411.200546,
"deleted_at": null,
"label": "Work",
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "b266eafe-6f5c-453e-9746-4b8229633ae5",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200558,
"updated_at": 1791656411.200558,
"deleted_at": null,
"label": "Mobile",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "phone_number",
"text": "+989124834198",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "eb46aa4a-f837-43ab-ae72-73308aa2940e",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200568,
"updated_at": 1791656411.200568,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "first_name",
"text": "John",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "51475792-db42-4ed8-bf78-b0f66de32884",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200576,
"updated_at": 1791656411.200576,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "first_name",
"text": "Jane",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "57be47e0-eb17-4c97-8a68-fe47a6972d18",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200584,
"updated_at": 1791656411.200584,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "middle_name",
"text": "M.",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "729a56d3-7553-40ff-a3a8-d02449961fdd",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200592,
"updated_at": 1791656411.200592,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "last_name",
"text": "Doe",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "829d3189-88f0-4681-ada8-52f19060e07a",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.2006,
"updated_at": 1791656411.2006,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "last_name",
"text": "Doe",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "9070d8f6-910a-4bf0-b763-ead880e3d32c",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200607,
"updated_at": 1791656411.200607,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "nickname",
"text": "Johnny",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "66aa86e8-31b1-49a7-947f-638dff64addb",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200615,
"updated_at": 1791656411.200616,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "tag",
"text": "New",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "c2797130-a0a2-4fd5-89b0-62f6c83f2c0b",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200626,
"updated_at": 1791656411.200626,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "tag",
"text": "foo",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "51538c5e-b77b-460a-b8b1-10b4ee72f40f",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200634,
"updated_at": 1791656411.200634,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "tag",
"text": "poo",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "b0857e4b-f21f-45e1-b644-c7fd2d97d815",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200642,
"updated_at": 1791656411.200642,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "birthday",
"text": null,
"date": 950400,
"address": null,
"type": "contact_attribute"
},
{
"id": "c2fc01da-e4aa-4300-bd07-a7ec94897626",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200681,
"updated_at": 1791656411.200681,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "profile_image_url",
"text": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "7563c6e4-746b-473a-ae1d-ba9c613f5543",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.20069,
"updated_at": 1791656411.20069,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "cover_image_url",
"text": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "e9f7b84f-0b80-42d8-a7d8-8c3aeae25e1c",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200772,
"updated_at": 1791656411.200772,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "company",
"text": "Rechat",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "36a7352e-1d4a-4d58-ac39-4698c72da449",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.20078,
"updated_at": 1791656411.20078,
"deleted_at": null,
"label": "Office",
"is_primary": true,
"is_partner": false,
"index": 1,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "address",
"text": null,
"date": null,
"address": {
"city": "Dallas",
"full": "Street, Dallas Texas 72890",
"name": "Street",
"type": "stdaddr",
"extra": "Office",
"line1": "Street",
"line2": "Dallas Texas 72890",
"state": "Texas",
"country": "US",
"postcode": "72890"
},
"type": "contact_attribute"
},
{
"id": "ca9b7899-ec32-4ce3-b761-81dbfc365740",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200801,
"updated_at": 1791656411.200801,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "source_type",
"text": "ExplicitlyCreated",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "1284f246-7046-41d6-aad1-c13ed90f718a",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200809,
"updated_at": 1791656411.200809,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "note",
"text": "This is a sample note",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "e5caa145-690d-44e0-97e0-59c5bb478cec",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200816,
"updated_at": 1791656411.200816,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "note",
"text": "This is another note",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "56ffdeda-d7d5-40d2-a8f9-5f76c4b0cf0e",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200824,
"updated_at": 1791656411.200824,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "job_title",
"text": "Contact Test Subject",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "d977e74d-129a-43fa-90cf-df629e4fe860",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200832,
"updated_at": 1791656411.200832,
"deleted_at": null,
"label": "Personal",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "website",
"text": "http://www.gholi.com",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "1a7882c3-987a-40e3-b67d-786764bf8bba",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.701003,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "tag",
"text": "General",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "6afec1ff-ce60-4ed5-bbce-c78ca9affdce",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.758287,
"updated_at": 1791656411.758287,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "tag",
"text": "BulkTag",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "1941df90-9dbe-49a5-b373-f12352646d24",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.843807,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": "Home-Line1",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "phone_number",
"text": "+989028202679",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "b5c36a01-7b89-4dcf-9f08-faab12b7b2db",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.894499,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": "Personal",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "fdf4108e-1175-4653-a04b-bf8289b35e97",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.976208,
"updated_at": 1791656411.976208,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
}
],
"type": "contact"
}
}Update owner of a contact ¶
Update owner of a contactPUT/contacts/:id/owner
Example URI
PUT /contacts/:id/owner
URI Parameters
- id
string(required) Example: e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f
Request
Body
{
"user": "bbb99667-2107-4812-9520-1f5bbbcb5d91"
}Response
200Body
{
"code": "OK",
"data": {
"id": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"display_name": "Johnny",
"partner_name": "Jane Doe",
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Johnny",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"ios_address_book_id": null,
"android_address_book_id": null,
"created_at": 1791656411.19719,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "direct_request",
"updated_for": "direct_request",
"deleted_for": null,
"title": null,
"first_name": "John",
"partner_first_name": "Jane",
"middle_name": "M.",
"last_name": "Doe",
"partner_last_name": "Doe",
"marketing_name": null,
"nickname": "Johnny",
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]",
"[email protected]",
"[email protected]"
],
"parked": false,
"partner_email": "[email protected]",
"phone_number": "+989028202679",
"primary_phone_number": "+989028202679",
"phone_numbers": [
"+989028202679",
"+989124834198"
],
"company": "Rechat",
"birthday": "1970-01-12T00:00:00.000Z",
"profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"job_title": "Contact Test Subject",
"source_type": "ExplicitlyCreated",
"source": null,
"website": [
"http://www.gholi.com"
],
"tags": [
"BulkTag",
"poo",
"foo",
"New",
"General"
],
"address": [
{
"city": "Dallas",
"full": "Street, Dallas Texas 72890",
"name": "Street",
"type": "stdaddr",
"extra": "Office",
"line1": "Street",
"line2": "Dallas Texas 72890",
"state": "Texas",
"country": "US",
"postcode": "72890"
}
],
"type": "contact"
}
}Deleting a contact ¶
Deleting a contactDELETE/contacts/:id
Example URI
DELETE /contacts/:id
URI Parameters
- id
string(required) Example: e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f
Response
204Upload a file for contacts ¶
Upload a file for contactsPOST/contacts/upload
Example URI
POST /contacts/upload
Response
200Body
{
"code": "OK",
"data": {
"id": "b4303664-89b7-4a99-bc36-36a88288f2b9",
"created_at": 1791656416.56976,
"updated_at": 1791656416.56976,
"deleted_at": null,
"created_by": "3f9ef5c9-643a-48de-aa55-41996ed12d3b",
"path": "3f9ef5c9-643a-48de-aa55-41996ed12d3b-1791656416564/3e31cd60-c4d7-11f1-89da-fb554657817f.csv",
"name": "contacts.csv",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/3f9ef5c9-643a-48de-aa55-41996ed12d3b-1791656416564/3e31cd60-c4d7-11f1-89da-fb554657817f.csv?Expires=1791742816571&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=amn0FwzYrtO~rbvJUdcJ9RsCsEzbct2vtIVNP2QRi602KQ6d~mgSeYktmxKilPhu0vi-vy6F82PIuRPVN2mOn5t1kT7laTvJsydLPEYOO5sPMBF0DCTx5wpH5U3DdhQ5-2sZas3q1Dg3WikmKd54oThHo-oyAeDVs0eImJ2OuBRTkyfy8OCvejL4WddRyLtQ8YWa2CdEhuRktjbTZ6NsRZxxOn1Ar3UO~h4U3IL0o~-A9d0qqP-l9EVLajrQ-DM0NObhryU7fd7gk-C4fsYUEr64Rj8tuQRAJmdlKNf1Hh7Y3-p0B8UMJ9hKDARl-TYPatWrmpOrm4ld6dyDVXJhsQ__",
"preview_url": "http://assets.rechat.com/mimes/unknown.png",
"mime": "text/csv"
}
}Import contacts with JSON data ¶
Import contacts with JSON dataPOST/contacts/import.json
Example URI
POST /contacts/import.json
Request
Body
{
"contacts": [
{
"attributes": [
{
"text": "Kate",
"attribute_def": "36fd9fd2-b672-41c0-966f-2c7673421a4e"
},
{
"text": "Bell",
"attribute_def": "2df407b0-9283-4e06-84ca-1cd765903987"
},
{
"text": "[email protected]",
"attribute_def": "d5b21d60-d87a-4eec-ad11-7e50252f57d0"
},
{
"date": 253497600,
"attribute_def": "fec55617-ade5-4a11-b416-05f282e28617"
},
{
"text": "IOSAddressBook",
"attribute_def": "10b9382e-cc08-4c08-b74c-bd8019a1cea0"
},
{
"is_primary": true,
"is_partner": false,
"index": 0,
"address": {
"state": "CA",
"city": "Hillsborough",
"name": "Davis",
"suftype": "Street",
"house_num": "165",
"postcode": "94010"
},
"attribute_def": "dfa8db7f-6b62-4cc5-8b1b-96b2b0d3e703"
},
{
"text": "(555) 564-8583",
"attribute_def": "7c6b51bc-ee90-4f34-972f-d85f7d7c7f44"
},
{
"text": "(415) 555-3695",
"attribute_def": "7c6b51bc-ee90-4f34-972f-d85f7d7c7f44"
}
],
"ios_address_book_id": "177C371E-701D-42F8-A03B-C61CA31627F6",
"user": "bbb99667-2107-4812-9520-1f5bbbcb5d91"
},
{
"attributes": [
{
"text": "Daniel",
"attribute_def": "36fd9fd2-b672-41c0-966f-2c7673421a4e"
},
{
"text": "Higgins",
"attribute_def": "2df407b0-9283-4e06-84ca-1cd765903987"
},
{
"text": "[email protected]",
"attribute_def": "d5b21d60-d87a-4eec-ad11-7e50252f57d0"
},
{
"text": "IOSAddressBook",
"attribute_def": "10b9382e-cc08-4c08-b74c-bd8019a1cea0"
},
{
"index": 0,
"address": {
"state": "CA",
"city": "Corte Madera",
"name": "Laguna",
"suftype": "Street",
"house_num": "322",
"postcode": "94925"
},
"attribute_def": "dfa8db7f-6b62-4cc5-8b1b-96b2b0d3e703"
},
{
"text": "555-478-7672",
"attribute_def": "7c6b51bc-ee90-4f34-972f-d85f7d7c7f44"
},
{
"text": "(408) 555-5270",
"attribute_def": "7c6b51bc-ee90-4f34-972f-d85f7d7c7f44"
},
{
"text": "(408) 555-3514",
"attribute_def": "7c6b51bc-ee90-4f34-972f-d85f7d7c7f44"
}
],
"ios_address_book_id": "AB211C5F-9EC9-429F-9466-B9382FF61035",
"user": "bbb99667-2107-4812-9520-1f5bbbcb5d91"
},
{
"attributes": [
{
"text": "John",
"attribute_def": "36fd9fd2-b672-41c0-966f-2c7673421a4e"
},
{
"text": "Appleseed",
"attribute_def": "2df407b0-9283-4e06-84ca-1cd765903987"
},
{
"text": "[email protected]",
"attribute_def": "d5b21d60-d87a-4eec-ad11-7e50252f57d0"
},
{
"text": "[email protected]",
"attribute_def": "d5b21d60-d87a-4eec-ad11-7e50252f57d0"
},
{
"date": 330048000,
"attribute_def": "fec55617-ade5-4a11-b416-05f282e28617"
},
{
"text": "IOSAddressBook",
"attribute_def": "10b9382e-cc08-4c08-b74c-bd8019a1cea0"
},
{
"index": 0,
"address": {
"state": "GA",
"city": "Atlanta",
"name": "Kuhl",
"suftype": "Avenue",
"house_num": "3494",
"postcode": "30303"
},
"attribute_def": "dfa8db7f-6b62-4cc5-8b1b-96b2b0d3e703"
},
{
"text": "888-555-5512",
"attribute_def": "7c6b51bc-ee90-4f34-972f-d85f7d7c7f44"
},
{
"text": "888-555-1212",
"attribute_def": "7c6b51bc-ee90-4f34-972f-d85f7d7c7f44"
}
],
"ios_address_book_id": "410FE041-5C4E-48DA-B4DE-04C15EA3DBAC",
"user": "bbb99667-2107-4812-9520-1f5bbbcb5d91"
},
{
"attributes": [
{
"text": "Anna",
"attribute_def": "36fd9fd2-b672-41c0-966f-2c7673421a4e"
},
{
"text": "Haro",
"attribute_def": "2df407b0-9283-4e06-84ca-1cd765903987"
},
{
"text": "[email protected]",
"attribute_def": "d5b21d60-d87a-4eec-ad11-7e50252f57d0"
},
{
"date": 493516800,
"attribute_def": "fec55617-ade5-4a11-b416-05f282e28617"
},
{
"text": "IOSAddressBook",
"attribute_def": "10b9382e-cc08-4c08-b74c-bd8019a1cea0"
},
{
"index": 0,
"address": {
"state": "CA",
"city": "Sausalito",
"name": "Leavenworth",
"suftype": "Street",
"house_num": "1001",
"postcode": "94965"
},
"attribute_def": "dfa8db7f-6b62-4cc5-8b1b-96b2b0d3e703"
},
{
"text": "555-522-8243",
"attribute_def": "7c6b51bc-ee90-4f34-972f-d85f7d7c7f44"
}
],
"ios_address_book_id": "F57C8277-585D-4327-88A6-B5689FF69DFE",
"user": "bbb99667-2107-4812-9520-1f5bbbcb5d91"
},
{
"attributes": [
{
"text": "Zakroff",
"attribute_def": "2df407b0-9283-4e06-84ca-1cd765903987"
},
{
"text": "[email protected]",
"attribute_def": "d5b21d60-d87a-4eec-ad11-7e50252f57d0"
}
],
"user": "bbb99667-2107-4812-9520-1f5bbbcb5d91"
},
{
"attributes": [
{
"text": "Hank",
"attribute_def": "36fd9fd2-b672-41c0-966f-2c7673421a4e"
},
{
"text": "Zakroff",
"attribute_def": "2df407b0-9283-4e06-84ca-1cd765903987"
},
{
"text": "[email protected]",
"attribute_def": "d5b21d60-d87a-4eec-ad11-7e50252f57d0"
},
{
"text": "IOSAddressBook",
"attribute_def": "10b9382e-cc08-4c08-b74c-bd8019a1cea0"
},
{
"index": 0,
"address": {
"state": "CA",
"city": "San Rafael",
"name": "Kearny",
"suftype": "Street",
"house_num": "1741",
"postcode": "94901"
},
"attribute_def": "dfa8db7f-6b62-4cc5-8b1b-96b2b0d3e703"
},
{
"text": "(555) 766-4823",
"attribute_def": "7c6b51bc-ee90-4f34-972f-d85f7d7c7f44"
},
{
"text": "(707) 555-1854",
"attribute_def": "7c6b51bc-ee90-4f34-972f-d85f7d7c7f44"
}
],
"ios_address_book_id": "2E73EE73-C03F-4D5F-B1E8-44E85A70F170",
"user": "bbb99667-2107-4812-9520-1f5bbbcb5d91"
},
{
"attributes": [
{
"text": "555-610-6679",
"attribute_def": "7c6b51bc-ee90-4f34-972f-d85f7d7c7f44"
},
{
"date": 897868800,
"attribute_def": "fec55617-ade5-4a11-b416-05f282e28617"
},
{
"text": "IOSAddressBook",
"attribute_def": "10b9382e-cc08-4c08-b74c-bd8019a1cea0"
},
{
"text": "David",
"attribute_def": "36fd9fd2-b672-41c0-966f-2c7673421a4e"
}
],
"ios_address_book_id": "E94CD15C-7964-4A9B-8AC4-10D7CFB791FD",
"user": "bbb99667-2107-4812-9520-1f5bbbcb5d91"
},
{
"attributes": [
{
"text": "555-610-6679",
"attribute_def": "7c6b51bc-ee90-4f34-972f-d85f7d7c7f44"
},
{
"text": "IOSAddressBook",
"attribute_def": "10b9382e-cc08-4c08-b74c-bd8019a1cea0"
},
{
"index": 0,
"address": {
"state": "CA",
"city": "Tiburon",
"name": "Steuart",
"suftype": "Street",
"house_num": "1747",
"postcode": "94920"
},
"attribute_def": "dfa8db7f-6b62-4cc5-8b1b-96b2b0d3e703"
},
{
"text": "David",
"attribute_def": "36fd9fd2-b672-41c0-966f-2c7673421a4e"
},
{
"text": "Taylor",
"attribute_def": "2df407b0-9283-4e06-84ca-1cd765903987"
}
],
"ios_address_book_id": "E94CD15C-7964-4A9B-8AC4-10D7CFB791FD",
"user": "bbb99667-2107-4812-9520-1f5bbbcb5d91"
},
{
"attributes": [
{
"text": "[email protected]",
"attribute_def": "d5b21d60-d87a-4eec-ad11-7e50252f57d0"
},
{
"text": "IOSAddressBook",
"attribute_def": "10b9382e-cc08-4c08-b74c-bd8019a1cea0"
},
{
"index": 0,
"address": {
"state": "33333",
"city": "Union",
"name": "50 Park",
"postcode": ""
},
"attribute_def": "dfa8db7f-6b62-4cc5-8b1b-96b2b0d3e703"
},
{
"text": "Goat",
"attribute_def": "36fd9fd2-b672-41c0-966f-2c7673421a4e"
},
{
"text": "Boy",
"attribute_def": "2df407b0-9283-4e06-84ca-1cd765903987"
}
],
"ios_address_book_id": "52EAB13E-733F-4153-B019-9A83EE67171D:ABPerson",
"user": "bbb99667-2107-4812-9520-1f5bbbcb5d91"
},
{
"attributes": [
{
"text": "[email protected]",
"attribute_def": "d5b21d60-d87a-4eec-ad11-7e50252f57d0"
},
{
"text": "IOSAddressBook",
"attribute_def": "10b9382e-cc08-4c08-b74c-bd8019a1cea0"
},
{
"index": 0,
"address": {
"state": "33333",
"city": "Union",
"name": "50 Park",
"postcode": ""
},
"attribute_def": "dfa8db7f-6b62-4cc5-8b1b-96b2b0d3e703"
},
{
"text": "Goat",
"attribute_def": "36fd9fd2-b672-41c0-966f-2c7673421a4e"
},
{
"text": "Boy 2",
"attribute_def": "2df407b0-9283-4e06-84ca-1cd765903987"
}
],
"ios_address_book_id": "52EAB13E-733F-4153-B019-9A83EE67171D:ABPerson",
"user": "bbb99667-2107-4812-9520-1f5bbbcb5d91"
}
]
}Response
200Body
{
"code": "OK",
"data": {
"job_id": "59c7b5cd-e18f-4839-a599-5111d6856fb4"
}
}Import contacts from CSV ¶
Import contacts from CSVPOST/contacts/import.csv
Example URI
POST /contacts/import.csv
URI Parameters
- ext
string(required) Example: csv
Request
Body
{
"file_id": "b4303664-89b7-4a99-bc36-36a88288f2b9",
"owner": "3f9ef5c9-643a-48de-aa55-41996ed12d3b",
"mappings": {
"First Name": {
"attribute_type": "first_name"
},
"Middle Name": {
"attribute_type": "middle_name"
},
"Last Name": {
"attribute_type": "last_name"
},
"Title": {
"attribute_type": "title"
},
"Web Page": {
"attribute_type": "website"
},
"Birthday": {
"attribute_type": "birthday"
},
"Anniversary": {
"attribute_type": "wedding_anniversary",
"label": "Wedding Anniversary"
},
"E-mail Address": {
"attribute_type": "email",
"index": 0
},
"E-mail 2 Address": {
"attribute_type": "email",
"index": 1
},
"E-mail 3 Address": {
"attribute_type": "email",
"index": 2
},
"Primary Phone": {
"attribute_type": "phone_number",
"label": "Primary",
"index": 0
},
"Home Phone": {
"attribute_type": "phone_number",
"label": "Home",
"index": 1
},
"Home Phone 2": {
"attribute_type": "phone_number",
"label": "Home",
"index": 2
},
"Mobile Phone": {
"attribute_type": "phone_number",
"label": "Mobile",
"index": 3
},
"Pager": {
"attribute_type": "phone_number",
"label": "Pager",
"index": 4
},
"Home Fax": {
"attribute_type": "phone_number",
"label": "Home Fax",
"index": 5
},
"Street Number": {
"attribute_type": "address.house_num",
"index": 0
},
"Street Name": {
"attribute_type": "address.name",
"index": 0
},
"Home Street 3": {
"attribute_type": "address.name",
"label": "Home",
"index": 1
},
"City": {
"attribute_type": "address.city",
"index": 0
},
"State": {
"attribute_type": "address.state",
"index": 0
},
"Zip": {
"attribute_type": "address.postcode",
"index": 0
},
"Home Country": {
"attribute_type": "address.country",
"label": "Home",
"index": 1
},
"Company Main Phone": {
"attribute_type": "phone_number",
"label": "Company Main",
"index": 6
},
"Business Phone": {
"attribute_type": "phone_number",
"label": "Business",
"index": 7
},
"Business Phone 2": {
"attribute_type": "phone_number",
"label": "Business",
"index": 8
},
"Business Fax": {
"attribute_type": "phone_number",
"label": "Business Fax",
"index": 9
},
"Assistant's Phone": {
"attribute_type": "phone_number",
"label": "Assistant",
"index": 10
},
"Company": {
"attribute_type": "company"
},
"Job Title": {
"attribute_type": "job_title"
},
"Business Address": {
"attribute_type": "address.name",
"index": 2,
"label": "Business"
},
"Business City": {
"attribute_type": "address.city",
"index": 2,
"label": "Business"
},
"Business State": {
"attribute_type": "address.state",
"index": 2,
"label": "Business"
},
"Business Postal Code": {
"attribute_type": "address.postcode",
"index": 2,
"label": "Business"
},
"Business Country": {
"attribute_type": "address.country",
"index": 2,
"label": "Business"
},
"Other Phone": {
"attribute_type": "phone_number",
"label": "Other Phone",
"index": 11
},
"Other Fax": {
"attribute_type": "phone_number",
"label": "Other Fax",
"index": 12
},
"Car Phone": {
"attribute_type": "phone_number",
"label": "Car",
"index": 13
},
"Notes": {
"attribute_type": "note"
}
}
}Response
200Body
{
"code": "OK",
"data": {
"job_id": "f0640576-5ea8-47f3-9841-cf0f59f0b3a4"
}
}Import contacts from XLS ¶
Import contacts from XLSPOST/contacts/import.xls
Example URI
POST /contacts/import.xls
URI Parameters
- ext
string(required) Example: xls
Request
Body
{
"file_id": "7e07425a-47d8-4a39-a67f-8bd2fe722d38",
"owner": "3f9ef5c9-643a-48de-aa55-41996ed12d3b",
"mappings": {
"First Name": {
"attribute_type": "first_name"
},
"Middle Name": {
"attribute_type": "middle_name"
},
"Last Name": {
"attribute_type": "last_name"
},
"Title": {
"attribute_type": "title"
},
"Web Page": {
"attribute_type": "website"
},
"Birthday": {
"attribute_type": "birthday"
},
"Anniversary": {
"attribute_type": "wedding_anniversary",
"label": "Wedding Anniversary"
},
"E-mail Address": {
"attribute_type": "email",
"index": 0
},
"E-mail 2 Address": {
"attribute_type": "email",
"index": 1
},
"E-mail 3 Address": {
"attribute_type": "email",
"index": 2
},
"Primary Phone": {
"attribute_type": "phone_number",
"label": "Primary",
"index": 0
},
"Home Phone": {
"attribute_type": "phone_number",
"label": "Home",
"index": 1
},
"Home Phone 2": {
"attribute_type": "phone_number",
"label": "Home",
"index": 2
},
"Mobile Phone": {
"attribute_type": "phone_number",
"label": "Mobile",
"index": 3
},
"Pager": {
"attribute_type": "phone_number",
"label": "Pager",
"index": 4
},
"Home Fax": {
"attribute_type": "phone_number",
"label": "Home Fax",
"index": 5
},
"Street Number": {
"attribute_type": "address.house_num",
"index": 0
},
"Street Name": {
"attribute_type": "address.name",
"index": 0
},
"Home Street 3": {
"attribute_type": "address.name",
"label": "Home",
"index": 1
},
"City": {
"attribute_type": "address.city",
"index": 0
},
"State": {
"attribute_type": "address.state",
"index": 0
},
"Zip": {
"attribute_type": "address.postcode",
"index": 0
},
"Home Country": {
"attribute_type": "address.country",
"label": "Home",
"index": 1
},
"Company Main Phone": {
"attribute_type": "phone_number",
"label": "Company Main",
"index": 6
},
"Business Phone": {
"attribute_type": "phone_number",
"label": "Business",
"index": 7
},
"Business Phone 2": {
"attribute_type": "phone_number",
"label": "Business",
"index": 8
},
"Business Fax": {
"attribute_type": "phone_number",
"label": "Business Fax",
"index": 9
},
"Assistant's Phone": {
"attribute_type": "phone_number",
"label": "Assistant",
"index": 10
},
"Company": {
"attribute_type": "company"
},
"Job Title": {
"attribute_type": "job_title"
},
"Business Address": {
"attribute_type": "address.name",
"index": 2,
"label": "Business"
},
"Business City": {
"attribute_type": "address.city",
"index": 2,
"label": "Business"
},
"Business State": {
"attribute_type": "address.state",
"index": 2,
"label": "Business"
},
"Business Postal Code": {
"attribute_type": "address.postcode",
"index": 2,
"label": "Business"
},
"Business Country": {
"attribute_type": "address.country",
"index": 2,
"label": "Business"
},
"Other Phone": {
"attribute_type": "phone_number",
"label": "Other Phone",
"index": 11
},
"Other Fax": {
"attribute_type": "phone_number",
"label": "Other Fax",
"index": 12
},
"Car Phone": {
"attribute_type": "phone_number",
"label": "Car",
"index": 13
},
"Notes": {
"attribute_type": "note"
}
}
}Response
200Body
{
"code": "OK",
"data": {
"job_id": "d9a3e13e-a7a8-471f-b32c-4ea94d288b72"
}
}Import contacts from XLSX ¶
Import contacts from XLSXPOST/contacts/import.xlsx
Example URI
POST /contacts/import.xlsx
URI Parameters
- ext
string(required) Example: xlsx
Request
Body
{
"file_id": "46e1b1a5-e602-4312-8968-015e606fad4e",
"owner": "3f9ef5c9-643a-48de-aa55-41996ed12d3b",
"mappings": {
"First Name": {
"attribute_type": "first_name"
},
"Middle Name": {
"attribute_type": "middle_name"
},
"Last Name": {
"attribute_type": "last_name"
},
"Title": {
"attribute_type": "title"
},
"Web Page": {
"attribute_type": "website"
},
"Birthday": {
"attribute_type": "birthday"
},
"Anniversary": {
"attribute_type": "wedding_anniversary",
"label": "Wedding Anniversary"
},
"E-mail Address": {
"attribute_type": "email",
"index": 0
},
"E-mail 2 Address": {
"attribute_type": "email",
"index": 1
},
"E-mail 3 Address": {
"attribute_type": "email",
"index": 2
},
"Primary Phone": {
"attribute_type": "phone_number",
"label": "Primary",
"index": 0
},
"Home Phone": {
"attribute_type": "phone_number",
"label": "Home",
"index": 1
},
"Home Phone 2": {
"attribute_type": "phone_number",
"label": "Home",
"index": 2
},
"Mobile Phone": {
"attribute_type": "phone_number",
"label": "Mobile",
"index": 3
},
"Pager": {
"attribute_type": "phone_number",
"label": "Pager",
"index": 4
},
"Home Fax": {
"attribute_type": "phone_number",
"label": "Home Fax",
"index": 5
},
"Street Number": {
"attribute_type": "address.house_num",
"index": 0
},
"Street Name": {
"attribute_type": "address.name",
"index": 0
},
"Home Street 3": {
"attribute_type": "address.name",
"label": "Home",
"index": 1
},
"City": {
"attribute_type": "address.city",
"index": 0
},
"State": {
"attribute_type": "address.state",
"index": 0
},
"Zip": {
"attribute_type": "address.postcode",
"index": 0
},
"Home Country": {
"attribute_type": "address.country",
"label": "Home",
"index": 1
},
"Company Main Phone": {
"attribute_type": "phone_number",
"label": "Company Main",
"index": 6
},
"Business Phone": {
"attribute_type": "phone_number",
"label": "Business",
"index": 7
},
"Business Phone 2": {
"attribute_type": "phone_number",
"label": "Business",
"index": 8
},
"Business Fax": {
"attribute_type": "phone_number",
"label": "Business Fax",
"index": 9
},
"Assistant's Phone": {
"attribute_type": "phone_number",
"label": "Assistant",
"index": 10
},
"Company": {
"attribute_type": "company"
},
"Job Title": {
"attribute_type": "job_title"
},
"Business Address": {
"attribute_type": "address.name",
"index": 2,
"label": "Business"
},
"Business City": {
"attribute_type": "address.city",
"index": 2,
"label": "Business"
},
"Business State": {
"attribute_type": "address.state",
"index": 2,
"label": "Business"
},
"Business Postal Code": {
"attribute_type": "address.postcode",
"index": 2,
"label": "Business"
},
"Business Country": {
"attribute_type": "address.country",
"index": 2,
"label": "Business"
},
"Other Phone": {
"attribute_type": "phone_number",
"label": "Other Phone",
"index": 11
},
"Other Fax": {
"attribute_type": "phone_number",
"label": "Other Fax",
"index": 12
},
"Car Phone": {
"attribute_type": "phone_number",
"label": "Car",
"index": 13
},
"Notes": {
"attribute_type": "note"
}
}
}Response
200Body
{
"code": "OK",
"data": {
"job_id": "74c722d3-7cd3-42a6-8b66-b452af56b53c"
}
}Attributes ¶
Overview
Contact attributes are stored in an EAV format in the database, and have their own data structure and set of endpoints.
| Field | Type | Description |
|---|---|---|
| attribute_def | uuid | AttributeDef id |
| label | string | Label for attributes like email and phone number |
| is_primary | boolean | Marks an attribute as primary. Used in certain cases |
| text | string | If the attribute is string, send data here |
| index | number | An integer, used for grouping related attributes together, mainly the address components; so when a city and a street_name attribute have the same index, they belong to the same address group. This grouping is preserved when contacts are merged. |
| number | number | If the attribute is number, send data here |
| date | number | If the attribute is date, send the unix timestamp here |
| attribute_type | string | Response only for global attributes, this is the name of attribute type |
| contact | uuid | Response only Id of the attribute’s contact |
| created_by | uuid | Response only User id who created the attribute |
| created_at | number | Response only |
| updated_at | number | Response only |
| deleted_at | number | Response only |
Note: Only one instance of any attribute type can be marked as primary at any given time. When an attribute is marked as primary, all other attributes of that type are unmarked automatically.
Add attributes to a contact ¶
Add attributes to a contactPOST/contacts/:id/attributes
Example URI
POST /contacts/:id/attributes
URI Parameters
- id
string(required) Example: e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f- associations
array(optional) Example: contact_attribute.attribute_def
Request
Body
{
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "PastClient"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "1a7882c3-987a-40e3-b67d-786764bf8bba",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"attribute_def": {
"id": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "tag",
"data_type": "text",
"label": "Tag",
"section": "Tags",
"required": false,
"global": true,
"singular": false,
"show": false,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
"created_at": 1791656411.701003,
"updated_at": 1791656411.701003,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "tag",
"text": "PastClient",
"date": null,
"address": null,
"type": "contact_attribute"
}
],
"info": {
"count": 1,
"total": 0
}
}Update an attribute ¶
Update an attributePUT/contacts/:id/attributes/:attribute_id
Example URI
PUT /contacts/:id/attributes/:attribute_id
URI Parameters
- id
string(required) Example: e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f- attribute_id
string(required) Example: 1941df90-9dbe-49a5-b373-f12352646d24
Request
Body
{
"id": "1941df90-9dbe-49a5-b373-f12352646d24",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.843807,
"deleted_at": null,
"label": "Home-Line2",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "phone_number",
"text": "+989123456789",
"date": null,
"address": null,
"type": "contact_attribute"
}Response
200Body
{
"code": "OK",
"data": {
"id": "1941df90-9dbe-49a5-b373-f12352646d24",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.843807,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": "Home-Line2",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "phone_number",
"text": "+989123456789",
"date": null,
"address": null,
"type": "contact_attribute"
}
}Deleting an attribute ¶
Deleting an attributeDELETE/contacts/:id/attributes/:attribute_id
Example URI
DELETE /contacts/:id/attributes/:attribute_id
URI Parameters
- id
string(required) Example: e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f- attribute_id
string(required) Example: 1a7882c3-987a-40e3-b67d-786764bf8bba- associations
array(optional) Example: contact.attributes
Response
200Body
{
"code": "OK",
"data": {
"id": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"display_name": "Johnny",
"partner_name": "Jane Doe",
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Johnny",
"last_touch": null,
"last_touch_action": null,
"next_touch": 1792520410.722695,
"touch_freq": 10,
"ios_address_book_id": null,
"android_address_book_id": null,
"created_at": 1791656411.19719,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "direct_request",
"updated_for": "direct_request",
"deleted_for": null,
"title": null,
"first_name": "John",
"partner_first_name": "Jane",
"middle_name": "M.",
"last_name": "Doe",
"partner_last_name": "Doe",
"marketing_name": null,
"nickname": "Johnny",
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]",
"[email protected]",
"[email protected]"
],
"parked": false,
"partner_email": "[email protected]",
"phone_number": "+989028202679",
"primary_phone_number": "+989028202679",
"phone_numbers": [
"+989028202679",
"+989124834198"
],
"company": "Rechat",
"birthday": "1970-01-12T00:00:00.000Z",
"profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"job_title": "Contact Test Subject",
"source_type": "ExplicitlyCreated",
"source": null,
"website": [
"http://www.gholi.com"
],
"tags": [
"Warm",
"BulkTag",
"New"
],
"address": [
{
"city": "Dallas",
"full": "Street, Dallas Texas 72890",
"name": "Street",
"type": "stdaddr",
"extra": "Office",
"line1": "Street",
"line2": "Dallas Texas 72890",
"state": "Texas",
"country": "US",
"postcode": "72890"
}
],
"attributes": [
{
"id": "6fd1327e-01f5-430e-94e0-116e27b123fd",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.20048,
"updated_at": 1791656411.20048,
"deleted_at": null,
"label": "Work",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "617d1c94-b175-45fa-8424-9ca1f38bf0bd",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200546,
"updated_at": 1791656411.200546,
"deleted_at": null,
"label": "Work",
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "b266eafe-6f5c-453e-9746-4b8229633ae5",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200558,
"updated_at": 1791656411.200558,
"deleted_at": null,
"label": "Mobile",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "phone_number",
"text": "+989124834198",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "eb46aa4a-f837-43ab-ae72-73308aa2940e",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200568,
"updated_at": 1791656411.200568,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "first_name",
"text": "John",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "51475792-db42-4ed8-bf78-b0f66de32884",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200576,
"updated_at": 1791656411.200576,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "first_name",
"text": "Jane",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "57be47e0-eb17-4c97-8a68-fe47a6972d18",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200584,
"updated_at": 1791656411.200584,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "middle_name",
"text": "M.",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "729a56d3-7553-40ff-a3a8-d02449961fdd",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200592,
"updated_at": 1791656411.200592,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "last_name",
"text": "Doe",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "829d3189-88f0-4681-ada8-52f19060e07a",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.2006,
"updated_at": 1791656411.2006,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "last_name",
"text": "Doe",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "9070d8f6-910a-4bf0-b763-ead880e3d32c",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200607,
"updated_at": 1791656411.200607,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "nickname",
"text": "Johnny",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "66aa86e8-31b1-49a7-947f-638dff64addb",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200615,
"updated_at": 1791656411.200616,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "tag",
"text": "New",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "b0857e4b-f21f-45e1-b644-c7fd2d97d815",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200642,
"updated_at": 1791656411.200642,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "birthday",
"text": null,
"date": 950400,
"address": null,
"type": "contact_attribute"
},
{
"id": "c2fc01da-e4aa-4300-bd07-a7ec94897626",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200681,
"updated_at": 1791656411.200681,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "profile_image_url",
"text": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "7563c6e4-746b-473a-ae1d-ba9c613f5543",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.20069,
"updated_at": 1791656411.20069,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "cover_image_url",
"text": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "e9f7b84f-0b80-42d8-a7d8-8c3aeae25e1c",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200772,
"updated_at": 1791656411.200772,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "company",
"text": "Rechat",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "36a7352e-1d4a-4d58-ac39-4698c72da449",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.20078,
"updated_at": 1791656411.20078,
"deleted_at": null,
"label": "Office",
"is_primary": true,
"is_partner": false,
"index": 1,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "address",
"text": null,
"date": null,
"address": {
"city": "Dallas",
"full": "Street, Dallas Texas 72890",
"name": "Street",
"type": "stdaddr",
"extra": "Office",
"line1": "Street",
"line2": "Dallas Texas 72890",
"state": "Texas",
"country": "US",
"postcode": "72890"
},
"type": "contact_attribute"
},
{
"id": "ca9b7899-ec32-4ce3-b761-81dbfc365740",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200801,
"updated_at": 1791656411.200801,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "source_type",
"text": "ExplicitlyCreated",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "1284f246-7046-41d6-aad1-c13ed90f718a",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200809,
"updated_at": 1791656411.200809,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "note",
"text": "This is a sample note",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "e5caa145-690d-44e0-97e0-59c5bb478cec",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200816,
"updated_at": 1791656411.200816,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "note",
"text": "This is another note",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "56ffdeda-d7d5-40d2-a8f9-5f76c4b0cf0e",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200824,
"updated_at": 1791656411.200824,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "job_title",
"text": "Contact Test Subject",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "d977e74d-129a-43fa-90cf-df629e4fe860",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.200832,
"updated_at": 1791656411.200832,
"deleted_at": null,
"label": "Personal",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "website",
"text": "http://www.gholi.com",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "6afec1ff-ce60-4ed5-bbce-c78ca9affdce",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.758287,
"updated_at": 1791656411.758287,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "tag",
"text": "BulkTag",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "1941df90-9dbe-49a5-b373-f12352646d24",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.843807,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": "Home-Line1",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "phone_number",
"text": "+989028202679",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "b5c36a01-7b89-4dcf-9f08-faab12b7b2db",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.894499,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": "Personal",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "fdf4108e-1175-4653-a04b-bf8289b35e97",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656411.976208,
"updated_at": 1791656411.976208,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "5143c878-1388-451f-99a4-7a1e5e30b61d",
"contact": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"created_at": 1791656412.172112,
"updated_at": 1791656412.172112,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "tag",
"text": "Warm",
"date": null,
"address": null,
"type": "contact_attribute"
}
],
"type": "contact"
}
}Add multiple attributes ¶
Add multiple attributesPOST/contacts/attributes
Example URI
POST /contacts/attributes
URI Parameters
- get
string(required) Example: true- users
string(required) Example: bbb99667-2107-4812-9520-1f5bbbcb5d91- associations
array(optional) Example: contact.summary
Request
Body
{
"filters": [
{
"attribute_type": "tag",
"value": "PastClient",
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7"
}
],
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "BulkTag"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"display_name": "Johnny",
"partner_name": "Jane Doe",
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Johnny",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"summary": {
"id": "e14ba7b7-86be-4c6c-9dfb-bdd5b712a64f",
"is_partner": false,
"title": null,
"first_name": "John",
"middle_name": "M.",
"last_name": "Doe",
"marketing_name": null,
"nickname": "Johnny",
"email": "[email protected]",
"phone_number": "+989124834198",
"company": "Rechat",
"birthday": 950400,
"profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"job_title": "Contact Test Subject",
"source_type": "ExplicitlyCreated",
"source": null,
"tags": [
"New",
"foo",
"poo",
"PastClient",
"BulkTag"
],
"display_name": "John Doe",
"abbreviated_display_name": "Johnny",
"type": "contact_summary"
},
"ios_address_book_id": null,
"android_address_book_id": null,
"created_at": 1791656411.19719,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "direct_request",
"updated_for": "direct_request",
"deleted_for": null,
"title": null,
"first_name": "John",
"partner_first_name": "Jane",
"middle_name": "M.",
"last_name": "Doe",
"partner_last_name": "Doe",
"marketing_name": null,
"nickname": "Johnny",
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": "[email protected]",
"phone_number": "+989124834198",
"primary_phone_number": "+989124834198",
"phone_numbers": [
"+989124834198"
],
"company": "Rechat",
"birthday": "1970-01-12T00:00:00.000Z",
"profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
"job_title": "Contact Test Subject",
"source_type": "ExplicitlyCreated",
"source": null,
"website": [
"http://www.gholi.com"
],
"tags": [
"BulkTag",
"PastClient",
"poo",
"foo",
"New"
],
"address": [
{
"city": "Dallas",
"full": "Street, Dallas Texas 72890",
"name": "Street",
"type": "stdaddr",
"extra": "Office",
"line1": "Street",
"line2": "Dallas Texas 72890",
"state": "Texas",
"country": "US",
"postcode": "72890"
}
],
"type": "contact"
}
],
"info": {
"count": 1,
"total": 0
}
}Duplicates ¶
Overview
The set of APIs for merging contacts and checking for contact duplicates are described here.
Get all of the duplicate clusters ¶
Get all of the duplicate clustersGET/contacts/:id/duplicates
Example URI
GET /contacts/:id/duplicates
URI Parameters
- id
string(required) Example: 1c99784d-71e7-4c2c-8f6c-0f6eb0ad5bee
Response
200Body
{
"code": "OK",
"data": {
"id": 3,
"contacts": [
{
"id": "1c99784d-71e7-4c2c-8f6c-0f6eb0ad5bee",
"display_name": "Goat Boy",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Boy Goat",
"last_touch": 1791656410.722,
"last_touch_action": "email",
"next_touch": 1792261210.722,
"touch_freq": 7,
"ios_address_book_id": "52EAB13E-733F-4153-B019-9A83EE67171D:ABPerson",
"android_address_book_id": null,
"created_at": 1791656411.402955,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "direct_request",
"deleted_for": null,
"title": null,
"first_name": "Goat",
"partner_first_name": null,
"middle_name": null,
"last_name": "Boy",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": null,
"primary_phone_number": null,
"phone_numbers": null,
"company": null,
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": [
"ManyContacts"
],
"address": [
{
"city": "Union",
"full": "50 Park, Union 33333",
"name": "50 Park",
"type": "stdaddr",
"line1": "50 Park",
"line2": "Union 33333",
"state": "33333"
}
],
"type": "contact"
},
{
"id": "e73d21b9-1a37-4b73-9e2b-c496d05f3ddb",
"display_name": "Goat Boy 2",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Boy 2 Goat",
"last_touch": 1791656410.722,
"last_touch_action": "email",
"next_touch": 1792261210.722,
"touch_freq": 7,
"ios_address_book_id": "52EAB13E-733F-4153-B019-9A83EE67171D:ABPerson",
"android_address_book_id": null,
"created_at": 1791656411.402966,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "direct_request",
"deleted_for": null,
"title": null,
"first_name": "Goat",
"partner_first_name": null,
"middle_name": null,
"last_name": "Boy 2",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": null,
"primary_phone_number": null,
"phone_numbers": null,
"company": null,
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": [
"ManyContacts"
],
"address": [
{
"city": "Union",
"full": "50 Park, Union 33333",
"name": "50 Park",
"type": "stdaddr",
"line1": "50 Park",
"line2": "Union 33333",
"state": "33333"
}
],
"type": "contact"
}
],
"type": "contact_duplicate"
}
}Get the duplicate cluster for a contact ¶
Get the duplicate cluster for a contactGET/contacts/:id/duplicates
Example URI
GET /contacts/:id/duplicates
Response
200Body
{
"code": "OK",
"data": [
{
"id": 3,
"contacts": [
{
"id": "1c99784d-71e7-4c2c-8f6c-0f6eb0ad5bee",
"display_name": "Goat Boy",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Boy Goat",
"last_touch": 1791656410.722,
"last_touch_action": "email",
"next_touch": 1792261210.722,
"touch_freq": 7,
"ios_address_book_id": "52EAB13E-733F-4153-B019-9A83EE67171D:ABPerson",
"android_address_book_id": null,
"created_at": 1791656411.402955,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "direct_request",
"deleted_for": null,
"title": null,
"first_name": "Goat",
"partner_first_name": null,
"middle_name": null,
"last_name": "Boy",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": null,
"primary_phone_number": null,
"phone_numbers": null,
"company": null,
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": [
"ManyContacts"
],
"address": [
{
"city": "Union",
"full": "50 Park, Union 33333",
"name": "50 Park",
"type": "stdaddr",
"line1": "50 Park",
"line2": "Union 33333",
"state": "33333"
}
],
"type": "contact"
},
{
"id": "e73d21b9-1a37-4b73-9e2b-c496d05f3ddb",
"display_name": "Goat Boy 2",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Boy 2 Goat",
"last_touch": 1791656410.722,
"last_touch_action": "email",
"next_touch": 1792261210.722,
"touch_freq": 7,
"ios_address_book_id": "52EAB13E-733F-4153-B019-9A83EE67171D:ABPerson",
"android_address_book_id": null,
"created_at": 1791656411.402966,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "direct_request",
"deleted_for": null,
"title": null,
"first_name": "Goat",
"partner_first_name": null,
"middle_name": null,
"last_name": "Boy 2",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": null,
"primary_phone_number": null,
"phone_numbers": null,
"company": null,
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": [
"ManyContacts"
],
"address": [
{
"city": "Union",
"full": "50 Park, Union 33333",
"name": "50 Park",
"type": "stdaddr",
"line1": "50 Park",
"line2": "Union 33333",
"state": "33333"
}
],
"type": "contact"
}
],
"type": "contact_duplicate"
},
{
"id": 4,
"contacts": [
{
"id": "3a5c5367-ea58-4b39-a40a-9c5c475cd721",
"display_name": "Hank Zakroff",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Zakroff Hank",
"last_touch": 1791656410.722,
"last_touch_action": "email",
"next_touch": 1792261210.722,
"touch_freq": 7,
"ios_address_book_id": "2E73EE73-C03F-4D5F-B1E8-44E85A70F170",
"android_address_book_id": null,
"created_at": 1791656411.402919,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "direct_request",
"deleted_for": null,
"title": null,
"first_name": "Hank",
"partner_first_name": null,
"middle_name": null,
"last_name": "Zakroff",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": "(707) 555-1854",
"primary_phone_number": "(707) 555-1854",
"phone_numbers": [
"(707) 555-1854",
"(555) 766-4823"
],
"company": null,
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": [
"ManyContacts"
],
"address": [
{
"city": "San Rafael",
"full": "1741 Kearny Street, San Rafael CA 94901",
"name": "Kearny",
"type": "stdaddr",
"line1": "1741 Kearny Street",
"line2": "San Rafael CA 94901",
"state": "CA",
"suftype": "Street",
"postcode": "94901",
"house_num": "1741"
}
],
"type": "contact"
},
{
"id": "e85fa0eb-5342-4aa6-983d-464a22eab7e0",
"display_name": "Zakroff",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Zakroff",
"last_touch": 1791656410.722,
"last_touch_action": "email",
"next_touch": 1792261210.722,
"touch_freq": 7,
"ios_address_book_id": null,
"android_address_book_id": null,
"created_at": 1791656411.402907,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "direct_request",
"deleted_for": null,
"title": null,
"first_name": null,
"partner_first_name": null,
"middle_name": null,
"last_name": "Zakroff",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": null,
"primary_phone_number": null,
"phone_numbers": null,
"company": null,
"birthday": null,
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": null,
"source": null,
"website": null,
"tags": [
"ManyContacts"
],
"address": null,
"type": "contact"
}
],
"type": "contact_duplicate"
}
],
"info": {
"count": 2,
"total": "2"
}
}Merge contacts ¶
Merge contactsPOST/contacts/:id/merge
Example URI
POST /contacts/:id/merge
URI Parameters
- id
string(required) Example: 8e93e206-9529-4bcf-bbaf-c254b57584f8- associations
array(optional) Example: contact.attributes
Request
Body
{
"sub_contacts": [
"9af2447d-e98f-4526-89f1-bf5c56e6db0d",
"ae2d782c-79aa-4d4f-a05d-bbbdfc59f906"
]
}Response
200Body
{
"code": "OK",
"data": {
"id": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"display_name": "John Appleseed",
"partner_name": null,
"brand": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"brand_id": "4ba981db-fb4b-47de-a654-f4080c00b18a",
"user_id": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"sort_field": "Appleseed John",
"last_touch": 1791656410.722,
"last_touch_action": "email",
"next_touch": 1792261210.722,
"touch_freq": 7,
"ios_address_book_id": "410FE041-5C4E-48DA-B4DE-04C15EA3DBAC",
"android_address_book_id": null,
"created_at": 1791656411.402881,
"updated_at": 1791656410.722695,
"deleted_at": null,
"created_for": "import_json",
"updated_for": "merge",
"deleted_for": null,
"title": null,
"first_name": "John",
"partner_first_name": null,
"middle_name": null,
"last_name": "Appleseed",
"partner_last_name": null,
"marketing_name": null,
"nickname": null,
"email": "[email protected]",
"primary_email": "[email protected]",
"emails": [
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]"
],
"parked": false,
"partner_email": null,
"phone_number": "(408) 555-5270",
"primary_phone_number": "(408) 555-5270",
"phone_numbers": [
"(408) 555-5270",
"(408) 555-3514",
"888-555-1212",
"888-555-5512",
"(555) 564-8583",
"(415) 555-3695",
"555-478-7672"
],
"company": null,
"birthday": "1980-06-17T00:00:00.000Z",
"profile_image_url": null,
"cover_image_url": null,
"job_title": null,
"source_type": "IOSAddressBook",
"source": null,
"website": null,
"tags": [
"ManyContacts"
],
"address": [
{
"city": "Hillsborough",
"full": "165 Davis Street, Hillsborough CA 94010",
"name": "Davis",
"type": "stdaddr",
"line1": "165 Davis Street",
"line2": "Hillsborough CA 94010",
"state": "CA",
"suftype": "Street",
"postcode": "94010",
"house_num": "165"
},
{
"city": "Corte Madera",
"full": "322 Laguna Street, Corte Madera CA 94925",
"name": "Laguna",
"type": "stdaddr",
"line1": "322 Laguna Street",
"line2": "Corte Madera CA 94925",
"state": "CA",
"suftype": "Street",
"postcode": "94925",
"house_num": "322"
},
{
"city": "Atlanta",
"full": "3494 Kuhl Avenue, Atlanta GA 30303",
"name": "Kuhl",
"type": "stdaddr",
"line1": "3494 Kuhl Avenue",
"line2": "Atlanta GA 30303",
"state": "GA",
"suftype": "Avenue",
"postcode": "30303",
"house_num": "3494"
}
],
"attributes": [
{
"id": "23e62dd9-dcba-4a5b-9e8f-ee7b5f230c26",
"contact": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"created_at": 1791656411.408212,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "b772e22a-629c-40bb-a8bd-376413547ac5",
"contact": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"created_at": 1791656411.40827,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": "Home",
"is_primary": true,
"is_partner": false,
"index": 1,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "address",
"text": null,
"date": null,
"address": {
"city": "Hillsborough",
"full": "165 Davis Street, Hillsborough CA 94010",
"name": "Davis",
"type": "stdaddr",
"line1": "165 Davis Street",
"line2": "Hillsborough CA 94010",
"state": "CA",
"suftype": "Street",
"postcode": "94010",
"house_num": "165"
},
"type": "contact_attribute"
},
{
"id": "d7b5a2a5-fbaa-4c86-86f0-10aec001a521",
"contact": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"created_at": 1791656411.408287,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "phone_number",
"text": "(555) 564-8583",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "d0ed9add-a608-4ac3-8f57-876d9b0cb160",
"contact": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"created_at": 1791656411.408296,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "phone_number",
"text": "(415) 555-3695",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "75aedd9d-3b74-4965-aa9f-498d849eba84",
"contact": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"created_at": 1791656411.408318,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "a385ef9f-90e4-43cd-9280-93fd8da2002a",
"contact": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"created_at": 1791656411.408333,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": "Home",
"is_primary": false,
"is_partner": false,
"index": 2,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "address",
"text": null,
"date": null,
"address": {
"city": "Corte Madera",
"full": "322 Laguna Street, Corte Madera CA 94925",
"name": "Laguna",
"type": "stdaddr",
"line1": "322 Laguna Street",
"line2": "Corte Madera CA 94925",
"state": "CA",
"suftype": "Street",
"postcode": "94925",
"house_num": "322"
},
"type": "contact_attribute"
},
{
"id": "18db5656-58c1-4309-8fb7-6a87eb656884",
"contact": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"created_at": 1791656411.408341,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "phone_number",
"text": "555-478-7672",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "0105a80d-f835-4695-ae23-328a7b3a796c",
"contact": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"created_at": 1791656411.408348,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "phone_number",
"text": "(408) 555-5270",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "2dcf5bd7-a295-4bb7-a3fe-d6a16644dce9",
"contact": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"created_at": 1791656411.408355,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "phone_number",
"text": "(408) 555-3514",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "bb8aca7d-b04d-40a8-85c3-e3c3b19a7e42",
"contact": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"created_at": 1791656411.408362,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "first_name",
"text": "John",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "2159cadf-a578-4c2e-af04-6bd325d650be",
"contact": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"created_at": 1791656411.408371,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "last_name",
"text": "Appleseed",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "54733412-3167-4f2a-8b8b-132263e89402",
"contact": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"created_at": 1791656411.408378,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "30558736-25cd-47ba-81ce-2e791a4225fa",
"contact": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"created_at": 1791656411.408386,
"updated_at": 1791656411.408386,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "5c153235-9394-435f-91b0-679771f73873",
"contact": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"created_at": 1791656411.408394,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "birthday",
"text": null,
"date": 330048000,
"address": null,
"type": "contact_attribute"
},
{
"id": "171935ad-9eaa-41a0-8c5f-bdaec1217285",
"contact": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"created_at": 1791656411.408402,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "source_type",
"text": "IOSAddressBook",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "f75c6669-a2fa-4eb4-ac3a-e75f26c958c3",
"contact": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"created_at": 1791656411.408409,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": "Home",
"is_primary": false,
"is_partner": false,
"index": 0,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "address",
"text": null,
"date": null,
"address": {
"city": "Atlanta",
"full": "3494 Kuhl Avenue, Atlanta GA 30303",
"name": "Kuhl",
"type": "stdaddr",
"line1": "3494 Kuhl Avenue",
"line2": "Atlanta GA 30303",
"state": "GA",
"suftype": "Avenue",
"postcode": "30303",
"house_num": "3494"
},
"type": "contact_attribute"
},
{
"id": "c14dddcd-d03e-47ae-b5d9-c2c0915bba3e",
"contact": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"created_at": 1791656411.408416,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "phone_number",
"text": "888-555-5512",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "c393d6d3-3058-4e60-80f6-c2367e777dd3",
"contact": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"created_at": 1791656411.408424,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "phone_number",
"text": "888-555-1212",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "474c3e49-31b2-4cdd-b249-be91245a60dc",
"contact": "8e93e206-9529-4bcf-bbaf-c254b57584f8",
"created_at": 1791656412.289866,
"updated_at": 1791656410.722695,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"updated_by": "bbb99667-2107-4812-9520-1f5bbbcb5d91",
"attribute_type": "tag",
"text": "ManyContacts",
"date": null,
"address": null,
"type": "contact_attribute"
}
],
"type": "contact"
}
}Merge multiple clusters of duplicate contacts ¶
Merge multiple clusters of duplicate contactsPOST/contacts/merge
Example URI
POST /contacts/merge
Request
Body
{
"clusters": [
{
"parent": "1c99784d-71e7-4c2c-8f6c-0f6eb0ad5bee",
"sub_contacts": [
"e73d21b9-1a37-4b73-9e2b-c496d05f3ddb"
]
},
{
"parent": "3a5c5367-ea58-4b39-a40a-9c5c475cd721",
"sub_contacts": [
"e85fa0eb-5342-4aa6-983d-464a22eab7e0"
]
}
]
}Response
200Body
{
"code": "OK",
"data": {
"job_id": "b2f03da2-97c5-4a36-810a-74cde41defb9"
}
}Attribute Definitions ¶
Overview
A ContactAttributeDef is an object defining every aspect of an attribute type. There a number of system defined attribute definitions, and users can create their own user-defined attribute types. System defined definitions are marked as global. Non-global attributes are commonly referred to as Custom Attributes.
| Field | Type | Description |
|---|---|---|
| name | string | A name for the attribute def (e.g. email, phone_number, etc.) Used for global attributes. |
| data_type | string | text, date or number. |
| label | string | The form label for the attribute on clients |
| section | string | The section on which the attribute should be displayed |
| required | boolean | Whether the attribute is mandatory |
| global | boolean | Whether the attribute is a global, system-defined attribute in contrast to user-defined ones. |
| singular | boolean | Whether there can only be one instance of the attribute or multiple attributes of the same type are allowed. |
| show | boolean | Whether the clients must show the attribute or not. |
| editable | boolean | Whether the clients must allow editing the attribute or not. |
| searchable | boolean | Whether the attribute contributes to full-text index of the contact or not. Only for textual attributes |
| has_label | boolean | Whether the clients must display a label UI for the attribute or not. |
| enum_values | string[] | Whether the clients must display a dropdown for the value of attribute or not. |
| labels | string[] | Whether the clients must display a dropdown as label UI component. |
| brand | uuid | The brand that owns the user-defined attribute. |
| created_by | uuid | The original creator of the contact |
| created_at | date | |
| updated_at | date | |
| deleted_at | date |
Global Attribute types
| Name | Type | Description |
|---|---|---|
| string | Holds an email address | |
| phone_number | string | Holds a phone number |
| title | string | a.k.a prefix |
| first_name | string | |
| middle_name | string | |
| last_name | string | |
| nickname | string | |
| marketing_name | string | A name used in marketing emails and stuff. |
| birthday | date | A date for a birthday |
| child_birthday | date | |
| wedding_anniversary | date | |
| home_anniversary | date | |
| work_anniversary | date | |
| tag | string | A string describing a contact category |
| source | string | |
| profile_image_url | string | A url pointing to profile image of this contact |
| cover_image_url | string | A url pointing to cover image of this contact |
| company | string | A string indicating a company name |
| website | string | Any url related to the contact |
| string | ||
| string | ||
| string | ||
| job_title | string | Contact’s job title/position in company |
| street_prefix | string | |
| street_name | string | |
| street_suffix | string | |
| unit_number | string | |
| city | string | |
| state | string | |
| country | string | |
| postal_code | string | |
| source_type | string | Source type of this contact. Non-editable. |
| note | string | A small note for this contact |
SourceType possible values
| Values |
|---|
| BrokerageWidget |
| IOSAddressBook |
| SharesRoom |
| ExplicitlyCreated |
| External/Outlook |
| CSV |
Get all attribute definitions ¶
Get all attribute definitionsGET/contacts/attribute_defs
Example URI
GET /contacts/attribute_defs
Response
200Body
{
"code": "OK",
"data": [
{
"id": "dfa8db7f-6b62-4cc5-8b1b-96b2b0d3e703",
"created_at": 1791656220.283694,
"updated_at": 1791656220.283694,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "address",
"data_type": "address",
"label": "Address",
"section": "Addresses",
"required": false,
"global": true,
"singular": false,
"show": true,
"filterable": true,
"editable": true,
"searchable": false,
"has_label": false,
"labels": [
"Home",
"Work",
"Investment Property",
"Other"
],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "5537ef04-9788-4a33-a780-2f671d1f931b",
"created_at": 1708659908.741016,
"updated_at": 1708659908.741016,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "business_card_url",
"data_type": "text",
"label": "Business Card URL",
"section": "Header",
"required": false,
"global": true,
"singular": true,
"show": false,
"filterable": true,
"editable": true,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "9a898af9-39fd-4ab8-9a7c-3efc85fc4c73",
"created_at": 1563520683.251772,
"updated_at": 1563520683.251772,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "facebook",
"data_type": "text",
"label": "Facebook",
"section": "Contact Info",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "4a848915-9e7a-463a-a0f0-6553b528b6a1",
"created_at": 1563520683.251772,
"updated_at": 1563520683.251772,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "instagram",
"data_type": "text",
"label": "Instagram",
"section": "Contact Info",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "5d201019-b499-4b3d-9860-f5d552bf5a9e",
"created_at": 1563520683.251772,
"updated_at": 1563520683.251772,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "linkedin",
"data_type": "text",
"label": "Linkedin",
"section": "Contact Info",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "a1a9c2d5-00e2-46a5-9b3d-476dbb92f19c",
"created_at": 1549964874.761764,
"updated_at": 1549964874.761764,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "home_anniversary",
"data_type": "date",
"label": "Home Anniversary",
"section": "Dates",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "52a35ded-6507-4b9b-b8d7-dbe2d8e296cc",
"created_at": 1549964874.761764,
"updated_at": 1549964874.761764,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "work_anniversary",
"data_type": "date",
"label": "Work Anniversary",
"section": "Dates",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "5e01bb1e-e2ff-4f6d-9ede-60abeab742f3",
"created_at": 1549964874.761764,
"updated_at": 1549964874.761764,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "child_birthday",
"data_type": "date",
"label": "Child Birthday",
"section": "Dates",
"required": false,
"global": true,
"singular": false,
"show": true,
"filterable": true,
"editable": true,
"searchable": false,
"has_label": true,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "64721f27-877c-454f-8d29-2ade86c86eda",
"created_at": 1549964874.761764,
"updated_at": 1549964874.761764,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "wedding_anniversary",
"data_type": "date",
"label": "Wedding Anniversary",
"section": "Dates",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "45949194-20a4-4283-8b20-21972bf7512a",
"created_at": 1549964769.897953,
"updated_at": 1549964769.897953,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "marketing_name",
"data_type": "text",
"label": "Marketing Name",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "2df407b0-9283-4e06-84ca-1cd765903987",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "last_name",
"data_type": "text",
"label": "Last Name",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "cd148024-757a-4b51-9925-159363a6dfe2",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "nickname",
"data_type": "text",
"label": "Nickname",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "a49339a0-c224-49aa-a7f2-e08817e4dea3",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "company",
"data_type": "text",
"label": "Company",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "f43b8c78-a1e3-4719-98d7-84e23aa73cbd",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "job_title",
"data_type": "text",
"label": "Job Title",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "fec55617-ade5-4a11-b416-05f282e28617",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "birthday",
"data_type": "date",
"label": "Birthday",
"section": "Dates",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "b1a4ad11-9197-46df-a6b1-060d42495822",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "website",
"data_type": "text",
"label": "Website",
"section": "Contact Info",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "7c6b51bc-ee90-4f34-972f-d85f7d7c7f44",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "phone_number",
"data_type": "text",
"label": "Phone",
"section": "Contact Info",
"required": false,
"global": true,
"singular": false,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": true,
"labels": [
"Home",
"Mobile",
"Work",
"Fax",
"WhatsApp",
"Other"
],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "tag",
"data_type": "text",
"label": "Tag",
"section": "Tags",
"required": false,
"global": true,
"singular": false,
"show": false,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "177b4025-f189-4514-b1f8-40b524320e8c",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "profile_image_url",
"data_type": "text",
"label": "Profile Picture URL",
"section": "Header",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "381dcbc9-5692-4c03-926e-6017ba87cb58",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "title",
"data_type": "text",
"label": "Title",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": [
"Mr.",
"Mr. & Mrs.",
"Mrs.",
"Miss",
"Dr.",
"Dr. & Mrs.",
"Rev.",
"Rev. & Mrs.",
"Hon.",
"Hon. & Mrs.",
"Sir",
"Sir & Mrs.",
"Dr. & Mr.",
"Hon. & Mr.",
"Mr. & Mr.",
"Mrs. & Mrs.",
"Ms. & Ms."
],
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "8adf799e-2663-469e-8f29-84fc05a9944b",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "cover_image_url",
"data_type": "text",
"label": "Cover Image URL",
"section": "Header",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "6d05310d-f7a8-45d8-92c5-33af32d856aa",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "note",
"data_type": "text",
"label": "Note",
"section": "Notes",
"required": false,
"global": true,
"singular": false,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "10b9382e-cc08-4c08-b74c-bd8019a1cea0",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "source_type",
"data_type": "text",
"label": "Origin",
"section": "Contact Info",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": false,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "6dbfb109-c202-42d7-9ea2-e1cd6406f18a",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "source_id",
"data_type": "text",
"label": "Id on source",
"section": "Contact Info",
"required": false,
"global": true,
"singular": true,
"show": false,
"filterable": true,
"editable": false,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "123a1d79-e882-4d0d-88b2-124576bf57db",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "last_modified_on_source",
"data_type": "date",
"label": "Last modified on source",
"section": "Contact Info",
"required": false,
"global": true,
"singular": true,
"show": false,
"filterable": true,
"editable": false,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "e6c09711-d4c7-4e50-94bc-33e0ca3fed79",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "source",
"data_type": "text",
"label": "Source",
"section": "Contact Info",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "d5b21d60-d87a-4eec-ad11-7e50252f57d0",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "email",
"data_type": "text",
"label": "Email",
"section": "Contact Info",
"required": false,
"global": true,
"singular": false,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": true,
"labels": [
"Personal",
"Work",
"Other"
],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "36fd9fd2-b672-41c0-966f-2c7673421a4e",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "first_name",
"data_type": "text",
"label": "First Name",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
},
{
"id": "e49439d9-0887-4b17-b05b-22831cb34906",
"created_at": 1529043568.904529,
"updated_at": 1529043568.904529,
"deleted_at": null,
"created_by": null,
"updated_by": null,
"name": "middle_name",
"data_type": "text",
"label": "Middle Name",
"section": "Details",
"required": false,
"global": true,
"singular": true,
"show": true,
"filterable": true,
"editable": true,
"searchable": true,
"has_label": false,
"labels": [],
"enum_values": null,
"user": null,
"brand": null,
"type": "contact_attribute_def"
}
],
"info": {
"count": 29,
"total": 0
}
}Create an attribute definition ¶
Create an attribute definitionPOST/contacts/attribute_defs
Example URI
POST /contacts/attribute_defs
Request
Body
{
"name": "favorite_drinks",
"data_type": "text",
"label": "Favorite Drinks",
"section": "Detials",
"required": false,
"singular": false,
"searchable": false,
"has_label": false,
"enum_values": [
"Coffee",
"Tea",
"Iced Tea",
"Juice"
]
}Response
200Body
{
"code": "OK",
"data": {
"id": "c9bd6e6e-108e-46bc-91e5-f547848a54a9",
"created_at": 1791656413.603755,
"updated_at": 1791656413.603755,
"deleted_at": null,
"created_by": "30e296b6-39eb-4b83-b3fd-1e7fee4174bc",
"updated_by": null,
"name": "favorite_drinks",
"data_type": "text",
"label": "Favorite Drinks",
"section": "Detials",
"required": false,
"global": false,
"singular": false,
"show": true,
"filterable": true,
"editable": true,
"searchable": false,
"has_label": false,
"labels": [],
"enum_values": [
"Coffee",
"Tea",
"Iced Tea",
"Juice"
],
"user": null,
"brand": "340e0234-1922-42e0-aa80-0730f40b7f3d",
"type": "contact_attribute_def"
}
}