Customer Tags Management

Payiano's Delete Customer Tag function is useful when you need to remove a certain customer group tag from your system. Maybe a tag is no longer relevant or needs updating. This feature allows you to keep your customer groups current and meaningful. By deleting outdated or unnecessary tags, you ensure that your customer organization stays efficient and reflective of your current business strategy.

DELETE/customer_tags/{id}
Sandbox: https://api.payiano.dev/v1/customer_tags/{id}
Live: https://api.payiano.com/v1/customer_tags/{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 customer_tags_delete
Request
Request body schema:
application/json
Path parameters:
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:
[ "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:
1
{ 2 "status": true 3}