---
title: "Turn off a client invite"
method: DELETE
path: "/client-invites"
tags: ["Accounts"]
---

# Turn off a client invite

`DELETE /client-invites`

## Request

- Base URL: `https://www.sociahive.com/api/v1`
- URL: `https://www.sociahive.com/api/v1/client-invites`
- Auth: one of:
  - API key in header `X-API-Key`
  - OAuth 2 (authorization code, authorization URL `/api/oauth/authorize`, token URL `/api/oauth/token`, scopes: `accounts:write`)

The link stops working at once. Accounts it already added stay connected.

## Query parameters

- `invite_id` string, required: MongoDB ObjectId (24-character hex string)

## Response `200`

The turned-off invite

- object
  - `data` ClientInvite, required
    - `id` string, required: MongoDB ObjectId (24-character hex string)
    - `group_id` string, required: The account group the connected accounts land in.
    - `group_name` string
    - `platforms` string[], required
    - `max_accounts` integer, required
    - `used_account_ids` string[], required: Connected-account ids added through this invite.
    - `accounts` ClientInviteAccount[], required
      - `id` string, required: MongoDB ObjectId (24-character hex string)
      - `platform` string, required
      - `username` string
    - `url` string, uri: The signed public URL. Returned only by POST, once.
    - `state` string, required: Whether the link still adds accounts. Known values: `active`, `used_up`, `expired`, `revoked`. Treat any other value as unknown, never as an error.
    - `expires_at` string, date-time, required
    - `revoked_at` string, date-time
    - `created_at` string, date-time, required

## Other responses

- `400`: Bad request — invalid parameters
- `401`: Authentication required — provide X-API-Key or Bearer token
- `403`: Insufficient scope for this operation
- `404`: Invite not found
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/sociahive/apis/sociahive-api.md) · [All operations](https://skmtc.dev/sociahive/apis/sociahive-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sociahive/apis/sociahive-api/revisions/791b8548d288?raw)