Skip to content
MothershipDevelopers

API referenceUsers

Revoke a pending invite

Revokes a pending invite, so its link stops working and the person can't join with it. It can't be undone; invite them again to send a new email. An invite that was already accepted can't be revoked. Requires the organization:user.create permission.

DELETE/users/invites/{inviteId}
Environment
https://sandbox.api.mothership.com/beta
curl --request DELETE \
  --url 'https://sandbox.api.mothership.com/beta/users/invites/inviteId' \
  --header "Authorization: Bearer $MOTHERSHIP_API_TOKEN" \
  --header 'Accept: application/json'
Reads your token from $MOTHERSHIP_API_TOKEN
Response
{
: {
: "3f1c2a9e-5b7d-4e8a-9c61-2d4f8b0e7a15",
: "logistics@example.com",
: "Dana",
: "Reyes",
: "manager",
: "2026-03-19T17:00:00.000Z",
: "2026-03-19T17:00:00.000Z",
: true
}
}

Hover a key to see what it means. Click it to jump to the field.

Authorization

Authorization: Bearer <token>

Your sandbox API token. See Authentication.

Path parameters

  • inviteIdstringRequired

    ID of the pending invite, from List pending invites

Responses

    • dataobjectRequired
      • idstringRequired

        ID of the invite

      • emailstringRequired

        Email address the invite was sent to

      • firstNamestringRequired
      • lastNamestringRequired
        nullable
      • rolestringRequired

        Role the person gets once they accept the invite. manager: Manage all features for your organization. shipper: Book shipments. Read-access to other features. accountant: Manage and edit billing. View-only for other features. viewer: View-only account access. Nobody is invited as an owner.

        managershipperaccountantviewer
      • createdAtstring<date-time>Required

        When the invite was sent

      • expiresAtstring<date-time>Required

        When the invite link stops working

      • expiredbooleanRequired

        True when the invite link has expired. The person can't accept it; revoke it and invite them again.