SCscanopy
Invites

Create invite

Changed on
post/api/v1/invites

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/invites
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Request body

expiration_hoursinteger nullable

How long the invite stays valid, in hours.

permissions'Owner' | 'Admin' | 'Member' | 'Viewer' required
send_tostring nullable

Address to email the invite to. Omit to create a link without sending.

site_idsstring[] required

The sites this entity applies to.

Response

Invite created

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes

  • a6ea2ab6fbb9Revision changes
    • breaking

      added the new required request property

    • breaking

      removed the required property ///// from the response with the status

    • warning

      removed the request property

    • info

      added the required property ///// to the response with the status

  • b1cea2733fefRevision changes
    • info

      added the non-success response with the status