Get portal information from Zoho Sales IQ
Table of Contents
Note: This task is applicable to all Zoho services, except Zoho Creator.
Overview
This zoho.salesiq.getPortalInfo task is used to fetch information f the specified portal in Zoho Sales IQ.
Syntax
<response> = zoho.salesiq.getPortalInfo(<portal_name>, [<connection>]);
where:
| Parameter | Data type | Description |
<response> | KEY-VALUE | The portal information that will be returned by Zoho Sales IQ. |
<connection> (optional)* | TEXT | The name of the connection *Note: This parameter is mandatory in Zoho Cliq. |
Examples
This task fetches all the organizations that a user is part of.
response = zoho.salesiq.getPortalInfo("portal_1");
Sample Response
The success response will be returned in the following format:
{
"url": "/api/v2/portals/portal_1",
"object": "portal",
"data": {
"owner": {
"email_id": "ramya.bp@zohotest.com",
"zuid": "58956160",
"operator_id": "86737000000002002",
"name": "Shawn"
},
"mobile": "",
"logo": "/api/v2/portal_1/downloads/e4959f3ac4db8d8d56174f4df667ce5b?purpose=company_logo",
"website": "",
"address": "",
"state": "",
"email_id": "",
"phone": "",
"street": "",
"company_name": "portal_1",
"language": "",
"country": "",
"description": "",
"city": "",
"screenname": "portal_1",
"icon": "/api/v2/portal_1/downloads/299efa3a6cd5f15c?purpose=company_icon",
"fax": "",
"time_zone": "Asia/Calcutta",
"name": "portal_1"
}
}