TypeScript
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();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"
]
}'{
"success": true,
"message": "Custom properties deleted",
"data": {
"deleted_count": 2,
"properties": [
{
"property_ref": "Workspace",
"property_id": "property-aaaaaaaaaaaa",
"deleted": true,
"reason": null
}
]
}
}{
"code": "UNAUTHORIZED_ERROR",
"message": "Invalid bearer auth token",
"status": 401
}{
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"status": 422,
"fields": {
"body.chat_id": {
"message": "chat_id is required"
}
}
}{
"code": "RATE_LIMIT_ERROR",
"message": "You can only make 100 requests per second",
"status": 429
}{
"code": "UNKNOWN_ERROR",
"message": "Internal server error",
"status": 500
}Custom Property APIs
Delete Custom Properties
Deletes one or more custom properties, by property_ids or names, via ticket_properties and/or chat_properties.
TypeScript
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();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"
]
}'{
"success": true,
"message": "Custom properties deleted",
"data": {
"deleted_count": 2,
"properties": [
{
"property_ref": "Workspace",
"property_id": "property-aaaaaaaaaaaa",
"deleted": true,
"reason": null
}
]
}
}{
"code": "UNAUTHORIZED_ERROR",
"message": "Invalid bearer auth token",
"status": 401
}{
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"status": 422,
"fields": {
"body.chat_id": {
"message": "chat_id is required"
}
}
}{
"code": "RATE_LIMIT_ERROR",
"message": "You can only make 100 requests per second",
"status": 429
}{
"code": "UNKNOWN_ERROR",
"message": "Internal server error",
"status": 500
}Authorizations
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.
Body
application/json
Was this page helpful?