Deletes a bot user and invalidates all associated OAuth clients and tokens.

Usage Example

DELETE /api/v1/auth/bots/bot-abc123
Authorization: Bearer {access_token}

Success Response:

HTTP/1.1 204 No Content

⚠️ Important Side Effects

Deleting a bot user will immediately:

  1. Invalidate all OAuth clients associated with this bot user
  2. Revoke all access tokens issued to those clients
  3. Terminate all active API sessions using those tokens
  4. Stop all webhook deliveries configured for those clients

This action is immediate and cannot be undone.

Best Practices

Before deleting a bot user:

  • Verify the integration is no longer needed
  • Notify stakeholders about the decommission
  • Remove bot user from any external system references
  • Consider rotating credentials instead of deletion for temporary disablement

Alternative: Disable Instead of Delete

If you need to temporarily disable an integration:

  1. Delete the associated OAuth client instead: DELETE /api/v1/auth/clients/{clientId}
  2. This preserves the bot user for future re-enablement
  3. Create a new client when ready to re-enable: POST /api/v1/auth/clients
Path Parameters
  • id
    Type: string
    required

    The unique identifier of the bot user to delete

Responses
  • 204

    Bot user deleted successfully

  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for delete/api/v1/auth/bots/{id}
curl 'https://app.propstreet.com/api/v1/auth/bots/{id}' \
  --request DELETE \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
No Body