Control

Changed on
post/v1/applications/{application_id}/invitations

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /v1/applications/{application_id}/invitations
  • Auth: HTTP bearer

Request body

hosted_client_idstring uuid
hosted_redirect_uristring uri
emailstring email required
workspace_idstring uuid
application_role_keysstring[]
workspace_role_keysstring[]
onboarding_method'email' | 'google' | 'apple' | 'microsoft' | 'facebook' | 'linkedin'
expires_ininteger

Response

Invitation created and email queued

hosted_client_idstring uuid nullable
hosted_redirect_uristring nullable
idstring uuid required
application_idstring uuid required
workspace_idstring uuid nullable
emailstring email required
application_role_keysRoleKey[]
workspace_role_keysRoleKey[]
onboarding_method'email' | 'google' | 'apple' | 'microsoft' | 'facebook' | 'linkedin' required
status'pending' | 'accepted' | 'revoked' | 'expired' required
codestring
link_tokenstring
linkstring uri
expires_atstring date-time required
accepted_user_idstring uuid nullable
created_atstring date-time

Changes

  • 3dd88584c2e4Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 54aa0701214bRevision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status