Node.js

import { PeriskopeApi } from '@periskope/periskope-client';

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

async function updateCustomProperty() {
  const response = await client.property.update({
    property_id: 'Workspace',
    type: 'ticket',
    name: 'Workspace ID',
    section: 'Issue Details'
  });

  console.log(response);
}

updateCustomProperty();

{
  "success": true,
  "message": "Custom property updated",
  "data": {
    "property_id": "property-a1b2c3",
    "property_name": "Workspace",
    "type": "ticket",
    "kind": "dropdown",
    "mandatory": false,
    "section_id": "3f8b6c1e-8f2a-4b6e-9c3d-2a1f0e9d8c7b",
    "section_name": "Issue Details",
    "options": [
      {
        "id": "1712345678901",
        "label": "Acme Corp"
      }
    ],
    "created_at": "2026-07-06T10:00:00.000Z"
  }
}

Custom Property APIs

Update Custom Property

This endpoint updates the name, section or mandatory flag of a custom property

Provide any combination of the three fields - at least one is required. If the section does not exist yet, it is created automatically

Options for dropdown and picklist properties are managed separately via the Update Property Options endpoint

mandatory is supported only for ticket properties. Passing mandatory: true for a chat property returns a validation error

If the same property name exists under both chat and ticket, pass the type query parameter to specify which one to update. Without it, the request is rejected as ambiguous

Node.js

import { PeriskopeApi } from '@periskope/periskope-client';

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

async function updateCustomProperty() {
  const response = await client.property.update({
    property_id: 'Workspace',
    type: 'ticket',
    name: 'Workspace ID',
    section: 'Issue Details'
  });

  console.log(response);
}

updateCustomProperty();

{
  "success": true,
  "message": "Custom property updated",
  "data": {
    "property_id": "property-a1b2c3",
    "property_name": "Workspace",
    "type": "ticket",
    "kind": "dropdown",
    "mandatory": false,
    "section_id": "3f8b6c1e-8f2a-4b6e-9c3d-2a1f0e9d8c7b",
    "section_name": "Issue Details",
    "options": [
      {
        "id": "1712345678901",
        "label": "Acme Corp"
      }
    ],
    "created_at": "2026-07-06T10:00:00.000Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

property_id

string

required

The property_id (e.g. property-xxxx) or the property_name of the custom property

Query Parameters

type

enum<string>

Specifies whether to resolve the chat or the ticket property when the same name exists under both

Available options:

chat,

ticket

Body

application/json

name

string

The new name of the property
Must be unique within its type

Example:

"Workspace ID"

section

string

The name of the section to move the property to
Created automatically if it does not exist

Example:

"Issue Details"

mandatory

boolean

Whether the property is mandatory
Supported only for ticket properties; rejected for chat properties

Example:

true

Response

200 OK

success

boolean

Example:

true

message

string

Example:

"Custom property updated"

data

object

Show child attributes

Create Custom Property Update Property Options