---
title: "Create invites or requests"
method: POST
path: "/businesses/{business_id}/invites"
tags: ["business_access_invite"]
---

# Create invites or requests

`POST /businesses/{business_id}/invites`

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_type="MEMBER_INVITE"
    - business_role="EMPLOYEE" OR business_role="BIZ_ADMIN" (To learn more about business roles, visit
    https://help.pinterest.com/en/business/article/profile-permissions-in-business-access.)
    - members
- 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

## Path parameters

- `business_id` string, required

## Request body

- CreateMembershipOrPartnershipInvitesBody — Body to be used on path to send Members or Partners Invite or Request
  - `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.
  - `members` string[] — A list of usernames, emails, or a mix of them. Should be used if invite_type is MEMBER_INVITE
  - `partners` BusinessInviteOrPartnerId[] — A list of partner_id. Should be used if invite_type is PARTNER_INVITE or PARTNER_REQUEST

## Response `200`

The request has succeeded.

- CreateInvitesResultsResponseArray
  - `items` InviteActionResultItem[] — List of invite/request creation status. If there is an error, an exception object will be returned. If the action was successfully completed, an invite object will be returned.
    - `exception` InviteExceptionResponse, nullable — An exception object if there is an error performing the action. Will only be provided if there is an error.
      - `code` integer — Error code associated with the error in performing the action on the invite/request.
      - `invite_or_request_id` string, nullable — Unique identifier of the invite/request.
      - `message` string — Error message associated with the error in performing the action on the invite/request.
      - `users_or_partner_ids` string[] — A list of users' usernames or emails OR a list of partner ids that caused the error.
    - `invite` InviteBusinessRoleBinding, nullable — An invite object if the invite/request was successfully updated. Will only be provided if the an invite/request is successfully updated.
      - `created_by_business_id` string — Unique identifier for the business that created the invite/request.
      - `created_by_user_id` string — Unique identifier for the user that created the invite/request.
      - `id` string — Unique identifier of the invite/request.
      - `invite_data` InviteDataResponse — Metadata for the invite/request.
        - `invite_expiration` integer — The date and time when the invite/request will expire. Returned in milliseconds.
        - `invite_status` string — The current status of the invite. The invite can be in one of the following states PENDING, ACCEPTED, DECLINED, CANCELLED, EXPIRED.
        - `invite_type` string — The type of invite. - 'MEMBER_INVITE' is to invite a member to access your business assets. - 'PARTNER_INVITE' is to invite a partner to access your business assets. - 'PARTNER_REQUEST' is to request access a partner's business assets.
        - `last_updated_time` integer — The date and time the invite/request was last updated. Returned in milliseconds.
        - `sent_at` integer — The date and time the invite/request was sent/created. Returned in milliseconds.
      - `is_received_invite` boolean — Indicates whether the invite/request was received.
      - `user` BusinessAccessUserSummary — Metadata of the member/partner that has access to the asset.
        - `email` string, nullable — Email of the business member/partner.
        - `id` string, nullable — Unique identifier of the business member/partner.
        - `username` string, nullable — Username of the business member/partner.

## Other responses

- `201` — Resource create operation completed successfully.
- `400` — The request could not be understood by the server due to unexpected data.
- `401` — Authentication is required and has either failed or not been provided.
- `403` — The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource.
- `404` — The requested resource could not be found on this server.
- `429` — The user has sent too many requests in a given amount of time and is being rate limited.
- `default` — An unexpected error response.

---

[API](https://skmtc.net/pinterest/apis/pinterest-rest-api.md) · [All operations](https://skmtc.net/pinterest/apis/pinterest-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pinterest/pinterest-rest-api/revisions/b698c180678a/schema)