organizationUserInvitations

Revoke a pending invitation

Revokes an invitation that has not been accepted. Only invitations belonging to the authenticated organization can be revoked; any other id is reported as not found.

delete/v1/organization-user-invitations/{invitation_id}

Request

  • Base URL: https://api.vitablehealth.com
  • URL: https://api.vitablehealth.com/v1/organization-user-invitations/{invitation_id}
  • Auth: HTTP bearer

Path parameters

invitation_idstring required

Identity-provider invitation id

Headers

X-Vitable-Organizationstring

Organization to act as for this request (e.g. org_SGVsbG8gV29ybGQ). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 organization_required. A malformed value returns 400 invalid_organization_header, and naming an organization you do not have access to returns 403 organization_access_denied.

Response

Invitation revoked.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.