Apps

Invite a user

Changed on

Invite a user to this app by email via Clerk.

post/v1/apps/{app_id}/users/invite

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/apps/{app_id}/users/invite
  • Auth: HTTP bearer

Path parameters

app_idstring required

App ID

Request body

email_addressstring required

Email address to invite

rolestring

Clerk org role (org:admin or org:member)

Response

Successful Response

invitation_idstring required
email_addressstring required
rolestring required
statusstring required
created_atstring nullable

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional 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

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API