1.Get all contacts : sample content

Request

Headers Authorisation : token

Query Parameters :

createdDate- string.

1712824166111 timestamp of the created Date contact.

condition- string.

Accept Values are EQ, LT, GT, GTE, LTE.

Default : EQ value.

offset- Default value is 0, increase by 1.

limit - Maximum records is 100. Default Value is 100.

filter - Filter records using search query

Ex: 1 AND : 'primaryPhoneNumber = "7210664812277358" AND city = "Hen"'.

Ex: 2 OR: '(primaryPhoneNumber = "7210664812277358" OR city = "Hen")'.

Ex: 3 AND,OR : 'city = "Hen" AND (primaryPhoneNumber = "7210664812277358" OR blockCustomer = 0)'.

Ex: 4 AND,OR,IN : 'city = "Hen" AND (primaryPhoneNumber IN ("7210664812277358","2694499999495") OR blockCustomer = 0)'.

fields- to retrieve particular fileds.

Fields = firstName, lastName.

Response : 200

Copy code
[
  {
    "accountNumber": null,
    "address": "",
    "blockCustomer": 0,
    "blockCustomerReq": 0,
    "blockedBy": null,
    "blockedReqBy": null,
    "city": "",
    "coid": 1324,
    "cookiesId": null,
    "country": "",
    "createdAt": "2024-03-06T14:13:19.000Z",
    "currentCustomerNumber": null,
    "customerType": "",
    "doNotDisturb": 0,
    "doNotDisturbBy": null,
    "doNotDisturbReq": 0,
    "doNotDisturbReqBy": null,
    "email": "[]",
    "facebook": "",
    "firstName": "james",
    "instagram": "",
    "lastName": "cameron",
    "location": "",
    "mergeCustomer": null,
    "phoneNumber": "[]",
    "postalCode": "",
    "primaryEmail": "",
    "primaryPhoneNumber": "",
    "Reason": null,
    "Source": null,
    "state": "",
    "tags": "[]",
    "Timezone": null,
    "twitter": "",
    "type": null,
    "updatedAt": "2024-03-06T14:13:19.000Z",
    "voiceBiometric": "",
    "whatsapp": ""
  }
]

2.Single contacts : sample content

Request

Headers Authorisation : token

Parameters

Id- contact id.

Query Parameters :

createdDate- string.

1712824166111 timestamp of the created Date contact.

condition- string.

Accept Values are EQ, LT, GT, GTE, LTE.

Default : EQ value.

offset- Default value is 0, increase by 1.

limit- Maximum records is 100. Default Value is 100.

filter- Filter records using search query.

Ex: 1 AND : 'primaryPhoneNumber = "7210664812277358" AND city = "Hen"'.

Ex: 2 OR: '(primaryPhoneNumber = "7210664812277358" OR city = "Hen")'.

Ex: 3 AND,OR : 'city = "Hen" AND (primaryPhoneNumber = "7210664812277358" OR blockCustomer = 0)'.

Ex: 4 AND,OR,IN : 'city = "Hen" AND (primaryPhoneNumber IN ("7210664812277358","2694499999495") OR blockCustomer = 0)'.

fields- to retrieve particular fileds.

Fields=firstName,lastName.

Response : 200

Copy code
[
  {
    "accountNumber": null,
    "address": "",
    "blockCustomer": 0,
    "blockCustomerReq": 0,
    "blockedBy": null,
    "blockedReqBy": null,
    "city": "",
    "coid": 1324,
    "cookiesId": null,
    "country": "",
    "createdAt": "2024-03-06T14:13:19.000Z",
    "currentCustomerNumber": null,
    "customerType": "",
    "doNotDisturb": 0,
    "doNotDisturbBy": null,
    "doNotDisturbReq": 0,
    "doNotDisturbReqBy": null,
    "email": "[]",
    "facebook": "",
    "firstName": "james",
    "instagram": "",
    "lastName": "cameron",
    "location": "",
    "mergeCustomer": null,
    "phoneNumber": "[]",
    "postalCode": "",
    "primaryEmail": "",
    "primaryPhoneNumber": "",
    "Reason": null,
    "Source": null,
    "state": "",
    "tags": "[]",
    "Timezone": null,
    "twitter": "",
    "type": null,
    "updatedAt": "2024-03-06T14:13:19.000Z",
    "voiceBiometric": "",
    "whatsapp": ""
  }
]

3.Create contact : sample content

Request

Headers Authorisation : token

Body :

Copy code
[
  {
    "firstName": "string",
    "lastName": "string",
    "primaryPhoneNumber": "number",
    "primaryEmail": "string",
    "phoneNumber": "[number]",
    "email": [
      "string"
    ],
    "tags": "string",
    "location": "string",
    "address": "string",
    "country": "string",
    "state": "string",
    "city": "string",
    "postalCode": "string",
    "facebook": "string",
    "instagram": "string",
    "whatsapp": "string",
    "twitter": "string",
    "customerType": "string"
  },
  "Required key are :  lastName,primaryPhoneNumber, primaryEmail"
]

Response : 200

Copy code
[
  {
    "message": "Contact is created successfully ."
  }
]

4.Update contact : sample content

Request

Headers Authorisation : token

Parameters :

Id- contact id.

Body

Copy code
[
  {
    "firstName": "string",
    "lastName": "string",
    "phoneNumber": 0,
    "email": "string",
    "tags": "string",
    "location": "string",
    "address": "string",
    "country": "string",
    "state": "string",
    "city": "string",
    "postalCode": "string",
    "facebook": "string",
    "instagram": "string",
    "whatsapp": "string",
    "twitter": "string",
    "customerType": "string"
  }
]

Response : 200

Copy code
[
  {
    "message": "contact updated"
  }
]

5.Delete contact : sample content

Request

Headers Authorisation : token

Parameters :

Id- contact id.

Response : 200

Copy code
[
  {
    "message": "Contact Id has been Deleted Successfully"
  }
]