批量邀请用户到门户
目的
要批量邀请用户到门户。此 API 会安排一个作业。使用 获取Status API 来获取已安排作业的Status。
端点
- POST /{personality_module}/actions/portal_invite
请求详情
请求 URL
{api-domain}/crm/{version}/{personality_module}/actions/portal_invite
其中,personality_module 是为其创建门户的模块的 API 名称
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.settings.clientportal.ALL
(或)
Scope=ZohoCRM.settings.clientportal.CREATE
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Contacts/actions/portal_invite"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"输入 JSON
当您批量邀请用户到门户时,将在后台安排一个任务。使用获取Status API 来获取已安排任务的Status。
- data JSON array, mandatory
包含以下详细信息:
- id string, mandatory
您想邀请到门户的用户的记录ID。
- user_type_id string, mandatory
您要为此用户分配的用户类型ID。请使用获取用户类型API来获取此ID。
- type string, mandatory
表示用户是第一次被邀请还是再次被邀请。可能的值是invite和reinvite。
- language string, optional
您想邀请到门户的用户的语言代码。默认值是en_US。支持的值有 "en_US", "en_GB", "bg_BG", "zh_CN", "zh_TW", "hr_HR", "ar_EG", "in_ID", "cs_CZ", "da_DK", "nl_NL", "fr_FR", "de_DE", "hu_HU", "hi_IN", "it_IT", "ja_JP", "pl_PL","pt_BR", "pt_PT", "ru_RU", "es_ES", "sv_SE", "th_TH", "tr_TR", "vi_VN", "ko_KR", 和 "iw_IL"。
示例输入
Copied{
"portal_invite": [
{
"data": [
{
"id": "5020928000002121016",
"user_type_id": "5020928000000523003",
"type": "invite",
"language": "en_US"
}
]
}
]
}可能的错误
- MANDATORY_NOT_FOUNDHTTP 400
您在输入中未指定一个或多个必需的键。
解决方法:请参阅错误响应中的 "details" 键,了解缺少的内容并将其包含在请求中。 - INVALID_DATAHTTP 400
输入包含无效数据。
解决方法:请参阅错误响应中的 "details" 键,以了解输入中不正确部分的 api_path 和 json_path。 - INVALID_REQUEST_METHODHTTP 400
您指定了错误的 HTTP 请求方法。
解决方法:您必须使用 HTTP 请求方法 POST 来使用此 API。 - NO_PERMISSIONHTTP 403
您没有权限邀请用户加入门户。
解决方法:请联系您的管理员。
示例响应
Copied{
"portal_invite": [
{
"code": "SUCCESS",
"details": {
"record_id": "3652397000000388085"
},
"message": "An Invite has been sent to the personality.",
"status": "success"
}
]
}