API Reference

/{connector_id}/deactivate_account

post
https://example.com//deactivate_account

Deactivate an existing user account in the integration system.

This operation depends on the connector-specific concept of activation/deactivation. Different systems may handle deactivation differently - some may disable login, others may revoke permissions while preserving the account, etc.

The account remains in the system but is made inactive according to the connector's capabilities.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
auth
object

Authentication credentials, which can be one of several types.

credentials
array of objects
credentials
request
object
required

Request parameters for deactivating an account

boolean

Whether to include raw data in the response.

page
object

Pagination parameters for requests and responses.

settings
object

Connector-specific settings for the request.

These are settings that are shared across all capabilities.

Usually contain additional required configuration options not specified by the capability schema.

Response

Updated 11 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago