Skip to main content

Delete Organization Invitation

DELETE https://infrahub-api.nexgencloud.com/v1/auth/invites/{id}​

Deletes an invitation for a user to join your organization. Include the ID of the invitation to be deleted in the path. You can obtain the IDs of outstanding invitations by calling the List Organization Invites endpoint.


Path parameters​

id integer   Required​

The ID of the invitation to be deleted.


Attributes​

status boolean​

Indicates the status of the request to delete an organization invitation, true indicates success, while false indicates error.

message string​

A message describing the status of the request to delete an invitation.

Example request
curl -X DELETE "https://infrahub-api.nexgencloud.com/v1/auth/invites/{id}" \
  -H "accept: application/json"\
  -H "api_key: YOUR API KEY"
Response
{
    "status": true,
    "message": "Invite deleted successfully"
}

Returns​

A status of true indicates that the invitation has been successfully deleted. In case of an error, refer to our documentation on handling errors here.


Back to top​