批量邀请工作状态
目的
获取邀请用户批量加入门户的工作状态。
端点
- GET /{personality_module}/actions/portal_invite
Request 详情
Request URL
{api-domain}/crm/{version}/{personality_module}/actions/portal_invite
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.settings.clientportal.ALL
(or)
Scope=ZohoCRM.settings.clientportal.READ
参数
- job_idinteger, mandatory
您在批量邀请用户到门户API的响应中收到的工作ID。当您不包含此参数时,响应将包含所有以前安排的工作的数组。
如果您提供了错误的job_id,您将得到一个空的响应(HTTP 204)。
样本请求
Response JSON
- 数据JSON 数组
包含以下详细信息。请注意,当任务仍在进行中时,此键的值为 "null"。
- 详细信息JSON 对象
在个性模块中记录的ID,向其发送门户邀请。
- 代码字符串
"SUCCESS" 表示邀请已成功发送。值 "CANNOT_PROCESS" 表示出现错误。
- 消息字符串
表示是否发送了邀请,是否重新发送了邀请,或者错误消息。
- 状态字符串
邀请的状态。"success" 表示已发送邀请,"error" 表示发生了错误。
- job_idstring
The ID of the job.
- 状态字符串
工作的状态。可能的值是"已完成"和"进行中"