Creating a New Portal
Description
This API can be used to create new portals.
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
- service - The integerated service name
- autounique - Boolean indicated to generate the unique portal screenname
- source - From which source the portal has been created
- ip - The IP address of the users who have signed up to the portal
- 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.CREATE
URL
Copiedhttps://{zohosalesiq_server_uri}/api/v2/portalsExample
Copiedhttps://salesiq.zoho.com/api/v2/portals Payload
Copied{
"name": "Zylker",
"time_zone": "America/Los Angeles",
"phone_number": "8978453210",
"website": "www.zylker-furnitures.com",
"fax": "044 68497773",
"description": "World's largest home shopping destination offering a wide range of home and office furniture online."
}Success Response
Copied{
"url": "/api/v2/portals",
"object": "portal",
"data": {
"name": "Zylker-inc",
"website": "www.zylker-furnitures.com",
"owner": {
"email_id": "patricia@zylker.com",
"zuid": "4432365",
"operator_id": "14000000000005",
"name": "Patricia"
},
"fax": "345678",
"phone": "004789378890",
"email_id": "patricia2@zylker.com",
"widget_data": {
"owner_id": "14000000000005",
"name": "Patricia",
"greetings": "Hello, welcome to Zylker!",
"unique_name": "patty-zylk",
"id": "14000000000047"
},
"language": "",
"screenname": "Patricia Boyle",
"address": "",
"description": "World's largest home shopping destination offering a wide range of home and office furniture online.",
"time_zone": "America/Los Angeles",
"logo": "",
"icon": ""
}
}