- REST API Overview
- Prerequisite
- Operators
- Portals
- Departments
- Articles
- Articles Category
- Canned Response
- Canned Response Category
- Lead Scoring Rule
- postCreate Lead Scoring Rule
- putUpdate Lead Scoring Rule Details
- putEnable/Disable Lead Scoring Rule
- deleteDelete Lead Scoring Rule
- getList Lead Scoring Rules
- getDetails of Lead Scoring Rule
- getFrequency Details of Lead Scoring Rule
- PutUpdate Frequency Details of Lead Scoring Rule
- getLead Scoring Module Fields Criteria
- Visitor Routing
- postAdd Visitor Routing Rule
- getList Visitor Routing Rule
- getVisitor Routing Rule details
- putUpdate Visitor Routing Rule Details
- putEnable/Disable Visitor Routing Rule
- putUpdate Visitor Routing Rule Order
- deleteDelete Visitor Routing Rule
- getVisitor Routing Rule Configurations
- putUpdate Common Visitor Routing Rule
- getVisitor Routing Module Fields Criteria
- Chat Routing
- Blocked IPs
- Chat Monitor
- Zobot
- Apps
- Feedback
- Tracking Preset
- Visitor History View
- Intelligent Trigger Rule
- postCreate Intelligent Trigger Rule
- getList Intelligent Trigger Rules
- getIntelligent Trigger Rule Details
- putUpdate Intelligent Trigger Rule Details
- putEnable/Disable Intelligent Trigger
- putChange Intelligent Trigger Rule Order
- deleteDelete Intelligent Trigger Rule
- getIntelligent Trigger Module Fields Criteria
- Chat
- Calls
- Visitor
- Tags
- Webhooks
- getWebhooks List
- getWebhook Details
- postCreate Webhook
- putUpdate a Webhook
- deleteDelete a Webhook
- postGenerate Public Key
- deleteDelete a Public Key
- postAdd an Event
- deleteRemove Events
- postAdd Apps
- deleteRemove Apps
- getFailed Execution List
- postRetry Failed Execution
- deleteDelete the Failed Executions
- POSTExport Failed Executions
- getWebhook Summary
- getWebhook Execution Summary
- Callbacks
- Encryptions
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": ""
}
}© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.