Members

Invite someone to a site by email

Gives one person access to this one site as an editor or viewer. They get an email with a link that is good for 7 days; accepting needs a signed-in account on the invited address (acceptInvite). Inviting an address that already has a pending invite re-sends it as a fresh one instead of adding a second.

Adding collaborators needs the site's team add-on (402 upgrade_required without it), and a site holds at most 20 collaborators and pending invites together. Needs the site Owner role.

post/api/v1/sites/{slug}/members/invites

Request

  • Base URL: https://api.dotsy.ai
  • URL: https://api.dotsy.ai/api/v1/sites/{slug}/members/invites
  • Auth: HTTP bearer

Path parameters

slugstring required
Example:acme-studio

Site slug or site id (UUID). An old slug answers 301/308 and a site id 307 to the canonical slug path.

Request body

emailstring email required

Who to invite.

role'editor' | 'viewer' required

editor can edit content and publish. viewer can only look.

isInternalboolean

Mark the person as inside your own organization rather than an outside guest. Default false.

Example request

{
  "email": "grace@example.com"
}

Response

The invite.

idstring required
emailstring required

Lowercased.

role'editor' | 'viewer' required
isInternalboolean required
expiresAtnumber required

Invites last 7 days. Unix ms.

tokenstring required

The raw invite token. It is shown once and never stored.

invitePathstring required

Dashboard path the invited person opens to accept.

emailSentboolean required

True when an email was sent. False when email is not configured on this server, so share invitePath yourself.

Example response

{
  "invitePath": "/invite/ONQ4GKMQYmbfppENWARDX"
}

Changes

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