Delete Invite by ID

Prev Next
Delete
/api/v1/removeInvite/{_id}

Deletes an invite from the workspace.

Permission required: create-invite-links

Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Path parameters
_id
stringRequired

The invite ID to be deleted.

ExamplekDKQ3H
Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
400

Bad Request

Invalid Invitation Id
{
  "success": false,
  "error": "Invalid Invitation _id [invalid-invitation-id]",
  "errorType": "invalid-invitation-id",
  "details": {
    "method": "removeInvite"
  }
}
Expand All
object
success
boolean
error
string
errorType
string
details
object
method
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string