Revoke an invitation

To revoke or delete an invitation sent by Invitation Service, please use the following API call. Once an invitation has been withdrawn, it cannot be found using the find an invitation workflow.

An invitation either expired or active, will be permanently deleted using this API call (with no purge period retention). If an expired invitation is cancelled, entitlement_roles if any associated with the invitation will be removed from Entitlements.

A confirmation email will be sent from no-reply@account.stage.utilities.trimblecloud.com.

Request

DELETE {base URL}/invitation/{invitation_id}

• HEADER:

  • Include TID OAuth Bearer token for your application

  • Add a Content-Type of application/JSON.

• Parameters:

  • webhook_secret_token = Must match the configured secret for the invitation_id

  • send_email = Notify the invitee that an invitation has been canceled. Default value is false.

  • message = Message sent to end-user detailing why the invitation was canceled. Default value is ”.

    Example: You previously received an invitation to join {Product}. This invitation has been canceled.

An email will only be sent if send_email = true.

Example request body:

{
    "custom_templates": {
        "cancelled": {
            "template_id": "template_id_3",
            "variables": {
                "variable_1": "value_1","variable_2": "value_2"
            }
        }
    }
}

Example email: