Partner invite / Expire

post

https://{tenantUrl}/public-api/actions/partner-invite/v1.0/{partnerInvite}/expire

Expire a pending, sent or accepted partner invite now. The invite gets the expired status with the expire_action expiry cause, and the user loses the invite's benefits immediately. Sessions already in progress aren't affected.

Operator and global tokens can send a churn reason in the body. The reason is recorded with the expiry and isn't part of the partner invite.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202The invite expired. The message is "The invite expired.".

401Access token is missing or invalid

403You do not have permission to perform the action. When the organisation of the admin behind the token has view-only access, every write is refused with the message "Your access is view-only."

404The record is not found

409The invite is already expired. Nothing is changed.

422The payload you provided is invalid

429Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*