Welcome to Portal

?Unknown\pull-down

Welcome to Zoho Cares

Bienvenido a Soporte de Zoho

Search our knowledge base, ask the community or submit a request.

Contacts API

Contact CRUD APIs

Authorization

HeaderKey

Description

Authorization *

Zoho-oauthtoken<space><ACCESS_TOKEN>

Accept *

Set to application/json.

*All APIs are accessible under zohovoice.contacts.ALL scope.

OAuth Doc


Create Contact

Use this API to create a contact record.

  POST     https://voice.zoho.com/rest/json/zv/contacts

Scope: zohovoice.contacts.CREATE


Parameters

Param Name

DataType

Description

contact *

string

Contact data as json.

first_name and mobile keys are mandatory.

JSON Schema:

{"first_name":"<string>","last_name":"<string>","email":"<string>","mobile":"<string>","mobile1":"<string>","mobile2":"<string>","mobile3":"<string>","phone":"<string>","phone1":"<string>","phone2":"<string>","phone3":"<string>","company":"<string>","address":"<string>","state":"<string>","country":"<string>","is_favourite":"<string>","is_spam":"<string>","contact_status":{"id":"<id of status>","display_value":"<display value of status>"}}


Get available contact statuses from the get
 contact status API below.


Response


SUCCESS

{

   "code": "200",

   "contacts": {

       "country": "",

       "created_time": 1728037831825,

       "is_spam": "",

       "address": "",

       "mobile": "+12015550123",

       "mobile1": "",

       "phone2": "",

       "last_name": "",

       "phone3": "",

       "is_favourite": "",

       "contact_id": 315000153768793,

       "phone1": "",

       "number": [

           "+12015550126"

       ],

       "phone": "",

       "mobile3": "",

       "mobile2": "",

       "contact_owner": 415005010526109,

       "company": "",

       "state": "",

       "first_name": "test",

       "email": ""

   },

   "status": "SUCCESS"

}


FAILURE

{

   "code": "<App Error Code>",

   "message": "<Error Message>",

   "status": "ERROR"

}



Get All Contact Status

Use this API to get contact statuses.

  GET     https://voice.zoho.com/rest/json/zv/contacts/contact_status

Scope: zohovoice.contacts.READ


Response

SUCCESS

{

    "code": "200",

    "contact_status": [

        {

            "display_value": "Active",

            "id": "1000000000027"

        },

        {

            "display_value": "In Active",

            "id": "1000000000029"

        },

        {

            "display_value": "VIP",

            "id": "1000000000031"

        }

    ],

    "status": "SUCCESS"

}


FAILURE

{

    "code": "<App Error Code>",

    "message": "<Error Message>",

    "status": "ERROR"

}


Get All Contacts

Use this API to get contacts.

  GET     https://voice.zoho.com/rest/json/zv/contacts

Scope: zohovoice.contacts.READ

 

Parameters


Param Name

DataType

Description

totalCount

boolean

true/false (In case total count is needed)

from

integer

0

size

integer

1-50

 


Response

SUCCESS

{

   "code": "200",

   "meta": {

       "total": -1

   },

   "contacts": [

       {

           "country": "",

           "is_spam": "",

           "address": "",

           "mobile": "+15135493562",

           "mobile1": "",

           "phone2": "",

           "last_name": "8Foller",

           "phone3": "",

           "is_favourite": "",

           "contact_id": "347000014281004",

           "phone1": "",

           "phone": "+15135495601",

           "mobile3": "",

           "contact_owner": {

               "display_value": "Vignesh",

               "id": "347000000003015"

           },

           "mobile2": "",

           "company": "",

           "state": "",

           "first_name": "Andrej",

           "email": ""

       },

       {

           "country": "",

           "is_spam": "",

           "address": "",

           "mobile": "+18562644130",

           "mobile1": "",

           "phone2": "",

           "last_name": "91Venere",

           "phone3": "",

           "is_favourite": "",

           "contact_id": "347000014281005",

           "phone1": "",

           "phone": "+18566368749",

           "mobile3": "",

           "contact_owner": {

               "display_value": "Vignesh",

               "id": "347000000003015"

           },

           "mobile2": "",

           "company": "",

           "state": "",

           "first_name": "Art",

           "email": ""

       }

   ],

   "status": "SUCCESS"

}


FAILURE

{

    "code": "<App Error Code>",

    "message": "<Error Message>",

    "status": "ERROR"

}



Delete a Contact

Use this API to delete a contact record.

  DELETE     https://voice.zoho.com/rest/json/zv/contacts/<contact_id>

Scope: zohovoice.contacts.DELETE


Response

SUCCESS

{

   "code": "200",

   "contacts": "<contact_id>",

   "status": "SUCCESS"

}


FAILURE

{

    "code": "<App Error Code>",

    "message": "<Error Message>",

    "status": "ERROR"

}


Get a Contact

Use this API to get a contact record.

  GET     https://voice.zoho.com/rest/json/zv/contacts/<contact_id>

Scope: zohovoice.contacts.READ


Response

SUCCESS

{

   "code": "200",

   "contacts": {

       "country": "",

       "created_time": 1728037831825,

       "is_spam": "",

       "address": "",

       "mobile": "+12015550123",

       "mobile1": "",

       "phone2": "",

       "last_name": "",

       "phone3": "",

       "is_favourite": "",

       "contact_id": 315000153768793,

       "phone1": "",

       "number": [

           "+12015550126"

       ],

       "phone": "",

       "mobile3": "",

       "mobile2": "",

       "contact_owner": 415005010526109,

       "company": "",

       "state": "",

       "first_name": "test",

       "email": ""

   },

   "status": "SUCCESS"

}


FAILURE

{

    "code": "<App Error Code>",

    "message": "<Error Message>",

    "status": "ERROR"

}



Update a Contact

Use this API to update a contact record.

  PUT     https://voice.zoho.com/rest/json/zv/contacts/<contact_id>

Scope: zohovoice.contacts.UPDATE


Parameters


Param Name

DataType

Description

contact *

string

Contact data as json.

first_name and mobile keys are mandatory.

JSON Schema:

{"first_name":"<string>","last_name":"<string>","email":"<string>","mobile":"<string>","mobile1":"<string>","mobile2":"<string>","mobile3":"<string>","phone":"<string>","phone1":"<string>","phone2":"<string>","phone3":"<string>","company":"<string>","address":"<string>","state":"<string>","country":"<string>","is_favourite":"<string>","is_spam":"<string>","contact_status":{"id":"<id of status>","display_value":"<display value of status>"}}

Get available contact statuses from the get contact status API.


 
Response

SUCCESS

{

    "code": "200",

    "contacts": {

        "country": "",

        "created_time": 1728037831825,

        "is_spam": "",

        "address": "",

        "mobile": "+12015550123",

        "mobile1": "",

        "phone2": "",

        "last_name": "",

        "phone3": "",

        "is_favourite": "",

        "contact_id": 315000153768793,

        "phone1": "",

        "number": [

            "+12015550126"

        ],

        "phone": "",

        "mobile3": "",

        "mobile2": "",

        "contact_owner": 415005010526109,

        "company": "",

        "state": "",

        "first_name": "test",

        "email": ""

    },

    "status": "SUCCESS"

}


FAILURE

{

    "code": "<App Error Code>",

    "message": "<Error Message>",

    "status": "ERROR"

}


Helpful?00
Updated: 1 month ago
Share :