Turn off a client invite

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

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)

Query parameters

invite_idstring required

MongoDB ObjectId (24-character hex string)

Example:507f1f77bcf86cd799439011

Response

The turned-off invite

Example response

{
  "data": {
    "id": "507f1f77bcf86cd799439011",
    "group_id": "507f1f77bcf86cd799439011",
    "used_account_ids": [
      "507f1f77bcf86cd799439011"
    ],
    "accounts": [
      {
        "id": "507f1f77bcf86cd799439011"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.