- Overview
- What's New in V8?
- Changelog
- Open API Specification 3.0.0 (OAS)
- API Directory
- API Collection
- APIs and References
- OAuth
- API Limits and Credits
- Compliance
- Zoho CRM SDKs
- Metadata APIs
- Customization
- Process Automation
- Security control
- Roles
- Profiles
- Territories
- GETTerritories
- POSTTerritories
- PUTTerritories
- DELETETerritories
- POSTTransfer and Delete Territories
- GETChild Territories of a Territory
- GETTerritories Assigned
- GETAssociated User Count
- GETRetrieve User details Associated with a Territory
- PUTAssociate Users with Territory
- POSTRemove Territories of Records
- POSTAssign Territories to Records
- DELETEDisassociate Users from Territory
- Export Audit Log
- Portals
- Data Sharing
- Company Settings
- Zia
- Core APIs
- Records
- Merge Records
- Share Records
- Mail Merge
- Services
- Appointments
- Appointments Rescheduled History
- Fields Attachments
- Meeting Cancel
- Notes
- Mass Actions
- Related Records
- External ID
- Emails
- Subforms
- Linking Modules
- Others
- Bulk APIs
- Composite API
- Query API
- Notification APIs
Bulk Invite Job Status
Purpose
To get the status of the job to invite users in bulk to a portal.
Endpoints
- GET /{personality_module}/actions/portal_invite
Request Details
Request URL
{api-domain}/crm/{version}/{personality_module}/actions/portal_invite
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.settings.clientportal.ALL
(or)
Scope=ZohoCRM.settings.clientportal.READ
Parameters
- job_idinteger, mandatory
The ID of the job you received in the response of the Bulk Invite Users to a Portal API. When you do not include this parameter, the response will contain an array of all the jobs that were scheduled previously.
If you give an incorrect job_id, you will get an empty response(HTTP 204).
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v8/{personality_module}/actions/portal_invite"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Response JSON
- dataJSON array
Contains the following details. Note that the value of this key is "null" when the job is still in progress.
- detailsJSON object
The ID of the record in the personality module, to whom a portal invitation is sent.
- codestring
"SUCCESS" represents that an invitation is successfully sent. The value "CANNOT_PROCESS" indicates an error.
- messagestring
Represents whether an invitation was sent, a re-invite was sent or the error message.
- statusstring
The status of the invitation. "success" indicates that an invitation was sent, "error" indicates that an error has occurred.
- job_idstring
The ID of the job.
- statusstring
The status of the job. The possible values are "completed" and "in_progress"
Sample Response when job_id is sent
Copied{
"portal_invite": [
{
"data": [
{
"details": {
"id": "5020928000001843001"
},
"code": "SUCCESS",
"message": "An Invite has been sent to the personality.",
"status": "success"
}
],
"job_id": "5020928000002387017",
"status": "completed"
}
]
}
Sample Response when job_id is not sent
Copied{
"portal_invite": [
{
"data": [
{
"details": {
"id": "5020928000002121016"
},
"code": "SUCCESS",
"message": "An Invite has been sent to the personality.",
"status": "success"
}
],
"job_id": "5020928000002387005",
"status": "completed"
},
{
"data": [
{
"details": {},
"code": "CANNOT_PROCESS",
"message": "Invalid type for the portal invite",
"status": "error"
}
],
"job_id": "5020928000002387007",
"status": "completed"
},
{
"data": [
{
"details": {
"id": "5020928000002121016"
},
"code": "SUCCESS",
"message": "Invite has been resent to personality",
"status": "success"
}
],
"job_id": "5020928000002387013",
"status": "completed"
},
{
"data": [
{
"details": {
"id": "5020928000000621005"
},
"code": "SUCCESS",
"message": "An Invite has been sent to the personality.",
"status": "success"
},
{
"details": {
"id": "5020928000000606073"
},
"code": "SUCCESS",
"message": "An Invite has been sent to the personality.",
"status": "success"
},
{
"details": {
"id": "5020928000000544003"
},
"code": "SUCCESS",
"message": "An Invite has been sent to the personality.",
"status": "success"
},
{
"details": {
"id": "5020928000000523039"
},
"code": "SUCCESS",
"message": "An Invite has been sent to the personality.",
"status": "success"
}
],
"job_id": "5020928000002387021",
"status": "completed"
}
]
}
Show full
Show less
© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.