All URIs are relative to https://api.clerk.dev/v1
| Method | HTTP request | Description |
|---|---|---|
| create_invitation | POST /invitations | Create an invitation |
| list_invitations | GET /invitations | List all invitations |
| revoke_invitation | POST /invitations/{invitation_id}/revoke | Revokes an invitation |
crate::models::Invitation create_invitation(create_invitation_request) Create an invitation
Creates a new invitation for the given email address and sends the invitation email. Keep in mind that you cannot create an invitation if there is already one for the given email address. Also, trying to create an invitation for an email address that already exists in your application will result to an error.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| create_invitation_request | Option<CreateInvitationRequest> | Required parameters |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Veccrate::models::Invitation list_invitations(status) List all invitations
Returns all non-revoked invitations for your application, sorted by creation date
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| status | Option<String> | Filter invitations based on their status |
Veccrate::models::Invitation
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::Invitation revoke_invitation(invitation_id) Revokes an invitation
Revokes the given invitation. Revoking an invitation will prevent the user from using the invitation link that was sent to them. However, it doesn't prevent the user from signing up if they follow the sign up flow. Only active (i.e. non-revoked) invitations can be revoked.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| invitation_id | String | The ID of the invitation to be revoked | [required] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]