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": "38209551-ddf4-45c6-809d-845ec8090b0d",
"display_name": "Johnny",
"partner_name": "Jane Doe",
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544631.790681,
"updated_at": 1789544630.845693,
"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": "40490301-e113-4e67-81c9-6d797095e089",
"display_name": "ACME Corporation",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544631.955389,
"updated_at": 1789544630.845693,
"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": "26afbdc8-d450-4873-a6da-6c90b8977824",
"display_name": "Kate Bell",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.249872,
"updated_at": 1789544630.845693,
"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": "93423aa7-75d2-449d-b729-d34ba99157ee",
"display_name": "Daniel Higgins",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.249947,
"updated_at": 1789544630.845693,
"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": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"display_name": "John Appleseed",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.249974,
"updated_at": 1789544630.845693,
"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": "075cdcf3-d47f-4cd1-a32c-c3c9e18a0a28",
"display_name": "Anna Haro",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.249997,
"updated_at": 1789544630.845693,
"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": "45af00aa-09cf-49d0-a970-3ba4110659ee",
"display_name": "Zakroff",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.250019,
"updated_at": 1789544630.845693,
"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": "87a71a7b-ceba-4549-8736-a73bad7ab262",
"display_name": "Hank Zakroff",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.25004,
"updated_at": 1789544630.845693,
"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": "1f277d49-b0bd-44bc-a63b-23b856ffce3b",
"display_name": "David",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.250061,
"updated_at": 1789544630.845693,
"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": "74443daa-cb86-403a-a831-eedcc9e1e17f",
"display_name": "David Taylor",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.250081,
"updated_at": 1789544630.845693,
"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": "7040ebaf-0a26-4d5d-9b71-e89d1b9b2c72",
"display_name": "Goat Boy",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.250102,
"updated_at": 1789544630.845693,
"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": "b264cc6a-b0fb-4f08-98a8-5c4a3e71441e",
"display_name": "Goat Boy 2",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.250123,
"updated_at": 1789544630.845693,
"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": "ca3daf03-79a7-4285-b1dc-47d991f738a5"
},
{
"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": "f7c09e52-7232-44c5-8ff5-ebbed6880579"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "38209551-ddf4-45c6-809d-845ec8090b0d",
"display_name": "Johnny",
"partner_name": "Jane Doe",
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"sort_field": "Johnny",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"summary": {
"id": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.790681,
"updated_at": 1789544630.845693,
"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": "2c244b59-5621-494f-bcc3-501bacd28dcd",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803131,
"updated_at": 1789544631.803131,
"deleted_at": null,
"label": "Work",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "72fbe4ac-df52-4b31-80c9-e5ebe4e34ad0",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803275,
"updated_at": 1789544631.803275,
"deleted_at": null,
"label": "Work",
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "3e3254da-6c1a-4813-8c4d-93dbc74e1d19",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803328,
"updated_at": 1789544631.803328,
"deleted_at": null,
"label": "Mobile",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "phone_number",
"text": "+989124834198",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "a536b5c8-2065-439d-8c89-df1f57fc580d",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803379,
"updated_at": 1789544631.803379,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "first_name",
"text": "John",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "839930d5-4fa2-45cb-a5cf-275799ad1063",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803425,
"updated_at": 1789544631.803425,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "first_name",
"text": "Jane",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "e1cb6875-2c60-4eb6-aa5c-e0a6739a32bf",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.80347,
"updated_at": 1789544631.80347,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "middle_name",
"text": "M.",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "e497cf5c-599f-4233-8f96-3d04c96e93ab",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803516,
"updated_at": 1789544631.803516,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "last_name",
"text": "Doe",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "214d763d-8aee-4c9d-80f4-55d7a88332b4",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803562,
"updated_at": 1789544631.803562,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "last_name",
"text": "Doe",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "ac98a270-bd5e-440b-8fbd-87d0e4c18441",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803607,
"updated_at": 1789544631.803607,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "nickname",
"text": "Johnny",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "b9414d34-afbb-4961-9366-c6a98e2949a0",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803654,
"updated_at": 1789544631.803654,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "tag",
"text": "New",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "a30f67ed-7071-4435-a9be-e1e3b3b5963d",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803708,
"updated_at": 1789544631.803708,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "tag",
"text": "foo",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "1a1494dc-cf2f-41b5-85f9-9e6cc7060466",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.80376,
"updated_at": 1789544631.80376,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "tag",
"text": "poo",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "53de9315-2587-4371-950f-b970fdf9302e",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803815,
"updated_at": 1789544631.803815,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "birthday",
"text": null,
"date": 950400,
"address": null,
"type": "contact_attribute"
},
{
"id": "663bed61-f651-4d1d-80c3-b8cddab275aa",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803902,
"updated_at": 1789544631.803902,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": "36f04867-45ce-46cb-906d-433173353c2e",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803932,
"updated_at": 1789544631.803932,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": "e0d3825a-86b0-4a2a-8d5c-a0a84119924d",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803957,
"updated_at": 1789544631.803957,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "company",
"text": "Rechat",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "131f4ca7-dbe3-4abf-a816-35f0e31f1a9e",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"attribute_def": {
"id": "ca3daf03-79a7-4285-b1dc-47d991f738a5",
"created_at": 1789544395.822112,
"updated_at": 1789544395.822112,
"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": 1789544631.803982,
"updated_at": 1789544631.803982,
"deleted_at": null,
"label": "Office",
"is_primary": true,
"is_partner": false,
"index": 1,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": "832ce000-352f-4f87-8bc6-87a2c1c888eb",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.804081,
"updated_at": 1789544631.804081,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "source_type",
"text": "ExplicitlyCreated",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "3e6ffdf0-dc33-4e1e-b768-94713fd87da8",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.80413,
"updated_at": 1789544631.80413,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "note",
"text": "This is a sample note",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "00389a81-ad10-4e87-b018-01f553444dc2",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.80417,
"updated_at": 1789544631.80417,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "note",
"text": "This is another note",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "52c58b85-88b3-4a03-8542-16692af9f2e8",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.804229,
"updated_at": 1789544631.804229,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "job_title",
"text": "Contact Test Subject",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "61a01078-ed29-4fb4-9909-c884b078d801",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.804272,
"updated_at": 1789544631.804272,
"deleted_at": null,
"label": "Personal",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": "26afbdc8-d450-4873-a6da-6c90b8977824",
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "ManyContacts"
}
]
},
{
"id": "93423aa7-75d2-449d-b729-d34ba99157ee",
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "ManyContacts"
}
]
},
{
"id": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "ManyContacts"
}
]
},
{
"id": "075cdcf3-d47f-4cd1-a32c-c3c9e18a0a28",
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "ManyContacts"
}
]
},
{
"id": "45af00aa-09cf-49d0-a970-3ba4110659ee",
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "ManyContacts"
}
]
},
{
"id": "87a71a7b-ceba-4549-8736-a73bad7ab262",
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "ManyContacts"
}
]
},
{
"id": "1f277d49-b0bd-44bc-a63b-23b856ffce3b",
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "ManyContacts"
}
]
},
{
"id": "74443daa-cb86-403a-a831-eedcc9e1e17f",
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "ManyContacts"
}
]
},
{
"id": "7040ebaf-0a26-4d5d-9b71-e89d1b9b2c72",
"attributes": [
{
"attribute_def": "5b3c994e-7569-4df8-b8db-f37421a684f7",
"text": "ManyContacts"
}
]
},
{
"id": "b264cc6a-b0fb-4f08-98a8-5c4a3e71441e",
"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": [
"45af00aa-09cf-49d0-a970-3ba4110659ee",
"7040ebaf-0a26-4d5d-9b71-e89d1b9b2c72"
]
}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": "26afbdc8-d450-4873-a6da-6c90b8977824",
"display_name": "Kate Bell",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.249872,
"updated_at": 1789544630.845693,
"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": "38209551-ddf4-45c6-809d-845ec8090b0d",
"display_name": "Johnny",
"partner_name": "Jane Doe",
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544631.790681,
"updated_at": 1789544630.845693,
"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": "075cdcf3-d47f-4cd1-a32c-c3c9e18a0a28",
"display_name": "Anna Haro",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.249997,
"updated_at": 1789544630.845693,
"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": "1f277d49-b0bd-44bc-a63b-23b856ffce3b",
"display_name": "David",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.250061,
"updated_at": 1789544630.845693,
"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": "26afbdc8-d450-4873-a6da-6c90b8977824",
"display_name": "Kate Bell",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.249872,
"updated_at": 1789544630.845693,
"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": "40490301-e113-4e67-81c9-6d797095e089",
"display_name": "ACME Corporation",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544631.955389,
"updated_at": 1789544630.845693,
"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": "45af00aa-09cf-49d0-a970-3ba4110659ee",
"display_name": "Zakroff",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.250019,
"updated_at": 1789544630.845693,
"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": "7040ebaf-0a26-4d5d-9b71-e89d1b9b2c72",
"display_name": "Goat Boy",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.250102,
"updated_at": 1789544630.845693,
"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": "74443daa-cb86-403a-a831-eedcc9e1e17f",
"display_name": "David Taylor",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.250081,
"updated_at": 1789544630.845693,
"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": "87a71a7b-ceba-4549-8736-a73bad7ab262",
"display_name": "Hank Zakroff",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.25004,
"updated_at": 1789544630.845693,
"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": "93423aa7-75d2-449d-b729-d34ba99157ee",
"display_name": "Daniel Higgins",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.249947,
"updated_at": 1789544630.845693,
"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": "b264cc6a-b0fb-4f08-98a8-5c4a3e71441e",
"display_name": "Goat Boy 2",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.250123,
"updated_at": 1789544630.845693,
"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": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"display_name": "John Appleseed",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544632.249974,
"updated_at": 1789544630.845693,
"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"
}
],
"info": {
"count": 11,
"total": 11
}
}Get a contact ¶
Get a contactGET/contacts/:id
Example URI
GET /contacts/:id
URI Parameters
- id
string(required) Example: 38209551-ddf4-45c6-809d-845ec8090b0d- associations
array(optional) Example: contact_attribute.attribute_def,contact.attributes,contact.summary
Response
200Body
{
"code": "OK",
"data": {
"id": "38209551-ddf4-45c6-809d-845ec8090b0d",
"display_name": "Johnny",
"partner_name": "Jane Doe",
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"sort_field": "Johnny",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"summary": {
"id": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.790681,
"updated_at": 1789544630.845693,
"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": "2c244b59-5621-494f-bcc3-501bacd28dcd",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803131,
"updated_at": 1789544631.803131,
"deleted_at": null,
"label": "Work",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "72fbe4ac-df52-4b31-80c9-e5ebe4e34ad0",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803275,
"updated_at": 1789544631.803275,
"deleted_at": null,
"label": "Work",
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "3e3254da-6c1a-4813-8c4d-93dbc74e1d19",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803328,
"updated_at": 1789544631.803328,
"deleted_at": null,
"label": "Mobile",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "phone_number",
"text": "+989124834198",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "a536b5c8-2065-439d-8c89-df1f57fc580d",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803379,
"updated_at": 1789544631.803379,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "first_name",
"text": "John",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "839930d5-4fa2-45cb-a5cf-275799ad1063",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803425,
"updated_at": 1789544631.803425,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "first_name",
"text": "Jane",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "e1cb6875-2c60-4eb6-aa5c-e0a6739a32bf",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.80347,
"updated_at": 1789544631.80347,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "middle_name",
"text": "M.",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "e497cf5c-599f-4233-8f96-3d04c96e93ab",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803516,
"updated_at": 1789544631.803516,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "last_name",
"text": "Doe",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "214d763d-8aee-4c9d-80f4-55d7a88332b4",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803562,
"updated_at": 1789544631.803562,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "last_name",
"text": "Doe",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "ac98a270-bd5e-440b-8fbd-87d0e4c18441",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803607,
"updated_at": 1789544631.803607,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "nickname",
"text": "Johnny",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "b9414d34-afbb-4961-9366-c6a98e2949a0",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803654,
"updated_at": 1789544631.803654,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "tag",
"text": "New",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "a30f67ed-7071-4435-a9be-e1e3b3b5963d",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803708,
"updated_at": 1789544631.803708,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "tag",
"text": "foo",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "1a1494dc-cf2f-41b5-85f9-9e6cc7060466",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.80376,
"updated_at": 1789544631.80376,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "tag",
"text": "poo",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "53de9315-2587-4371-950f-b970fdf9302e",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803815,
"updated_at": 1789544631.803815,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "birthday",
"text": null,
"date": 950400,
"address": null,
"type": "contact_attribute"
},
{
"id": "663bed61-f651-4d1d-80c3-b8cddab275aa",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803902,
"updated_at": 1789544631.803902,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": "36f04867-45ce-46cb-906d-433173353c2e",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803932,
"updated_at": 1789544631.803932,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": "e0d3825a-86b0-4a2a-8d5c-a0a84119924d",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.803957,
"updated_at": 1789544631.803957,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "company",
"text": "Rechat",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "131f4ca7-dbe3-4abf-a816-35f0e31f1a9e",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"attribute_def": {
"id": "ca3daf03-79a7-4285-b1dc-47d991f738a5",
"created_at": 1789544395.822112,
"updated_at": 1789544395.822112,
"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": 1789544631.803982,
"updated_at": 1789544631.803982,
"deleted_at": null,
"label": "Office",
"is_primary": true,
"is_partner": false,
"index": 1,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": "832ce000-352f-4f87-8bc6-87a2c1c888eb",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.804081,
"updated_at": 1789544631.804081,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "source_type",
"text": "ExplicitlyCreated",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "3e6ffdf0-dc33-4e1e-b768-94713fd87da8",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.80413,
"updated_at": 1789544631.80413,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "note",
"text": "This is a sample note",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "00389a81-ad10-4e87-b018-01f553444dc2",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.80417,
"updated_at": 1789544631.80417,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "note",
"text": "This is another note",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "52c58b85-88b3-4a03-8542-16692af9f2e8",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.804229,
"updated_at": 1789544631.804229,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "job_title",
"text": "Contact Test Subject",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "61a01078-ed29-4fb4-9909-c884b078d801",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.804272,
"updated_at": 1789544631.804272,
"deleted_at": null,
"label": "Personal",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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: 38209551-ddf4-45c6-809d-845ec8090b0d- associations
array(optional) Example: contact.attributes
Request
Body
{
"attributes": [
{
"id": "833f73ea-9fa5-488f-8e8e-9932910652f6",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544632.773734,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "tag",
"text": "General",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "a85eaed0-5db6-44bf-a512-2566f4842dea",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544633.035363,
"deleted_at": null,
"label": "Home-Line1",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "phone_number",
"text": "+989028202679",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "0bb0b627-774d-4a7c-afcc-72c11ffa701f",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544633.138046,
"deleted_at": null,
"label": "Personal",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
}
]
}Response
200Body
{
"code": "OK",
"data": {
"id": "38209551-ddf4-45c6-809d-845ec8090b0d",
"display_name": "Johnny",
"partner_name": "Jane Doe",
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544631.790681,
"updated_at": 1789544630.845693,
"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": "2c244b59-5621-494f-bcc3-501bacd28dcd",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803131,
"updated_at": 1789544631.803131,
"deleted_at": null,
"label": "Work",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "72fbe4ac-df52-4b31-80c9-e5ebe4e34ad0",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803275,
"updated_at": 1789544631.803275,
"deleted_at": null,
"label": "Work",
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "3e3254da-6c1a-4813-8c4d-93dbc74e1d19",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803328,
"updated_at": 1789544631.803328,
"deleted_at": null,
"label": "Mobile",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "phone_number",
"text": "+989124834198",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "a536b5c8-2065-439d-8c89-df1f57fc580d",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803379,
"updated_at": 1789544631.803379,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "first_name",
"text": "John",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "839930d5-4fa2-45cb-a5cf-275799ad1063",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803425,
"updated_at": 1789544631.803425,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "first_name",
"text": "Jane",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "e1cb6875-2c60-4eb6-aa5c-e0a6739a32bf",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.80347,
"updated_at": 1789544631.80347,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "middle_name",
"text": "M.",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "e497cf5c-599f-4233-8f96-3d04c96e93ab",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803516,
"updated_at": 1789544631.803516,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "last_name",
"text": "Doe",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "214d763d-8aee-4c9d-80f4-55d7a88332b4",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803562,
"updated_at": 1789544631.803562,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "last_name",
"text": "Doe",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "ac98a270-bd5e-440b-8fbd-87d0e4c18441",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803607,
"updated_at": 1789544631.803607,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "nickname",
"text": "Johnny",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "b9414d34-afbb-4961-9366-c6a98e2949a0",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803654,
"updated_at": 1789544631.803654,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "tag",
"text": "New",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "a30f67ed-7071-4435-a9be-e1e3b3b5963d",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803708,
"updated_at": 1789544631.803708,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "tag",
"text": "foo",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "1a1494dc-cf2f-41b5-85f9-9e6cc7060466",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.80376,
"updated_at": 1789544631.80376,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "tag",
"text": "poo",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "53de9315-2587-4371-950f-b970fdf9302e",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803815,
"updated_at": 1789544631.803815,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "birthday",
"text": null,
"date": 950400,
"address": null,
"type": "contact_attribute"
},
{
"id": "663bed61-f651-4d1d-80c3-b8cddab275aa",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803902,
"updated_at": 1789544631.803902,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": "36f04867-45ce-46cb-906d-433173353c2e",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803932,
"updated_at": 1789544631.803932,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": "e0d3825a-86b0-4a2a-8d5c-a0a84119924d",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803957,
"updated_at": 1789544631.803957,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "company",
"text": "Rechat",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "131f4ca7-dbe3-4abf-a816-35f0e31f1a9e",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803982,
"updated_at": 1789544631.803982,
"deleted_at": null,
"label": "Office",
"is_primary": true,
"is_partner": false,
"index": 1,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": "832ce000-352f-4f87-8bc6-87a2c1c888eb",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.804081,
"updated_at": 1789544631.804081,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "source_type",
"text": "ExplicitlyCreated",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "3e6ffdf0-dc33-4e1e-b768-94713fd87da8",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.80413,
"updated_at": 1789544631.80413,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "note",
"text": "This is a sample note",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "00389a81-ad10-4e87-b018-01f553444dc2",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.80417,
"updated_at": 1789544631.80417,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "note",
"text": "This is another note",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "52c58b85-88b3-4a03-8542-16692af9f2e8",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.804229,
"updated_at": 1789544631.804229,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "job_title",
"text": "Contact Test Subject",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "61a01078-ed29-4fb4-9909-c884b078d801",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.804272,
"updated_at": 1789544631.804272,
"deleted_at": null,
"label": "Personal",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "website",
"text": "http://www.gholi.com",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "833f73ea-9fa5-488f-8e8e-9932910652f6",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544632.773734,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "tag",
"text": "General",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "ac928c4d-947e-424a-906e-6d18ec837968",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544632.875135,
"updated_at": 1789544632.875135,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "tag",
"text": "BulkTag",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "a85eaed0-5db6-44bf-a512-2566f4842dea",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544633.035363,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": "Home-Line1",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "phone_number",
"text": "+989028202679",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "0bb0b627-774d-4a7c-afcc-72c11ffa701f",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544633.138046,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": "Personal",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "ffc157ec-033e-4663-ad9a-af3eca26a855",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544633.313559,
"updated_at": 1789544633.313559,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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: 38209551-ddf4-45c6-809d-845ec8090b0d
Request
Body
{
"user": "f7c09e52-7232-44c5-8ff5-ebbed6880579"
}Response
200Body
{
"code": "OK",
"data": {
"id": "38209551-ddf4-45c6-809d-845ec8090b0d",
"display_name": "Johnny",
"partner_name": "Jane Doe",
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": 1789544631.790681,
"updated_at": 1789544630.845693,
"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: 38209551-ddf4-45c6-809d-845ec8090b0d
Response
204Upload a file for contacts ¶
Upload a file for contactsPOST/contacts/upload
Example URI
POST /contacts/upload
Response
200Body
{
"code": "OK",
"data": {
"id": "185f204e-5235-4332-8b79-4fea36124988",
"created_at": 1789544640.81133,
"updated_at": 1789544640.81133,
"deleted_at": null,
"created_by": "e59ff1ad-47be-4d5e-9f50-2f47866662cf",
"path": "e59ff1ad-47be-4d5e-9f50-2f47866662cf-1789544640801/61c0a730-b1a2-11f1-b334-690685c8c27d.csv",
"name": "contacts.csv",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/e59ff1ad-47be-4d5e-9f50-2f47866662cf-1789544640801/61c0a730-b1a2-11f1-b334-690685c8c27d.csv?Expires=1789631040822&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=MoN-HM2apb8R7xmmbSj4QbUxBiAXl7Qa7MxncNPwgw3RR7ZtYAi-A9NYUnOteXLD9YyFzT1Hq6y6r4yz4twfU~Waj19H~69N-CwYWQAf-Nh~3saJ2lgxXpYuvbI2faVCvlloB3-sb85pbQ0nN7BoSdeRIevd7PsYG6FWKDEHC51zkG8InP2M0T-cDSgoHQUFrQPatYe6oanYopqDpF3IbHL1F2jlurzrJqySrQPXk4b1W-9b9C-FGeGt7ayKOviegy5dGROvQQ1vnG9DaSbC8nSMBq9JMBvAzwrX3xylwlBK2Ky5dowvZJgU5E87QFI9NeCT78tFTU~EtfrGIoT7qg__",
"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": "ca3daf03-79a7-4285-b1dc-47d991f738a5"
},
{
"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": "f7c09e52-7232-44c5-8ff5-ebbed6880579"
},
{
"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": "ca3daf03-79a7-4285-b1dc-47d991f738a5"
},
{
"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": "f7c09e52-7232-44c5-8ff5-ebbed6880579"
},
{
"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": "ca3daf03-79a7-4285-b1dc-47d991f738a5"
},
{
"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": "f7c09e52-7232-44c5-8ff5-ebbed6880579"
},
{
"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": "ca3daf03-79a7-4285-b1dc-47d991f738a5"
},
{
"text": "555-522-8243",
"attribute_def": "7c6b51bc-ee90-4f34-972f-d85f7d7c7f44"
}
],
"ios_address_book_id": "F57C8277-585D-4327-88A6-B5689FF69DFE",
"user": "f7c09e52-7232-44c5-8ff5-ebbed6880579"
},
{
"attributes": [
{
"text": "Zakroff",
"attribute_def": "2df407b0-9283-4e06-84ca-1cd765903987"
},
{
"text": "[email protected]",
"attribute_def": "d5b21d60-d87a-4eec-ad11-7e50252f57d0"
}
],
"user": "f7c09e52-7232-44c5-8ff5-ebbed6880579"
},
{
"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": "ca3daf03-79a7-4285-b1dc-47d991f738a5"
},
{
"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": "f7c09e52-7232-44c5-8ff5-ebbed6880579"
},
{
"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": "f7c09e52-7232-44c5-8ff5-ebbed6880579"
},
{
"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": "ca3daf03-79a7-4285-b1dc-47d991f738a5"
},
{
"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": "f7c09e52-7232-44c5-8ff5-ebbed6880579"
},
{
"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": "ca3daf03-79a7-4285-b1dc-47d991f738a5"
},
{
"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": "f7c09e52-7232-44c5-8ff5-ebbed6880579"
},
{
"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": "ca3daf03-79a7-4285-b1dc-47d991f738a5"
},
{
"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": "f7c09e52-7232-44c5-8ff5-ebbed6880579"
}
]
}Response
200Body
{
"code": "OK",
"data": {
"job_id": "190bbdef-86a7-4db9-8f15-f0518df69817"
}
}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": "185f204e-5235-4332-8b79-4fea36124988",
"owner": "e59ff1ad-47be-4d5e-9f50-2f47866662cf",
"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": "755482c9-9c3d-47cd-96ae-1f821a69c600"
}
}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": "4266a779-7236-43c2-b2ff-0558e96bee08",
"owner": "e59ff1ad-47be-4d5e-9f50-2f47866662cf",
"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": "1bcdeb07-7179-44b3-ad04-d73993b212e3"
}
}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": "19d831bd-a19a-40d8-a012-a2d7a7c17daf",
"owner": "e59ff1ad-47be-4d5e-9f50-2f47866662cf",
"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": "33445783-d587-4ccc-9c16-ef9b1bebf673"
}
}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: 38209551-ddf4-45c6-809d-845ec8090b0d- 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": "833f73ea-9fa5-488f-8e8e-9932910652f6",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544632.773734,
"updated_at": 1789544632.773734,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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: 38209551-ddf4-45c6-809d-845ec8090b0d- attribute_id
string(required) Example: a85eaed0-5db6-44bf-a512-2566f4842dea
Request
Body
{
"id": "a85eaed0-5db6-44bf-a512-2566f4842dea",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544633.035363,
"deleted_at": null,
"label": "Home-Line2",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "phone_number",
"text": "+989123456789",
"date": null,
"address": null,
"type": "contact_attribute"
}Response
200Body
{
"code": "OK",
"data": {
"id": "a85eaed0-5db6-44bf-a512-2566f4842dea",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544633.035363,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": "Home-Line2",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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: 38209551-ddf4-45c6-809d-845ec8090b0d- attribute_id
string(required) Example: 833f73ea-9fa5-488f-8e8e-9932910652f6- associations
array(optional) Example: contact.attributes
Response
200Body
{
"code": "OK",
"data": {
"id": "38209551-ddf4-45c6-809d-845ec8090b0d",
"display_name": "Johnny",
"partner_name": "Jane Doe",
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"sort_field": "Johnny",
"last_touch": null,
"last_touch_action": null,
"next_touch": 1790408630.845693,
"touch_freq": 10,
"ios_address_book_id": null,
"android_address_book_id": null,
"created_at": 1789544631.790681,
"updated_at": 1789544630.845693,
"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": "2c244b59-5621-494f-bcc3-501bacd28dcd",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803131,
"updated_at": 1789544631.803131,
"deleted_at": null,
"label": "Work",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "72fbe4ac-df52-4b31-80c9-e5ebe4e34ad0",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803275,
"updated_at": 1789544631.803275,
"deleted_at": null,
"label": "Work",
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "3e3254da-6c1a-4813-8c4d-93dbc74e1d19",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803328,
"updated_at": 1789544631.803328,
"deleted_at": null,
"label": "Mobile",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "phone_number",
"text": "+989124834198",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "a536b5c8-2065-439d-8c89-df1f57fc580d",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803379,
"updated_at": 1789544631.803379,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "first_name",
"text": "John",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "839930d5-4fa2-45cb-a5cf-275799ad1063",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803425,
"updated_at": 1789544631.803425,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "first_name",
"text": "Jane",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "e1cb6875-2c60-4eb6-aa5c-e0a6739a32bf",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.80347,
"updated_at": 1789544631.80347,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "middle_name",
"text": "M.",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "e497cf5c-599f-4233-8f96-3d04c96e93ab",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803516,
"updated_at": 1789544631.803516,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "last_name",
"text": "Doe",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "214d763d-8aee-4c9d-80f4-55d7a88332b4",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803562,
"updated_at": 1789544631.803562,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": true,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "last_name",
"text": "Doe",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "ac98a270-bd5e-440b-8fbd-87d0e4c18441",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803607,
"updated_at": 1789544631.803607,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "nickname",
"text": "Johnny",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "b9414d34-afbb-4961-9366-c6a98e2949a0",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803654,
"updated_at": 1789544631.803654,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "tag",
"text": "New",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "53de9315-2587-4371-950f-b970fdf9302e",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803815,
"updated_at": 1789544631.803815,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "birthday",
"text": null,
"date": 950400,
"address": null,
"type": "contact_attribute"
},
{
"id": "663bed61-f651-4d1d-80c3-b8cddab275aa",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803902,
"updated_at": 1789544631.803902,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": "36f04867-45ce-46cb-906d-433173353c2e",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803932,
"updated_at": 1789544631.803932,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": "e0d3825a-86b0-4a2a-8d5c-a0a84119924d",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803957,
"updated_at": 1789544631.803957,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "company",
"text": "Rechat",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "131f4ca7-dbe3-4abf-a816-35f0e31f1a9e",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.803982,
"updated_at": 1789544631.803982,
"deleted_at": null,
"label": "Office",
"is_primary": true,
"is_partner": false,
"index": 1,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": "832ce000-352f-4f87-8bc6-87a2c1c888eb",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.804081,
"updated_at": 1789544631.804081,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "source_type",
"text": "ExplicitlyCreated",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "3e6ffdf0-dc33-4e1e-b768-94713fd87da8",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.80413,
"updated_at": 1789544631.80413,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "note",
"text": "This is a sample note",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "00389a81-ad10-4e87-b018-01f553444dc2",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.80417,
"updated_at": 1789544631.80417,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "note",
"text": "This is another note",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "52c58b85-88b3-4a03-8542-16692af9f2e8",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.804229,
"updated_at": 1789544631.804229,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "job_title",
"text": "Contact Test Subject",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "61a01078-ed29-4fb4-9909-c884b078d801",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544631.804272,
"updated_at": 1789544631.804272,
"deleted_at": null,
"label": "Personal",
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "website",
"text": "http://www.gholi.com",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "ac928c4d-947e-424a-906e-6d18ec837968",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544632.875135,
"updated_at": 1789544632.875135,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "tag",
"text": "BulkTag",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "a85eaed0-5db6-44bf-a512-2566f4842dea",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544633.035363,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": "Home-Line1",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "phone_number",
"text": "+989028202679",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "0bb0b627-774d-4a7c-afcc-72c11ffa701f",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544633.138046,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": "Personal",
"is_primary": true,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "ffc157ec-033e-4663-ad9a-af3eca26a855",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544633.313559,
"updated_at": 1789544633.313559,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "375285f8-b73b-4bd3-b3bc-92edecb42811",
"contact": "38209551-ddf4-45c6-809d-845ec8090b0d",
"created_at": 1789544633.768072,
"updated_at": 1789544633.768072,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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: f7c09e52-7232-44c5-8ff5-ebbed6880579- 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": "38209551-ddf4-45c6-809d-845ec8090b0d",
"display_name": "Johnny",
"partner_name": "Jane Doe",
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"sort_field": "Johnny",
"last_touch": null,
"last_touch_action": null,
"next_touch": null,
"touch_freq": null,
"summary": {
"id": "38209551-ddf4-45c6-809d-845ec8090b0d",
"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": 1789544631.790681,
"updated_at": 1789544630.845693,
"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: 45af00aa-09cf-49d0-a970-3ba4110659ee
Response
200Body
{
"code": "OK",
"data": {
"id": 3,
"contacts": [
{
"id": "45af00aa-09cf-49d0-a970-3ba4110659ee",
"display_name": "Zakroff",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"sort_field": "Zakroff",
"last_touch": 1789544630.845,
"last_touch_action": "email",
"next_touch": 1790149430.845,
"touch_freq": 7,
"ios_address_book_id": null,
"android_address_book_id": null,
"created_at": 1789544632.250019,
"updated_at": 1789544630.845693,
"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"
},
{
"id": "87a71a7b-ceba-4549-8736-a73bad7ab262",
"display_name": "Hank Zakroff",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"sort_field": "Zakroff Hank",
"last_touch": 1789544630.845,
"last_touch_action": "email",
"next_touch": 1790149430.845,
"touch_freq": 7,
"ios_address_book_id": "2E73EE73-C03F-4D5F-B1E8-44E85A70F170",
"android_address_book_id": null,
"created_at": 1789544632.25004,
"updated_at": 1789544630.845693,
"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"
}
],
"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": "45af00aa-09cf-49d0-a970-3ba4110659ee",
"display_name": "Zakroff",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"sort_field": "Zakroff",
"last_touch": 1789544630.845,
"last_touch_action": "email",
"next_touch": 1790149430.845,
"touch_freq": 7,
"ios_address_book_id": null,
"android_address_book_id": null,
"created_at": 1789544632.250019,
"updated_at": 1789544630.845693,
"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"
},
{
"id": "87a71a7b-ceba-4549-8736-a73bad7ab262",
"display_name": "Hank Zakroff",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"sort_field": "Zakroff Hank",
"last_touch": 1789544630.845,
"last_touch_action": "email",
"next_touch": 1790149430.845,
"touch_freq": 7,
"ios_address_book_id": "2E73EE73-C03F-4D5F-B1E8-44E85A70F170",
"android_address_book_id": null,
"created_at": 1789544632.25004,
"updated_at": 1789544630.845693,
"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"
}
],
"type": "contact_duplicate"
},
{
"id": 4,
"contacts": [
{
"id": "7040ebaf-0a26-4d5d-9b71-e89d1b9b2c72",
"display_name": "Goat Boy",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"sort_field": "Boy Goat",
"last_touch": 1789544630.845,
"last_touch_action": "email",
"next_touch": 1790149430.845,
"touch_freq": 7,
"ios_address_book_id": "52EAB13E-733F-4153-B019-9A83EE67171D:ABPerson",
"android_address_book_id": null,
"created_at": 1789544632.250102,
"updated_at": 1789544630.845693,
"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": "b264cc6a-b0fb-4f08-98a8-5c4a3e71441e",
"display_name": "Goat Boy 2",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"sort_field": "Boy 2 Goat",
"last_touch": 1789544630.845,
"last_touch_action": "email",
"next_touch": 1790149430.845,
"touch_freq": 7,
"ios_address_book_id": "52EAB13E-733F-4153-B019-9A83EE67171D:ABPerson",
"android_address_book_id": null,
"created_at": 1789544632.250123,
"updated_at": 1789544630.845693,
"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"
}
],
"info": {
"count": 2,
"total": "2"
}
}Merge contacts ¶
Merge contactsPOST/contacts/:id/merge
Example URI
POST /contacts/:id/merge
URI Parameters
- id
string(required) Example: c1cc6fd0-347f-4f50-95c0-ac6378d29a7f- associations
array(optional) Example: contact.attributes
Request
Body
{
"sub_contacts": [
"26afbdc8-d450-4873-a6da-6c90b8977824",
"93423aa7-75d2-449d-b729-d34ba99157ee"
]
}Response
200Body
{
"code": "OK",
"data": {
"id": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"display_name": "John Appleseed",
"partner_name": null,
"brand": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"brand_id": "b4d5e6f4-37cd-4142-b93b-415677ce01c6",
"user_id": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"sort_field": "Appleseed John",
"last_touch": 1789544630.845,
"last_touch_action": "email",
"next_touch": 1790149430.845,
"touch_freq": 7,
"ios_address_book_id": "410FE041-5C4E-48DA-B4DE-04C15EA3DBAC",
"android_address_book_id": null,
"created_at": 1789544632.249974,
"updated_at": 1789544630.845693,
"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": "5a3c9af1-730a-488b-9dff-aec4353e92d0",
"contact": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"created_at": 1789544632.260515,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "89deb4c6-8ab7-4efa-ad48-15ebdc016c9b",
"contact": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"created_at": 1789544632.260639,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": "Home",
"is_primary": true,
"is_partner": false,
"index": 1,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": "d3ceaba8-9155-437e-b000-4a63990b73e8",
"contact": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"created_at": 1789544632.260678,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "phone_number",
"text": "(555) 564-8583",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "d1e6e972-711a-4dfd-9835-62c71bbe114a",
"contact": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"created_at": 1789544632.260704,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "phone_number",
"text": "(415) 555-3695",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "3e36ffd4-365a-48e1-ad31-1ecd444f315c",
"contact": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"created_at": 1789544632.260778,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "c456c7e7-b5ff-499c-b62c-d789c0b06197",
"contact": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"created_at": 1789544632.260827,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": "Home",
"is_primary": false,
"is_partner": false,
"index": 2,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": "e4cd67ff-646a-4821-91a0-6d34e71941c6",
"contact": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"created_at": 1789544632.260849,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "phone_number",
"text": "555-478-7672",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "97ff7f78-e2b8-4372-9dfe-8f66147116a9",
"contact": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"created_at": 1789544632.260874,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "phone_number",
"text": "(408) 555-5270",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "4093fb63-f556-4484-a8c7-67edf4e6da1e",
"contact": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"created_at": 1789544632.260897,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "phone_number",
"text": "(408) 555-3514",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "91cae90b-1fbf-4666-a6ff-6583edddfbae",
"contact": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"created_at": 1789544632.260922,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "first_name",
"text": "John",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "67a0c09d-cb89-49fd-a5e6-ada8f98d1012",
"contact": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"created_at": 1789544632.261652,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "last_name",
"text": "Appleseed",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "3e38df34-264b-4fe1-bad5-ff6a74944af9",
"contact": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"created_at": 1789544632.261684,
"updated_at": 1789544632.261684,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": null,
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "b49001d0-07e2-45c5-b22a-fae3bb7d80e9",
"contact": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"created_at": 1789544632.26171,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "email",
"text": "[email protected]",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "d64bf631-68f0-4dfd-8a36-2645de514851",
"contact": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"created_at": 1789544632.261735,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "birthday",
"text": null,
"date": 330048000,
"address": null,
"type": "contact_attribute"
},
{
"id": "b5108bcc-9112-470f-97b4-61198d1b92f5",
"contact": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"created_at": 1789544632.261765,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "source_type",
"text": "IOSAddressBook",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "3237475f-2fff-4243-ae40-ac279c1198aa",
"contact": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"created_at": 1789544632.261792,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": "Home",
"is_primary": false,
"is_partner": false,
"index": 0,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": "631f65d6-efb8-41bd-8e29-afef69edda26",
"contact": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"created_at": 1789544632.261815,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "phone_number",
"text": "888-555-5512",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "39603401-1fc7-4da3-a5f9-2be54a9fd418",
"contact": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"created_at": 1789544632.261839,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"attribute_type": "phone_number",
"text": "888-555-1212",
"date": null,
"address": null,
"type": "contact_attribute"
},
{
"id": "1ab4f671-adcf-4d42-97bd-cf9be660f349",
"contact": "c1cc6fd0-347f-4f50-95c0-ac6378d29a7f",
"created_at": 1789544634.006218,
"updated_at": 1789544630.845693,
"deleted_at": null,
"label": null,
"is_primary": false,
"is_partner": false,
"index": null,
"created_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"updated_by": "f7c09e52-7232-44c5-8ff5-ebbed6880579",
"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": "45af00aa-09cf-49d0-a970-3ba4110659ee",
"sub_contacts": [
"87a71a7b-ceba-4549-8736-a73bad7ab262"
]
},
{
"parent": "7040ebaf-0a26-4d5d-9b71-e89d1b9b2c72",
"sub_contacts": [
"b264cc6a-b0fb-4f08-98a8-5c4a3e71441e"
]
}
]
}Response
200Body
{
"code": "OK",
"data": {
"job_id": "1eebb885-ec29-46b4-9678-4c9f9a60014e"
}
}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": "ca3daf03-79a7-4285-b1dc-47d991f738a5",
"created_at": 1789544395.822112,
"updated_at": 1789544395.822112,
"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": "196370b3-ab52-4f36-8026-cd7bd77f39a2",
"created_at": 1789544636.7255,
"updated_at": 1789544636.7255,
"deleted_at": null,
"created_by": "280e369a-c540-4880-bc62-c24de9e8d849",
"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": "19c85957-1630-40bc-9cce-ed60e0fb1587",
"type": "contact_attribute_def"
}
}