Edit Portal
Description
You can use this API to update the company details in the portal.
Request Payload
- name - Name of the portal
- phone_number - Contact number given in the portal
- website - The website used in the portal
- fax - The fax number provided in the portal
- time_zone - Time zone mentioned in the portal
- description - The portal description
- language - The chosen language of the company (example : en,fr)
- address - The mailing address provided
- email_id - The company email address
OAuth Scope:
SalesIQ.portals.UPDATE
URL
Copiedhttps://{zohosalesiq_server_uri}/api/v2/portals/{screen name}
Example
Copiedhttps://salesiq.zoho.com/api/v2/portals/zylker-inc
Payload
Copied{
"company_name": "Zylker",
"time_zone": "America/Los Angeles",
"phone": "8978453210",
"website": "www.zylker-fashions.com",
"owner": {
"email_id": "patricia@zylker.com",
"zuid": "54715436",
"operator_id": "32308000000002001",
"name": "Patricia"
},
"fax": "044 68497773",
"description": "The worlds largest branded fashions for your display!"
}
Success Response
Copied{
"url": "/api/v2/portals/zylker-inc",
"object": "portal",
"data": {
"company_name": "zylker-inc",
"website": "www.zylker-fashions.com",
"owner": {
"email_id": "patricia@zylker.com",
"zuid": "54716165",
"operator_id": "33290000000056013",
"name": "Patricia"
},
"fax": "323 3232",
"email_id": "patricia@zylker.com",
"logo": "/api/v2/zylker/downloads/e69893b85f006359609aa175389e6b5bb7dfbd7f25560f00?purpose=company_logo",
"language": "en",
"phone": "123456789",
"icon": "/api/v2/zylker/downloads/299efa3a6cd5f15c?purpose=company_icon",
"screenname": "Zylker Fashions",
"address": "Texas",
"description": "The worlds leading brands for your display!",
"image_url": "/api/v2/zylker/downloads/1526214218274_33290000000002013?purpose=department_image",
"time_zone": "America/Los Angeles"
}
}