> ## Documentation Index
> Fetch the complete documentation index at: https://www.bloxs.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Remove a bankaccount from an estate agent
> Remove an existing bank account from an estate agent.
## OpenAPI
````json DELETE /api/v1/relations/estateAgents/bankaccounts
{
"openapi": "3.0.4",
"info": {
"title": "Relations V1",
"description": "# Relation API Documentation\n\nWelcome to the Relationship Management API documentation. This API allows you to perform CRUD operations on various relationship types, including Owners, Persons, Suppliers, Estate Agents, and Organisations. \n\n## Authentication \n\nTo access the API, include your API key in the headers. Refer to our authentication documentation for details on obtaining and using your API key. \n\n## CRUD Operations \n\nThe API supports CRUD operations for the following relationship types: \n\n- **Owners**\n- **Persons**\n- **Suppliers**\n- **Estate Agents**\n- **Organisations**\n\nFor each relationship type, you can: \n\n- **GET**: Retrieve a list or apply filters.\n- **POST**: Add a new entry.\n- **PUT**: Update existing details.\n- **PATCH**: Apply partial updates.\n- **DELETE**: Remove an entry.\n\nThank you for choosing our Relation API. If you have any questions or need assistance, please contact our support team. \n",
"version": "v1"
},
"security": [
{}
],
"tags": [
{
"name": "Common"
},
{
"name": "CommunicationFormAPI"
},
{
"name": "EstateAgentAPI"
},
{
"name": "Metadata"
},
{
"name": "OrganisationAPI"
},
{
"name": "OwnerAPI"
},
{
"name": "PersonAPI"
},
{
"name": "RelationTypeAPI"
},
{
"name": "SupplierAPI"
},
{
"name": "SupplierTypeAPI"
}
],
"paths": {
"/api/v1/relations/estateAgents/bankaccounts": {
"delete": {
"tags": [
"Relations"
],
"summary": "Remove a bankaccount from an estate agent",
"description": "Remove an existing bank account from an estate agent.",
"operationId": "RemoveEstateAgentBankAccount",
"parameters": [
{
"name": "reference",
"in": "query",
"description": "The internal identifier of the model (i.e. Reference, Code, Name, depends on model).",
"schema": {
"type": "string"
}
},
{
"name": "externalIdentifier",
"in": "query",
"description": "The external API identifier of the model.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteBankAccount"
}
}
}
},
"responses": {
"200": {
"description": "The bank account was removed from the estate agent"
},
"400": {
"description": "The bank account data has validation issues",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorMessageModel"
}
}
}
}
},
"x-d360-narrative-url": "Remove a Bank Account from an EstateAgent
Removes an existing bank account from an estate agent's record.
A developer calls this endpoint to delete a bank account that is no longer valid or in use, for example after an estate agent closes an account or provides updated bank account details.
The estate agent is located via reference or externalIdentifier, at least one of which must be supplied.
The bank account itself is identified by bankAccountNumber, which must match an account already registered for the estate agent. An account currently marked as preferred can only be removed if it is the estate agent's only bank account; if other accounts exist, another account must first be made preferred (via Add a Bank Account or Update a Bank Account), which automatically transfers the preferred status, before the original account can be removed.
Request Fields
Field | Type | Required | Description |
|---|
reference | string | Required (at least one of reference or externalIdentifier must be given) | The internal identifier (Reference/Code) of the estate agent whose bank account should be removed. |
externalIdentifier | string | Required (at least one of reference or externalIdentifier must be given) | The external API identifier of the estate agent whose bank account should be removed. |
bankAccountNumber | string, max 34 | Required | The bank account number identifying which existing account to remove. Must match an account already registered for the estate agent; if it does not, the request fails with an error stating the bank account was not found. If the account is marked preferred and other bank accounts exist for the estate agent, the request will fail and show an error. If the account is marked preferred but is the estate agent's only bank account, removal will succeed, leaving the estate agent with no bank accounts. |
Response Fields
This endpoint returns no response body on success. A 200 response confirms the bank account was removed from the estate agent.
Field | Type | Required | Description |
|---|
(none) | | | No fields are returned on success. |