Skip to content
Avara
Get started
API Reference
Auto Scribe
Users
Invitations

Revoke an invitation

InvitationRevokeResponse autoScribe().users().invitations().revoke(InvitationRevokeParamsparams = InvitationRevokeParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
post/v1/autoScribe/users/invitations/revoke

Revokes a pending invitation, preventing it from being accepted. Can revoke by invitation ID, user ID, or both. Useful for cancelling invitations sent in error.

ParametersExpand Collapse
InvitationRevokeParams params
Optional<String> invitationId

Invitation ID to revoke. Format: inv_{32-hex-chars}

Optional<String> userId

User ID whose pending invitation to revoke. Format: usr_{32-hex-chars}

ReturnsExpand Collapse
class InvitationRevokeResponse:

Response for revoking an invitation in AutoScribe

boolean success
Optional<String> message
Revoke an invitation
package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.autoscribe.users.invitations.InvitationRevokeParams;
import com.avara.models.autoscribe.users.invitations.InvitationRevokeResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        InvitationRevokeResponse response = client.autoScribe().users().invitations().revoke();
    }
}
{
  "success": true,
  "message": "message"
}
Returns Examples
{
  "success": true,
  "message": "message"
}