Delete Customer Address

The Payiano's delete customer address endpoint allows businesses to remove outdated or incorrect addresses from their records. This helps maintain a clean and accurate address book, ensuring deliveries and communications are not sent to invalid locations, which reduces confusion and operational waste.

Removing obsolete addresses is also essential for complying with data privacy regulations, demonstrating that the business respects customer personal information and is committed to keeping their data secure. Use the restore endpoint to reinstate a previously deleted address.

DELETE/client/customer_addresses/{customer_address_id}

Sandbox: https://api.payiano.dev/v1/client/customer_addresses/{customer_address_id}

Live: https://api.payiano.com/v1/client/customer_addresses/{customer_address_id}

Security

Authorization header with access token is required to access this endpoint: Bearer ACCESS-TOKEN
Your access token should be associated to this permission client.customer_addresses.delete

Request

Request body schema:

application/json

Path parameters:

customer_address_id

required

customer_address_id

required

Type: ulid

Length: 26

The unique ID assigned to each customer address which is generated by our system using the ULID format. Each ID is precisely 26 characters long, ensuring a unique and consistent identifier for every customer address. This ULID is automatically created by our system and is used to uniquely identify and track each customer address in our database.

Query parameters:

identify_by

Type: enum|null

Possible values:

JSON

[ "id", "reference_id" ]

This attribute specifies which identifier is being used to interact with a resource in the Payiano API. It helps the system understand how to identify resource when processing API requests. By default, the identify_by attribute is set to id, so you only need to specify it if you're using a different identifier.

force_delete

Type: boolean

Default: false

This attribute determines the deletion method to be applied to the customer address delete in the database. When the value is set to true, it indicates that the customer address should be permanently and irreversibly removed from the database, commonly known as a Hard Delete. If the value is set to false, it implies a Soft Delete approach, where the customer address is not physically removed from the database. With Soft Delete it's still possible to restore the customer address record.

Response

200

Response schema:

application/json

Response body:

status

Type: boolean

This value indicates whether the customer address delete was successful or not.

Response sample: