Organization invitations

Update organization invitation status

Changed on

Update the status of an organization invitation by ID.

put/api/organization-invitations/{id}/status

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/organization-invitations/{id}/status
  • Auth: OAuth 2 (client credentials, token URL /oidc/token, scopes: all)

Path parameters

idstring required

The unique identifier of the organization invitation.

Request body

acceptedUserIdstring nullable

The ID of the user who accepted the organization invitation. Required if the status is "Accepted".

status'Accepted' | 'Revoked' required

The status of the organization invitation.

Response

The organization invitation status was updated successfully.

tenantIdstring required
idstring required
inviterIdstring nullable required
inviteestring required
acceptedUserIdstring nullable required
organizationIdstring required
status'Pending' | 'Accepted' | 'Expired' | 'Revoked' required
createdAtnumber required
updatedAtnumber required
expiresAtnumber required

Changes

  • f6be196bc327Revision changes
    • breaking

      the response property's maxLength was increased from 21 to 128 for the response status

    • breaking

      the response property's maxLength was increased from 21 to 128 for the response status

    • info

      the request property's maxLength was increased from 21 to 128