Accounts

Make a client invite

Works for 7 days or until turned off. The response carries the URL, once. Each connected account counts toward your plan's account limit; an account already connected to another SociaHive user is refused. At most 20 open invites (409 too_many_invites).

post/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)

Request body

group_idstring required

MongoDB ObjectId (24-character hex string)

platformsstring[]

Default: all five.

max_accountsinteger

Default 5.

Example request

{
  "group_id": "507f1f77bcf86cd799439011"
}

Response

The new invite, with its URL

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.