Zoho crm Logo

邀请用户加入门户网站

目的

邀请用户加入门户。

端点

  • POST /{personality_module}/{record_id}/actions/portal_invite

请求详情

请求 URL

{api-domain}/crm/{version}/{personality_module}/{record_id}/actions/portal_invite
其中, personality_module 是创建门户的模块的 API 名称
record_id 是您想邀请到门户的记录 ID

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

scope=ZohoCRM.settings.clientportal.ALL
(或)
Scope=ZohoCRM.settings.clientportal.CREATE

参数
  • user_type_id integer,mandatory

    您想要分配给此USer的USer类型的ID。请使用获取USer类型API来获取此ID。

  • type string,mandatory

    表示USer是第一次被邀请还是重新邀请。可能的值是invite和reinvite。

  • language string,optional

    您想要邀请到门户的USer的语言代码。默认值是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"。

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/Contacts/3652397000000388085/actions/portal_invite?user_type_id=3652397000006231003&type=invite&language=en_US"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

可能的错误

  • REQUIRED_PARAM_MISSINGHTTP 400

    您未指定一个或多个必需的参数。
    解决方案: "type" 和 "user_type_id" 是必需的参数。请参阅错误响应中的 "details" 键以了解缺少的内容,并将其包含在请求中。

  • DUPLICATE_DATAHTTP 400

    您发送的邀请失败,因为已有使用相同电子邮件ID的门户用户。
    解决方案:邀请正确的用户加入门户。

  • INVALID_DATAHTTP 400

    原因:

    • 语言代码无效。
    • 您发送的邀请失败,因为用户不是客户或顾客。
    • user_type_id 无效。
    • 个性模块的记录 ID 无效。

    解决方案:

    • 请参阅“输入 JSON”部分中的“language”键以获取允许的语言代码。
    • 仅邀请客户或顾客到此用户类型,而不是您域中的用户。
    • 指定正确的 user_type_id。
    • 指定个性模块记录的正确记录 ID。使用 获取记录 API 获取此 ID。
  • NOT_REVIEWEDHTTP 400

    由于记录正在审核过程中,您无法发送门户邀请。
    解决方案:请发送邀请至已批准的记录,或等待此记录完成审核过程。

  • NOT_APPROVEDHTTP 400

    您尝试邀请的用户记录尚未批准。
    解决方案:请联系您的管理员以批准该记录。

  • CANNOT_PROCESSHTTP 400

    您尝试邀请的用户已经被邀请或记录正在进行GDPR处理。
    解决方案:使用reinvite值作为"type"参数来重新邀请用户。

  • LICENSE_LIMIT_EXCEEDEDHTTP 400

    您已超出门户用户许可证限制。
    解决方案:联系 support@zohocrm.com 购买更多用户许可证。

  • RECORD_LOCKEDHTTP 400

    您无法执行此操作,因为记录已被锁定。
    解决方案:请等待记录解锁。

  • NO_PERMISSIONHTTP 403

    您没有该模块的权限。
    解决方法:请联系您的管理员。

示例响应

Copied{
  "portal_invite": [
    {
      "code": "SUCCESS",
      "details": {
        "record_id": "3652397000000388085"
      },
      "message": "An Invite has been sent to the personality.",
      "status": "success"
    }
  ]
}