---
title: "Cancel invites/requests"
method: DELETE
path: "/businesses/{business_id}/invites"
tags: ["business_access_invite"]
---

# Cancel invites/requests

`DELETE /businesses/{business_id}/invites`

## Request

- Base URL: `https://api.pinterest.com/v5`
- URL: `https://api.pinterest.com/v5/businesses/{business_id}/invites`
- Auth: OAuth 2
  - Authorization code: `https://www.pinterest.com/oauth/`
  - Token URL: `https://api.pinterest.com/v5/oauth/token` scopes: `biz_access:write`
- TypeScript: <https://skmtc.dev/pinterest/apis/pinterest-rest-api/docs/businesses/:business_id/invites/delete.ts> (a function with typed inputs; its response is checked against the schema)

Cancel membership/partnership invites and/or requests.

## Path parameters

- `business_id` string, required

## Request body

- CancelInvitesRequest: An object with the list of invite/request ids to cancel.
  - `invite_ids` BusinessInviteOrPartnerId[], required: A list of invite/request ids to cancel.

## Response `200`

The request has succeeded.

- CancelInvitesResponse
  - `items` CancelInviteResultItem[]
    - `exception` CancelInviteException, nullable: An exception object if there is an error performing the cancellation. It will only be provided if there is an error.
      - `invite_id` string
      - `message` string
    - `invite` CancelInviteResult, nullable
      - `id` string
      - `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
      - `user` CancelInviteResultUser: Metadata of the member/partner that has access to the asset.
        - `email` string: Email of the business member/partner.
        - `id` string: Unique identifier of the business member/partner.
        - `username` string: Username of the business member/partner.

## Other responses

- `default`: An unexpected error response.

## Changes

- **2026-06-04** (v5) `b698c180678a`: 4 info
  - added the optional property `items/items/invite/user/email` to the response with the `200` status
  - added the optional property `items/items/invite/user/id` to the response with the `200` status
  - added the optional property `items/items/invite/user/username` to the response with the `200` status
  - removed `#/components/schemas/BusinessAccessUserSummary` from the `items/items/invite/user` response property `allOf` list for the response status `200`
- **2024-04-23** (v5) `f9321315766f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pinterest/apis/pinterest-rest-api/changes/businesses/:business_id/invites/delete.md)

---

[API](https://skmtc.dev/pinterest/apis/pinterest-rest-api.md) - [All operations](https://skmtc.dev/pinterest/apis/pinterest-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pinterest/apis/pinterest-rest-api/revisions/b698c180678a?raw)