Skip to main content

Remove Account

POST 

/accounts/:id/remove

Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation.

This endpoint is good for:

  • Removing accounts that no longer exist on the source.
  • Removing accounts that won't be aggregated following updates to the source configuration.
  • Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc.

Request

Path Parameters

    id stringrequired

    The account id

    Example: c350d6aa4f104c61b062cb632421ad10

Responses

Accepted. Returns task result details of removal request.

Schema

    type string

    Possible values: [TASK_RESULT]

    Task result DTO type.

    id string

    Task result ID.

    name stringnullable

    Task result display name.

Loading...