Delete a Specific Account: /accounts/{account_id}

Purpose

This API permanently deletes an account identified by its unique ID. It removes the account from the system along with all directly associated data such as contacts, preferences, and configurations.

Use Case

Used when an administrator or automation system needs to remove a customer or organizational account from the database, such as in cases of account closure, data cleanup, or customer offboarding.

Path Parameters

Query Parameters

No query parameters required for this endpoint.

Request Body

No request body is required for this endpoint.

Response

This endpoint does not return a response body. Upon successful execution, the account is deleted and an HTTP 204 No Content status code is returned.

Delete a Specific Note for an Account: /accounts/{account_id}/notes/{note_uuid}

Purpose

This endpoint delete a specific note associated with an account by its unique note UUID. Once deleted, the note and any attached content will no longer be retrievable from the system.

Use Case

This endpoint is used when an account contains outdated, duplicated, or irrelevant note entries, this endpoint enables authorized users to remove that specific note. This is particularly useful for maintaining data hygiene, correcting mistakes, or removing notes that were added in error. Since notes can contain content or files, removing them ensures they are no longer accessible to internal or external viewers.

Path Parameters

Query Parameters

No query parameter is required for this endpoint.

Request Body

No request body is required for this endpoint.

Response

The response is empty, but the HTTP status code returned is 204 No Content, indicating that the note has been successfully deleted with no further content returned in the body.

Delete a Specific File of a Note for an Account: /accounts/{account_id}/notes/{note_uuid}/files/{file_uuid}

Purpose

This endpoint permanently delete a specific file that was previously attached to a particular note in an account. It ensures that irrelevant or outdated attachments can be removed to maintain clean and relevant note content.

Use Case

This endpoint used by the authenticate users to delete a specific file from a note without affecting the note’s text content or other attachments. An account note may contain one or more attached files, such as images, PDFs, or documents. Over time, some of these attachments may become outdated, irrelevant, or accidentally uploaded. 

Path Parameters

Delete a Specific Address for an Account: /accounts/{account_id}/addresses/{address_uuid}

Purpose

This API permanently removes a specific address associated with an account, identified by its UUID.

Use Case

Used when an address is no longer valid or relevant to the account, such as during user profile cleanup, address correction, or account data minimization.

Path Parameters

Query Parameters

No query parameters required for this endpoint.

Request Body

No request body is required for this endpoint.

Response 

The address is deleted successfully. The API returns an HTTP status code 204 No Content without any response body.

Delete a Specific Contact of a Specific Account: /accounts/{account_id}/contacts/{contact_type}

Purpose

This API permanently deletes a specific contact from an account, based on its type (billing, shipping).

Use Case

Used when a contact record (Billing Contact or Shipping Contact) is no longer required and should be removed from the account.

Path Parameters

Query Parameters

No query parameters required for this endpoint.

Request Body

No request body is required for this endpoint.

Response 

The contact is deleted successfully. The API returns an HTTP status code 204 No Content with no response body.

Delete a Specific Payment Method of an Account by Reference : /accounts/{account_id}/payment-methods/{payment_reference}

Purpose

This API endpoint delete a specific payment method from an account using its unique payment method reference. It ensures that outdated, invalid, or unwanted payment methods can be removed from the system to maintain accurate and secure billing data.

Use Case

This API is used when an account holder needs to remove a saved payment method, such as an expired credit card or a revoked bank account. It supports secure cleanup of payment data and ensures that only valid and active payment options remain associated with the account. 

Path Parameters

Query Parameters

No query parameters required for this endpoint.

Request Body

No request body is required for this endpoint.

Response

This endpoint does not return a response body. Upon successful execution, the payment method is deleted and an HTTP 204 No Content status code is returned.

Delete Profile Image of a Specific Account: /accounts/{account_id}/image

Purpose

This API deletes the image associated with a specific account. Once deleted, the account will no longer have an image stored in the system.

Use Case

• To remove outdated or incorrect images linked to an account.
• To reset the account image before uploading a new one.
• To ensure data compliance by removing sensitive or unwanted images.

Path Parameters

Query Parameters

This endpoint does not have any query parameters.

Request Body

No request body is required for this endpoint.

Response

This endpoint does not return a response body. Upon successful execution, the account is deleted and an HTTP 204 No Content status code is returned.