> ## 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

> Deletes one or more custom properties, by property_ids or names, via ticket_properties and/or chat_properties.



## OpenAPI

````yaml api-reference/openapi-generated.json DELETE /v1/properties
openapi: 3.0.3
info:
  title: Periskope API
  version: 1.0.0
  description: >-
    Periskope external API.


    Responses use a flat, unwrapped shape: most endpoints return the resource at
    the top level, and list endpoints return a wrapper object with pagination
    inline (e.g. `{ from, to, count, chats: [...] }`). The documented response
    schemas describe these shapes directly.
servers:
  - url: https://api.periskope.app
security:
  - bearerAuth: []
paths:
  /v1/properties:
    delete:
      tags:
        - Properties
      summary: Delete custom properties
      description: >-
        Deletes one or more custom properties, by property_ids or names, via
        ticket_properties and/or chat_properties.
      operationId: deleteProperties
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ticket_properties:
                  type: array
                  items:
                    type: string
                  description: >-
                    property_ids or names (case-insensitive) of the ticket
                    properties to delete
                  example:
                    - Workspace
                    - property-aaaaaaaaaaaa
                chat_properties:
                  type: array
                  items:
                    type: string
                  description: >-
                    property_ids or names (case-insensitive) of the chat
                    properties to delete
                  example:
                    - Region
      responses:
        '200':
          description: Per-entry outcome of the deletion
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                    description: Always true when the request was processed
                  message:
                    type: string
                    description: Human-readable confirmation message
                    example: Custom properties deleted
                  data:
                    type: object
                    properties:
                      deleted_count:
                        type: integer
                        description: >-
                          Number of properties actually deleted, across both
                          chat and ticket properties
                        example: 2
                      properties:
                        type: array
                        items:
                          type: object
                          properties:
                            property_ref:
                              type: string
                              description: The entry exactly as sent in the request
                              example: Workspace
                            property_id:
                              type: string
                              description: >-
                                Resolved id of the deleted property. Absent when
                                the entry did not match any property.
                              example: property-aaaaaaaaaaaa
                            deleted:
                              type: boolean
                              description: Whether the property was deleted
                              example: true
                            reason:
                              type: string
                              description: >-
                                Why the entry was not deleted (e.g.
                                'not_found'). Absent when deleted is true.
                        description: >-
                          Per-entry outcome for every entry in the request.
                          Entries that do not match any property are reported
                          with deleted: false instead of failing the request.
              examples:
                default:
                  summary: Response body
                  value:
                    success: true
                    message: Custom properties deleted
                    data:
                      deleted_count: 2
                      properties:
                        - property_ref: Workspace
                          property_id: property-aaaaaaaaaaaa
                          deleted: true
                          reason: null
        '401':
          description: Invalid, expired or missing API token
          content:
            application/json:
              examples:
                error:
                  summary: Invalid, expired or missing API token
                  value:
                    code: UNAUTHORIZED_ERROR
                    message: Invalid bearer auth token
                    status: 401
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: UNAUTHORIZED_ERROR
                  message:
                    type: string
                    example: Invalid bearer auth token
                  status:
                    type: integer
                    example: 401
                example:
                  code: UNAUTHORIZED_ERROR
                  message: Invalid bearer auth token
                  status: 401
        '422':
          description: Request validation failed
          content:
            application/json:
              examples:
                error:
                  summary: Request validation failed
                  value:
                    code: VALIDATION_ERROR
                    message: Request validation failed
                    status: 422
                    fields:
                      body.chat_id:
                        message: chat_id is required
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: VALIDATION_ERROR
                  message:
                    type: string
                    example: Request validation failed
                  status:
                    type: integer
                    example: 422
                  fields:
                    type: object
                    additionalProperties:
                      type: object
                      properties:
                        message:
                          type: string
                        value: {}
                    example:
                      body.chat_id:
                        message: chat_id is required
                example:
                  code: VALIDATION_ERROR
                  message: Request validation failed
                  status: 422
                  fields:
                    body.chat_id:
                      message: chat_id is required
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              examples:
                error:
                  summary: Rate limit exceeded
                  value:
                    code: RATE_LIMIT_ERROR
                    message: You can only make 100 requests per second
                    status: 429
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: RATE_LIMIT_ERROR
                  message:
                    type: string
                    example: You can only make 100 requests per second
                  status:
                    type: integer
                    example: 429
                example:
                  code: RATE_LIMIT_ERROR
                  message: You can only make 100 requests per second
                  status: 429
        '500':
          description: Internal server error
          content:
            application/json:
              examples:
                error:
                  summary: Internal server error
                  value:
                    code: UNKNOWN_ERROR
                    message: Internal server error
                    status: 500
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: UNKNOWN_ERROR
                  message:
                    type: string
                    example: Internal server error
                  status:
                    type: integer
                    example: 500
                example:
                  code: UNKNOWN_ERROR
                  message: Internal server error
                  status: 500
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: typescript
          label: TypeScript
          source: |-
            import { PeriskopeApi } from '@periskope/periskope-client';

            const client = new PeriskopeApi({
              authToken: 'YOUR_API_KEY',
            });

            async function main() {
              const response = await client.properties.deleteProperties({
                ticket_properties: [
                  'Workspace',
                  'property-aaaaaaaaaaaa',
                ],
              });
              console.log(response);
            }

            main();
        - lang: bash
          label: cURL
          source: |-
            curl -X DELETE 'https://api.periskope.app/v1/properties' \
              -H 'Authorization: Bearer YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{
                "ticket_properties": [
                  "Workspace",
                  "property-aaaaaaaaaaaa"
                ]
              }'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your Periskope API token, sent as `Authorization: Bearer <token>`.
        Generate one from the Periskope dashboard under **Settings → API &
        Webhooks**. API access requires an active Pro or Enterprise plan.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.