> ## Documentation Index
> Fetch the complete documentation index at: https://docs.periskope.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Delete Custom Properties

> This endpoint deletes one or more custom properties

Pass the ids or names of the properties to delete in `ticket_properties` and/or `chat_properties`. At least one of the two must be provided

_Deleting a property is permanent. Any values set for it on tickets or chats are orphaned_

_Entries that do not match any property are reported with `deleted: false` and a reason, without failing the rest of the request_




## OpenAPI

````yaml DELETE /properties
openapi: 3.0.3
info:
  title: API - Local
  description: >-
    #### Welcome to the official Postman collection of Periskope API


    Periskope APIs enable you automate actions on your WhatsApp phone, and the
    Periskope platform


    - Read more about the APIs & webhooks here -
    [https://docs.periskope.app/api-reference/introduction](https://docs.periskope.app/api-reference/introduction)
        
    - We encourage responsible usage of the APIs. Follow these best practices
    and recommendations for safe actions on WhatsApp -
    [https://docs.periskope.app/get-started/best-practices](https://docs.periskope.app/get-started/best-practices)
        

    #### Getting Started


    ##### Pre-requisites:


    1. **Sign up for a free account on Periskope:** To use the Periskope API,
    you need to have an active Periskope account. If you don’t have one, you can
    sign up for a 7-day free trial [here](https://console.periskope.app).
        
    2. **Scan the QR code from WhatsApp to connect your phone:** A connected
    phone is required to use the APIs
        
    3. **Go to** [Settings &gt;
    API](https://console.periskope.app/settings/api), and generate an API key
    for your organization - The API key is used to authenticate every request.
    Please keep this secure
        

    ##### Using Postman:


    1. **Fork the collection so you can edit values and test the APIs in your
    own postman environment:** To fork the collection, click on the three dots
    next to v1. Then click on create a fork (_shortcut: Ctrl + Alt + F)._
        
    2. **Update the value of the variables in the collection:**  
        \- Update the API key with the key generated in Step 3  
        \- Update the phone number with your connected number. This number will be added to the `x-phone` header across requests
        
        It must be in the format of country code+number, with no special characters or spaces _e.g. +91 98745 32456 becomes 919874532456_
        

    For any help or feedback, please contact us at
    [support@periskope.app](https://mailto:support@periskope.app), or ping us on
    [WhatsApp](https://what.sapp.link/periskope)
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.periskope.app/v1
security:
  - bearerAuth: []
tags:
  - name: contacts
  - name: tickets
  - name: tasks
  - name: phones
  - name: message
  - name: queue
  - name: chats
  - name: group
  - name: members
  - name: webhooks
  - name: custom properties
paths:
  /properties:
    delete:
      tags:
        - custom properties
      summary: Delete Custom Properties
      description: >
        This endpoint deletes one or more custom properties


        Pass the ids or names of the properties to delete in `ticket_properties`
        and/or `chat_properties`. At least one of the two must be provided


        _Deleting a property is permanent. Any values set for it on tickets or
        chats are orphaned_


        _Entries that do not match any property are reported with `deleted:
        false` and a reason, without failing the rest of the request_
      operationId: deleteCustomProperties
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ticket_properties:
                  type: array
                  items:
                    type: string
                  example:
                    - Workspace
                    - property-a1b2c3
                  description: '- The ids or names of the ticket properties to delete'
                chat_properties:
                  type: array
                  items:
                    type: string
                  example:
                    - Workspace
                  description: '- The ids or names of the chat properties to delete'
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Custom properties deleted
                  data:
                    type: object
                    properties:
                      deleted_count:
                        type: integer
                        example: 2
                        description: The number of properties that were deleted
                      properties:
                        type: array
                        description: The outcome for each entry in the request, in order
                        items:
                          type: object
                          properties:
                            property_ref:
                              type: string
                              example: Workspace
                              description: >-
                                The id or name exactly as it was passed in the
                                request
                            property_id:
                              type: string
                              example: property-a1b2c3
                              description: >-
                                The id of the deleted property. Absent when the
                                entry did not match
                            deleted:
                              type: boolean
                              example: true
                            reason:
                              type: string
                              example: not_found
                              description: >-
                                Why the entry was not deleted. Present only when
                                deleted is false
        '422':
          description: No properties provided
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: VALIDATION_ERROR
                  message:
                    type: string
                    example: >-
                      Provide at least one entry in ticket_properties or
                      chat_properties
                  status:
                    type: number
                    example: 422
                  fields:
                    type: object
                    properties:
                      properties:
                        type: object
                        properties:
                          message:
                            type: string
                            example: >-
                              Provide at least one entry in ticket_properties or
                              chat_properties
              examples:
                No properties provided:
                  value:
                    code: VALIDATION_ERROR
                    message: >-
                      Provide at least one entry in ticket_properties or
                      chat_properties
                    status: 422
                    fields:
                      properties:
                        message: >-
                          Provide at least one entry in ticket_properties or
                          chat_properties
      x-codeSamples:
        - lang: TypeScript
          label: Node.js
          source: |-
            import { PeriskopeApi } from '@periskope/periskope-client';

            const client = new PeriskopeApi({
              authToken: 'YOUR_API_KEY',
              phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210'
            });

            async function deleteCustomProperties() {
              const response = await client.property.delete({
                ticket_properties: ['Workspace'],
                chat_properties: ['Workspace']
              });

              console.log(response);
            }

            deleteCustomProperties();
        - lang: cURL
          label: cURL
          source: |-
            curl -X DELETE \
              https://api.periskope.app/v1/properties \
              -H 'Authorization: Bearer <token>' \
              -H 'Content-Type: application/json' \
              -H 'x-phone: YOUR_PHONE_NUMBER' \
             -d '{
                "ticket_properties": ["Workspace"],
                "chat_properties": ["Workspace"]
              }'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````