Page Detail Methods

Below, you can find the Get Data Methods for Ticket Detail page, Ticket Form page, Contact Detail page, Contact Form page, Account Detail page, and Account Form page. And Set Data Methods for Ticket Detail page, Ticket Form page, Contact Form page, and Account Form page in detail.

 

Ticket Detail Page

This method allows you to access various ticket properties with ease. It is accessible from the desk.ticket.detail.rightpanel, desk.ticket.detail.subtab, and desk.ticket.detail.lefttab widget locations.

It can also be accessed from global locations but only when the ticket detail page is accessible.

Get Data Methods

These data methods help you to fetch the details of the ticket in Zoho Desk by using the given request.
The properties related to the ticket detail page are listed below:

PropertyRequestResponse
departmentIdticket.departmentId{'status':'success','ticket.departmentId':
'12345678901234567'}
emailticket.email{'status':'success','ticket.email':
'support@zohodesk.com'}
subjectticket.subject{'status':'success','ticket.subject':
'Faulty phone charging port'}
descriptionticket.description{'status':'success','ticket.description':
'Product replacement'}
statusticket.status{'status':'success','ticket.status':'Open'}
dueDateticket.dueDate{'status':'success','ticket.dueDate':
'21/02/2018 12:00 PM'}
threadCountticket.threadCount{'status':'success','ticket.threadCount':'1'}
isSpamticket.isSpam{'status':'success','ticket.isSpam':'false'}
createdTimeticket.createdTime{'status':'success','ticket.createdTime':
'29/01/2018 11:55 PM'}
modifiedTimeticket.modifiedTime'status':'success','ticket.modifiedTime':'
31/01/2018 11:27 AM'}
assigneeticket.assignee{'status':'success','ticket.assignee':
{ id : '34567844', name : 'User Name',
teamid : '3456789', team : 'My Team' }
ownerticket.owner{'status':'success','ticket.owner':'Agent Name'}
idticket.id{'status':'success','ticket.id':'12345678901234567'}
accountNameticket.accountName{'status':'success','ticket.accountName':'
Account Name'}
phoneticket.phone{'status':'success','ticket.phone':'9876543210'}
productNameticket.productName{'status':'success','ticket.productName':
'Product Name'}
commentCountticket.commentCount{'status':'success','ticket.commentCount':'1'}
priorityticket.priority{'status':'success','ticket.priority':'High'}
channelticket.channel{'status':'success','ticket.channel':'Phone'}
classificationticket.classification{'status':'success','ticket.classification':'Problem'}
categoryticket.category{'status':'success','ticket.category':'General'}
subCategoryticket.subCategory{'status':'success','ticket.subCategory':
'Sub General'}
contactNameticket.contactName{'status':'success','ticket.contactName':
'Contact Name'}
cf(customField)ticket.cf{'status':'success','ticket.cf':
{'cf_counter': '12','cf_deal_id':
'2288589490093'}}
contactIdticket.contactId{'status':'success','ticket.contactId':
'271540000000358001'}
numberticket.number{'status':'success','ticket.number':'104'}

Sample Request

Copied// To get the ticket information
ZOHODESK.get("ticket").then(function(response) {
   console.log(response["ticket"]);
   // your code here...
}).catch(function(err){
  // handle error here...
});

Sample Response

Copied{
  "ticket": {
    "departmentId": "649276000001654321",
    "email": "jhon.doe@zoho.com",
    "subject": "Billing discrepancy",
    "description": "I noticed an error in my recent invoice. It appears that I have been charged twice for the same product. I would like to request a refund for the duplicate charge. Please review the attached invoice for reference.<div style=\"font-size: 13px; font-family: Arial, Helvetica, sans-serif\"><div><br></div></div>",
    "status": "Open",
    "dueDate": "11 May 2023 02:33 AM",
    "threadCount": "3",
    "isSpam": "false",
    "createdTime": "05/10/2023 08:33 PM",
    "modifiedTime": "05/17/2023 10:39 PM",
    "assignee": {
      "id": "6492760000001343211",
      "name": "Platform Agent"
    },
    "owner": "Platform Agent",
    "id": "649276000018012345",
    "accountName": "Jhon Doe",
    "phone": "9876543210",
    "productName": null,
    "commentCount": "0",
    "priority": "High",
    "channel": "Email",
    "classification": "Problem",
    "category": null,
    "subCategory": null,
    "contactName": "Jhon Doe",
    "number": "708",
    "contactId": "649276000018012345",
    "link": "https://desk.zoho.com/agent/platform/deskplatform/tickets/details/649276000018051234",
    "currentTimeEntry": "00:00:00",
    "cf": {
      "cf_career": null
    }
  },
  "status" : "success"
}

Sample Request

Copied// To get the particular property from the ticket

ZOHODESK.get("ticket.email").then(function(ticketResponse){
   console.log(ticketResponse["ticket.email"]);
   // your code here...
}).catch(function(err){
  // handle error here...
})

Sample Response

Copied{
  "ticket.email" : "platform@zoho.com",
  "status" : "success"
}


Set Data Methods

The set wrapper is used to populate the relevant value to the mentioned field.

  • In the ticket detail view page, the set wrapper is used to populate value in fields, such as ticket.phone, ticket.classifications, and ticket.priority.
  • You can also set values for components, such as comment box, time entry, reply editor recipient and reply editor attachments in the ticket detail view.
  • In the add/edit page, you can set the value in any field in form page unlike the field restrictions in the ticket detail view page.

The properties related to the ticket detail page are listed below:

PropertyDescriptionSample Code
ticket.phone
  • Type: string
  • To set given phone number to the phone field in ticket detail view
ZOHODESK.set("ticket.phone", {phone: "1234567890"});
ticket.priority
  • Type: string
  • To set given priority to the priority field in ticket detail view.
  • You can select the value from the priority options picklist
ZOHODESK.set("ticket.priority", {priority: "High"});
ticket.classification
  • Type: string
  • To set given classification to the classification field in ticket detail view.
  • You can select the value from the classification options picklist
ZOHODESK.set("ticket.classification", {classification: "Feature"});
ticket.comment
  • Type: string
  • To set the given comment in the comment box
  • Populates the end-user comment in the comment box. As a end-user, you must save the comment, if required
ZOHODESK.set("ticket.comment", {comment: "Comment box opened and comment content added"});
ticket.currentTimeEntry
  • Type: empty object {}
  • To set a time Entry in opened ticket
  • Ensure that the Time Entry feature is enabled in Setup >> CUSTOMIZATION >> Time Tracking before you use this command.
ZOHODESK.set("ticket.currentTimeEntry", {});
ticket.replyEditor
  • Type: string
  • To set the given comment in the replyEditor.
  • If type is not specified, the given content will be appended to the existing content in the reply editor.
ZOHODESK.invoke("INSERT", "ticket.replyEditor",{ value : "Sample Content", type : "replace"});
ticket.replyEditorRecipients
  • Type: object
  • Populates to, cc and bcc addresses in reply editor
ZOHODESK.set("ticket.replyEditorRecipients", {to:["testTO@gmail.com"], bcc:["testBCC @gmail.com"], cc: ["testCC @gmail.com"]});
ticket.replyAttach
  • Type: object
  • To attach user's file into the replyEditor.
  • Populates end-user attachments in reply editor.
ZOHODESK.set("ticket.replyAttach", {files:[{file:"file content", type:"txt/plain", name:"file.txt"}]};

Sample Request

CopiedZOHODESK.set("ticket.phone", {phone: "123456789"}).then(function(response) {
   console.log(response);
   // your code here...
}).catch(function(err){
   // handle error here...
})

//Response
{
    "status" : "success"
}
 

Ticket Form Page

This method allows you to access various properties of ticket add, ticket edit and ticket clone forms. It is accessible from the desk.ticket.form.rightpanel widget location.

It can also be accessed from global locations but only when the ticket form pages are accessible.

Get Data Methods

These data methods help you to fetch the details of all the fields in ticket add, ticket edit, and ticket clone forms in Zoho Desk by using the given request.

The properties related to the ticket form page are listed below:

PropertyRequestResponse
departmentIdticketForm.departmentId{ status: 'success', 'ticketForm.departmentId': {ticketForm.departmentId':{ id: '649276000000230080', name: 'Accounts' }} }
accountIdticketForm.accountId{ status: 'success', 'ticketForm.accountId': {ticketForm.accountId':{ id: '649276000000230080', name: 'Account Name' }} }
contactIdticketForm.contactId{ status: 'success', 'ticketForm.contactId': {ticketForm.contactId':{ id: '649276000000230080', name: 'deskplatform' }} }
productIdticketForm.productId{ status: 'success', 'ticketForm.productId': {ticketForm.productId':{ id: '649276000000230080', name: 'laptop' }} }
assigneeIdticketForm.assigneeId{ status: 'success', 'ticketForm.assigneeId': {ticketForm.assigneeId':{ id: '649276000000139001', name: 'Tony' ,type:'agent'}} }
layoutIdticketForm.layoutId{'status':'success','ticketForm.layoutId':'649276000000233355'}
emailticketForm.email{'status':'success','ticketForm.email':'support@zohodesk.com'}
phoneticketForm.phone{'status':'success','ticketForm.phone':'9876543210'}
subjectticketForm.subject{'status':'success','ticketForm.subject':'Faulty phone charging port'}
descriptionticketForm.description{'status':'success','ticketForm.description':'Product replacement'}
dueDateticketForm.dueDate{'status':'success','ticketForm.dueDate':'21/02/2022 12:00 PM'}
statusticketForm.status{'status':'success','ticketForm.status':'Open'}
priorityticketForm.priority{'status':'success','ticketForm.priority':'High'}
channelticketForm.channel{'status':'success','ticketForm.channel':'Phone'}
languageticketForm.language{'status':'success','ticketForm.language':'English'}
classificationticketForm.classification{'status':'success','ticketForm.classification':'Problem'}
cf (Custom Fields)ticketForm.cf_APIName{'status':'success','ticketForm.cf_APIName':'value'}

Sample Request

Copied// To get the form fields
ZOHODESK.get("ticketForm.fields").then(function(fieldsResponse){
    console.log(fieldsResponse["ticketForm.fields"]);
    // your code here...
}).catch(function(error){
   // handle error here..
})

// To get the current field value
ZOHODESK.get('ticketForm.subject').then(function(response) {
     console.log(response["ticketForm.subject"]);
     // your code here...
}).catch(function(err){
    // handle error here...
});

Sample Response

Copied// Form fields get response
{
  "ticketForm.fields": [
    {
      "displayLabel": "Desk ZGID",
      "apiName": "cf_related_project",
      "isCustomField": true,
      "i18NLabel": "Desk ZGID",
      "toolTip": "Kindly Enter the Project ID",
      "isSystemMandatory": false,
      "type": "Text",
      "isReadOnly": false,
      "toolTipType": "icon",
      "name": "Desk ZGID",
      "isEncryptedField": false,
      "isPHI": false,
      "id": "4011801787265",
      "isRemovable": true,
      "maxLength": 255,
      "isMandatory": false,
      "localizedValue": null
    }
  ],
  "status": "success"
}

// Particular property get response
{
   "ticketForm.phone" :  "1234567890",
   "status" : "success"
}


Set Data Methods

These data methods help you to set the value for all the fields in ticket add, ticket edit, and ticket clone forms in Zoho Desk by using apiName of the field.

Here, the example shows a request to set the value for the "phone" field and to add an attachment to the Ticket Form page. Similarly, you can set values for all fields in ticket forms using this format. 

Sample Request

Copied//To set value for the phone field
ZOHODESK.set("ticketForm.phone", {value:"1234567890"}).then(function(response){
   console.log(response);
   // your code here...
}).catch(function(error){
  // handle error here..
})

//To add an attachment in the Ticket Form page
ZOHODESK.set('ticketForm.attachment',{ value : files : [ file data] }) 


//Response
{
    "status" : "success"
}
 

Contact Detail Page

This method allows you to access various contact properties with ease. It is accessible from the contact detail page locations.

It can also be accessed from global locations but only when the contact detail page is accessible.

You can fetch the details of the properties available in contact detail page in Zoho Desk by using the given request.

The properties related to the contact detail page are listed below:

PropertyRequestResponse
titlecontact.title{'status':'success','contact.title':'Customer Support Executive'}
typecontact.type{'status':'success','contact.type':'Paid User'}
accountIdcontact.accountId{'status':'success','contact.accountId':'12345678901234567'}
cf (Custom Fields)contact.cf{'status':'success','contact.cf': {cf_longitude: '0'}}
createdTimecontact.createdTime{'status':'success','contact.createdTime':'2018-05-17T08:32:19.000Z'}
customerHappinesscontact.customerHappiness{'status':'success','contact.customerHappiness':{badPercentage: '0', okPercentage: '0', goodPercentage: '0'}}
descriptioncontact.description{'status':'success','contact.description':'Customer Support Lead'}
emailcontact.email{'status':'success','contact.email':'support@zohodesk.com'}
secondaryEmailcontact.secondaryEmail{'status':'success','contact.secondaryEmail':'support@zohodesk.com'}
facebookcontact.facebook{'status':'success','contact.facebook':'zoho'}
twittercontact.twitter{'status':'success','contact.twitter':'zohocares'}
modifiedTimecontact.modifiedTime{'status':'success','contact.modifiedTime':'31/01/2022 11:27 AM'}
firstNamecontact.firstName{'status':'success','contact.firstName':'Lawrence'}
idcontact.id{'status':'success','contact.id':'12345678901234567'}
isAnonymouscontact.isAnonymous{'status':'success','contact.isAnonymous':false}
isDeletedcontact.isDeleted{'status':'success','contact.isDeleted':false}
isEndUsercontact.isEndUser{'status':'success','contact.isEndUser':false}
isFollowingcontact.isFollowing{'status':'success','contact.isFollowing':false}
isSpamcontact.isSpam{'status':'success','contact.isSpam':false}
isTrashedcontact.isTrashed{'status':'success','contact.isTrashed':false}
lastNamecontact.lastName{'status':'success','contact.lastName':'Lawrence'}
layoutDetailscontact.layoutDetails{'status':'success','contact.layoutDetails':{id: '271540000000074005', layoutName: 'marketplacedemo'}}
layoutIdcontact.layoutId{'status':'success','contact.layoutId':'271540000000074005'}
linkcontact.link{'status':'success', 'contact.link':'https://desk.zoho.com/support/marketplacedemo/ ShowHomePage.do#Contacts/dv/271540000000144009' }
mobilecontact.mobile{'status':'success','contact.mobile': '044 - 67447070'}
ownerIdcontact.ownerId{'status':'success','contact.ownerId':'271540000000103011'}
phonecontact.phone{'status':'success','contact.phone':'9876543210'}
photoURLcontact.photoURL{'status':'success','contact.photoURL':null}
streetcontact.street{'status':'success','contact.street':'GST Road'}
statecontact.state{'status':'success','contact.state':'Tamil Nadu'}
citycontact.city{'status':'success','contact.city':'Chennai'}
countrycontact.country{'status':'success','contact.country':'India'}
zipcontact.zip{'status':'success','contact.zip':'603202'}

Sample Request

Copied// To get the contact detail
ZOHODESK.get("contact").then(function(contactResponse){
    console.log(contactResponse["contact"]);
    // your code here...
}).catch(function(error){
   // handle error here...
})

// To get particular property of contact info
ZOHODESK.get("contact.lastName").then(function(response) {
    console.log(response["contact.lastName"]);
    // your code here...
}).catch(function(error){
    // handle error here...
})

Sample Response

Copied// contact detail response
{
  "contact": {
    "accountId": null,
    "accountCount": "0",
    "id": "64927600000123456",
    "cf": {
      "cf_nickname": null
    },
    "city": null,
    "country": null,
    "createdTime": "2022-11-05T15:03:01.000Z",
    "customFields": {
      "Nickname": null
    },
    "customerHappiness": {
      "badPercentage": "0",
      "okPercentage": "0",
      "goodPercentage": "0"
    },
    "description": null,
    "email": null,
    "facebook": null,
    "firstName": null,
    "isAnonymous": false,
    "isDeleted": false,
    "isEndUser": false,
    "isFollowing": false,
    "isSpam": false,
    "isTrashed": false,
    "lastName": "+1 631-813-7327",
    "layoutDetails": {
      "id": "649276000000012345",
      "layoutName": "platform"
    },
    "layoutId": "649276000000012345",
    "link": "https://desk.zoho.com/agent/platformagent/deskplatform/contacts/details/649276000001234567",
    "mobile": "+16318137327",
    "modifiedTime": "2022-11-05T15:03:01.000Z",
    "ownerId": "649276000000139001",
    "phone": null,
    "photoURL": null,
    "secondaryEmail": null,
    "state": null,
    "street": null,
    "title": null,
    "twitter": null,
    "zip": null,
    "type": null
  },
  "status": "success",
}

// Particular contact property response
{
     "contact.lastName" : "Zuckerberg",
     "status" : "success"
}
 

Contact Form Page

This object allows you to access various properties of contact add and contact edit forms with ease. It is accessible from the desk.contact.form.rightpanel  widget location.

It can also be accessed from global locations but only when the contact form pages are accessible.

Get Data Methods

These data methods help you to fetch the details of all the fields in contact add and contact edit forms in Zoho Desk by using the given request.

The properties related to the contact form page are listed below:

PropertyRequestResponse
accountIdcontactForm.accountId{ status: 'success', 'contactForm.accountId': {contactForm.accountId':{ id: '12345678901234567', name: 'test' }} }
ownerIdcontactForm.ownerId{ status: 'success', 'contactForm.ownerId': {contactForm.ownerId':{ id: '649276000000139001', name: 'deskplatform' }} }
layoutIdcontactForm.layoutId{'status':'success','contactForm.layoutId':'271540000000074005'}
firstNamecontactForm.firstName{'status':'success','contactForm.firstName':'Lawrence'}
lastNamecontactForm.lastName{'status':'success','contactForm.lastName':'Lawrence'}
emailcontactForm.email{'status':'success','contactForm.email':'support@zohodesk.com'}
secondaryEmailcontactForm.secondaryEmail{'status':'success','contactForm.secondaryEmail':'support@zohodesk.com'}
twittercontactForm.twitter{'status':'success','contactForm.twitter':'zohocares'}
facebookcontactForm.facebook{'status':'success','contactForm.facebook':'zoho'}
phonecontactForm.phone{'status':'success','contactForm.phone':'9876543210'}
mobilecontactForm.mobile{'status':'success','contactForm.mobile': '044 - 67447070'}
typecontactForm.type{'status':'success','contactForm.type':'Paid User'}
titlecontactForm.title{'status':'success','contactForm.title':'Leads'}
cf (Custom Fields)contactForm.cf_APIName{'status':'success','contactForm.cf_APIName': 'value'}

Sample Request

Copied// To get the form fields
ZOHODESK.get("contactForm.fields").then(function(fieldsResponse){
    console.log(fieldsResponse["contactForm.fields"]);
    // your code here...
}).catch(function(error){
   // handle error here..
})

// To get the current field value
ZOHODESK.get('contactForm.lastName').then(function(response) {
     console.log(response["contactForm.lastName"]);
     // your code here...
}).catch(function(err){
    // handle error here...
});

Sample Response

Copied// Form fields get response
{
  "contactForm.fields": [
    {
      "displayLabel": "Layout",
      "apiName": "layoutId",
      "isCustomField": false,
      "i18NLabel": "Layout",
      "isSystemMandatory": false,
      "type": "LookUp",
      "isReadOnly": false,
      "name": "layoutId",
      "isEncryptedField": false,
      "isPHI": false,
      "id": "4005586868014",
      "isRemovable": false,
      "maxLength": 50,
      "isMandatory": true,
      "localizedValue": null
    }
  ],
  "status": "success"
}

// Particular property get response
{
   "contactForm.lastName" :  "Zuckerberg",
   "status" : "success"
}


Set Data Methods

These data methods help you to set the value for all the fields in contact add and contact edit forms in Zoho Desk by using the below given request.

Here, the example shows the request to set the value for the field: phone in contact add and edit forms. Similarly, you can set values for all the fields in contact forms using this format.

Sample Request

ZOHODESK.set("contactForm.phone", {value:"1234567890"}).then(function(res){
   console.log(res);
   // your code here...
}).catch(function(error){
   // handle error here...
})

// Response
{
   "status" : "success"
}

 

Account Detail Page

This method allows you to access various account properties with ease. It is accessible from the account detail page locations.

It can also be accessed from global locations but only when the account detail page is accessible.

You can fetch the details of the properties available in the account detail page in Zoho Desk by using the given request.

The properties related to the account detail page are listed below:

PropertyRequestResponse
annualrevenueaccount.annualrevenue{'status':'success','account.annualrevenue':'1200000.0'}
cf (customField)account.cf{'status':'success','account.cf': {cf_longitude: '0'}}
cityaccount.city{'status':'success','account.city':'Pleasanton'}
countryaccount.country{'status':'success','account.country':'United States'}
codeaccount.code{'status':'success','account.code':'94588'}
createdTimeaccount.createdTime{'status':'success','account.createdTime':'2018-05-17T08:32:19.000Z'}
descriptionaccount.description{'status':'success','account.description':'Customer Support Account'}
emailaccount.email{'status':'success','account.email':'support@zohodesk.com'}
faxaccount.fax{'status':'success','account.fax':'044 67447172'}
idaccount.id{'status':'success','account.id':'271540000000083214'}
industryaccount.industry{'status':'success','account.industry':'Large Enterprise'}
isDeletedaccount.isDeleted{'status':'success','account.isDeleted':false}
isFollowingaccount.isFollowing{'status':'success','account.isFollowing':false}
isTrashedaccount.isTrashed{'status':'success','account.isTrashed':false}
lastNameaccount.lastName{'status':'success','account.lastName':'Lawrence'}
layoutDetailsaccount.layoutDetails{'status':'success','account.layoutDetails':{id: '271540000000074005', layoutName: 'marketplacedemo'}}
layoutIdaccount.layoutId{'status':'success','account.layoutId':'271540000000074005'}
linkaccount.link{'status':'success', 'account.link':'https://desk.zoho.com/support/marketplacedemo/ ShowHomePage.do#Accounts/dv/271540000000144009' }
modifiedTimeaccount.modifiedTime{'status':'success','account.modifiedTime':'31/01/2022 11:27 AM'}
ownerIdaccount.ownerId{'status':'success','account.ownerId':'271540000000103011'}
phoneaccount.phone{'status':'success','account.phone':'1 888 900 9646'}
streetaccount.street{'status':'success','account.street':'GST Road'}
stateaccount.state{'status':'success','account.state':'Tamil Nadu'}
websiteaccount.website{'status':'success', 'account.website':'https://www.zoho.com" }

Sample Request

Copied// To get the account detail
ZOHODESK.get("account").then(function(accountResponse){
    console.log(accountResponse["account"]);
    // your code here...
}).catch(function(error){
   // handle error here...
})

// To get particular property of account info
ZOHODESK.get("account.name").then(function(accountResponse){
    console.log(accountResponse["account.name"]);
    // your code here...
}).catch(function(error){
   // handle error here...
})

Sample Response

Copied//account detail response

{
  "layoutId": "649276000000074009",
  "name": "jhon",
  "email": null,
  "website": null,
  "fax": null,
  "industry": null,
  "street": null,
  "city": null,
  "state": null,
  "country": null,
  "code": null,
  "description": null,
  "phone": null,
  "annualrevenue": null,
  "createdTime": "2022-07-19T07:25:53.000Z",
  "modifiedTime": "2022-07-19T07:25:53.000Z",
  "ownerId": "649276000000139001",
  "customFields": null,
  "layoutDetails": {
    "id": "649276000000074009",
    "layoutName": "platform"
  },
  "cf": {},
  "id": "649276000004688069",
  "isTrashed": false,
  "isFollowing": false,
  "isDeleted": false,
  "link": "https://desk.zoho.com/agent/platform/deskplatform/accounts/details/649276000001234"
}

//particular property get response

{
   "account.name" :  "jhon",
   "status" : "success"
}
 

Account Form Page

This object allows you to access various properties of account add and account edit forms with ease. It is accessible from the desk.account.form.rightpanel widget location.

It can also be accessed from global locations but only when the account form pages are accessible.

Get Data Methods

These data methods help you to fetch the details of all the fields in account add, account edit, and account clone forms in Zoho Desk by using the given request.

The properties related to the account form page are listed below:

PropertyRequestResponse
ownerIdaccountForm.ownerId{ status: "success", "accountForm.ownerId": {accountForm.ownerId": Object { id: "649276000000139001", name: "deskplatform" }} }
layoutIdaccountForm.layoutId{'status':'success','accountForm.layoutId':'271540000000074005'}
emailaccountForm.email{'status':'success','accountForm.email':'support@zohodesk.com'}
phoneaccountForm.phone{'status':'success','accountForm.phone':'9876543210'}
websiteaccountForm.website{'status':'success','accountForm.website': 'http://desk.zoho.com'}
countryaccountForm.country{'status':'success','accountForm.country':'India'}
cf(customField)accountForm.cf_APIName{'status':'success','accountForm.cf_APIName': "value"}

Sample Request

CopiedZOHODESK.get("accountForm.email").then(function(fieldsResponse){
    console.log(fieldsResponse);
    // your code here...
}).catch(function(error){
   // handle error here..
})

Sample Response

Copied{
  "accountForm.email": "jhondoe@zoho.com"
}


Set Data Methods

These data methods help you to set the value for all the fields in account add and account edit forms in Zoho Desk by using the given request.

Here, the example shows the request to set the value for the field: phone in account add and edit forms. Similarly, you can set values for all the fields in account forms using this format.

Sample Request

CopiedZOHODESK.set("accountForm.phone", {value:"1234567890"}).then(function(response) {
  //Response
  // {status: success}
}).catch(function(err){
  //Failure Response
})

Sample Response

Copied{
  "status": "success"
}