Sign in

v29

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-06-042661,1122.5 MB
business_access_invite

Create invites or requests

Create batch invites or requests. Can create batch invites or requests as described below.

  • Invite members to join the business. This would required specifying the following:
  • Invite partners to access your business assets. This would require specifying the following:
    • invite_type="PARTNER_INVITE"
    • business_role="PARTNER"
    • partners
  • Request to be a partner so you can access their assets. This would require specifying the following:
    • invite_type="PARTNER_REQUEST"
    • business_role="PARTNER"
    • partners
post/businesses/{business_id}/invites

Path parameters

business_idstring required

Unique identifier of the requesting business.

Request body

business_role'EMPLOYEE' | 'BIZ_ADMIN' | 'PARTNER' required

The business access level to grant member/partner. Note, values are case-sensitive.

  • EMPLOYEE: Can only view and access assets you assign them to. They cannot see details about other employees, partners, or other assets.
  • BIZ_ADMIN: Have full control of roles and can add employees and partners as well as grant asset access.
  • PARTNER: Can only view and access assets you assign them to/or they assign to you.
invite_type'MEMBER_INVITE' | 'PARTNER_INVITE' | 'PARTNER_REQUEST' required

The type of invite. MEMBER_INVITE invites a member to access your business assets. PARTNER_INVITE invites a partner to access your business assets. PARTNER_REQUEST requests access to a partner's business assets.

membersstring[]

A list of usernames, emails, or a mix of them. Should be used if invite_type is MEMBER_INVITE

partnersBusinessInviteOrPartnerId[]

A list of partner_id. Should be used if invite_type is PARTNER_INVITE or PARTNER_REQUEST

Example request

{
  "invite_type": "MEMBER_INVITE",
  "members": [
    "business0101",
    "user@business.com"
  ],
  "partners": [
    "809944451643622187",
    "766456567741825556"
  ]
}

Response

The request has succeeded.

Example response

{
  "items": [
    {
      "exception": {
        "code": 403,
        "invite_or_request_id": "383791336903426391",
        "message": "You hit the maximum number of pending invites allowed.",
        "users_or_partner_ids": [
          "businessMember0101",
          "business+member@business.com"
        ]
      },
      "invite": {
        "created_by_business_id": "1234567890123",
        "created_by_user_id": "1234567890123",
        "id": "383791336903426391",
        "user": {
          "email": "business0101@business.com",
          "id": "549755885175",
          "username": "business0101"
        }
      }
    }
  ]
}