Delete Customer Tag

The Payiano Delete Customer Tag endpoint removes a tag from the company's tag catalog. By default, the operation performs a soft delete, meaning the tag record is marked as deleted and hidden from standard list and autocomplete queries but can be recovered at any time using the Restore Customer Tag endpoint. This approach provides a safety net against accidental deletion while still allowing the tag to be effectively removed from active use across customer assignment and filtering workflows without permanently losing the record.

To permanently remove a tag record and prevent future restoration, include the force query parameter in the request. A force-deleted tag cannot be recovered, and all customer-tag associations referencing it will be severed. Use this option only when the tag and its associations are no longer needed under any circumstance.

DELETE/client/customer_tags/{customer_tag_id}
Sandbox: https://api.payiano.dev/v1/client/customer_tags/{customer_tag_id}
Live: https://api.payiano.com/v1/client/customer_tags/{customer_tag_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_tags.delete
Request
Request body schema:
application/json
Path parameters:
customer_tag_id
required
Type: ulid
Length: 26

The unique ID assigned to each customer tag 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 tag. This ULID is automatically created by our system and is used to uniquely identify and track each customer tag 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 tag delete in the database. When the value is set to true, it indicates that the customer tag 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 tag is not physically removed from the database. With Soft Delete it's still possible to restore the customer tag record.

Response
200
Response schema:
application/json
Response body:
status
Type: boolean

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

Response sample:
JSON
1
{ 2 "status": true 3}