Invites

Invite a teammate

Changed on

Sends an invitation email to the address. Returns 201 with the new invite. If the address already has an invite in this organization, no second invite is created: the existing one is resent and returned with 200, keeping its original role. A revoked or rejected invite is reinstated as pending. An address that already accepted its invite is a member, so this returns 409.

post/v1/org/{org_id}/invites

Request

  • Base URL
    https://api.archera.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.archera.ai/v1/org/{org_id}/invites
  • Auth
    none declared

Request body

emailstring email required

Address to send the invitation email to

role'user' | 'admin' | 'support' | 'cloud_rep' | 'restricted_user'

Role to grant on acceptance. Defaults to the organization's default role. Ignored when the address already has an invite.

Response

OK

org_idstring required

Organization the invite belongs to

emailstring required

Address the invite was sent to, and its identifier in this API

role'user' | 'admin' | 'support' | 'cloud_rep' | 'restricted_user' required

Role the invitee holds in the organization

status'invited' | 'accepted' | 'rejected' | 'revoked' required

'invited' is pending; 'accepted', 'rejected' and 'revoked' are final

invited_bystring nullable required

Email of the user who sent the invite

created_atstring date-time required

When the invite was first created

Changes

  • 8b1de9447803Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 3a24a8454a72Revision changes
    • info

      endpoint added