Update Ticket

Node.js

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

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

async function updateTicket() {
  const response = await client.ticket.update({
    ticket_id: 'BKT-001',
    assignee: 'bharat@hashlabs.dev'
  });

  console.log(response);
}

updateTicket();

curl -X PATCH \
  https://api.periskope.app/v1/tickets/{ticket_id} \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "assignee": "bharat@hashlabs.dev"
  }'

{
  "attached_messages": [],
  "chat": {
    "chat_id": "919537851844@c.us",
    "chat_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us.jpg?timestamp=1737689973340",
    "chat_labels": "label1, label2",
    "chat_name": "BK Local1",
    "chat_type": "user",
    "created_at": "2025-01-18T14:51:03+00:00",
    "custom_properties": {
      "Custom Property 1": "hello"
    },
    "group_description": null,
    "invite_link": null,
    "is_muted": false,
    "members": {
      "918527184400@c.us": {
        "chat_id": "919537851844@c.us",
        "contact_color": "#B4876E",
        "contact_id": "918527184400@c.us",
        "contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F918527184400%40c.us.jpg?timestamp=1737690126280",
        "contact_labels": "",
        "contact_name": "Support",
        "is_admin": true,
        "is_internal": true,
        "is_super_admin": true,
        "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
        "org_phone": "918527184400@c.us"
      },
      "919537851844@c.us": {
        "chat_id": "919537851844@c.us",
        "contact_color": "#B4876E",
        "contact_id": "919537851844@c.us",
        "contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us.jpg?timestamp=1737689973340",
        "contact_labels": "label1, label2",
        "contact_name": "BK Local1",
        "is_admin": true,
        "is_internal": false,
        "is_super_admin": true,
        "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
        "org_phone": "918527184400@c.us"
      }
    },
    "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
    "org_phone": "918527184400@c.us"
  },
  "message": {
    "body": "You have been invited to join Test New 1039\n\nhttps://chat.whatsapp.com/invite/CGiTdfn1dUM8J67GEx1lyx\n\nIf you cannot click the link, please respond to this message, and the link will become active",
    "chat_id": "919537851844@c.us",
    "media_path": "",
    "message_id": "true_919537851844@c.us_3EB0ABB7C973860FC19EBE05FD934141CCEC2D8B",
    "org_phone": "918527184400@c.us",
    "performed_by": null,
    "sender_name": "Support",
    "sender_phone": "918527184400",
    "timestamp": "2025-01-24T05:11:08+00:00"
  },
  "ticket": {
    "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
    "status": "closed",
    "subject": "New subject 1",
    "assignee": "",
    "due_date": "2026-05-25T03:58:31+00:00",
    "priority": 2,
    "closed_at": "2026-05-19T11:31:29.268+00:00",
    "closed_by": "",
    "raised_by": null,
    "ticket_id": "",
    "created_at": "2026-05-19T07:58:29.726+00:00",
    "is_deleted": false,
    "assigned_by": "",
    "ticket_labels": "",
    "closed_message": null,
    "first_assigned_at": null,
    "quoted_message_id": "3EB0ABB7C973860FC19EBE05FD934141CCEC2D8B",
    "ticket_custom_properties": {}
  }
}

Node.js

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

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

async function updateTicket() {
  const response = await client.ticket.update({
    ticket_id: 'BKT-001',
    assignee: 'bharat@hashlabs.dev'
  });

  console.log(response);
}

updateTicket();

curl -X PATCH \
  https://api.periskope.app/v1/tickets/{ticket_id} \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "assignee": "bharat@hashlabs.dev"
  }'

{
  "attached_messages": [],
  "chat": {
    "chat_id": "919537851844@c.us",
    "chat_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us.jpg?timestamp=1737689973340",
    "chat_labels": "label1, label2",
    "chat_name": "BK Local1",
    "chat_type": "user",
    "created_at": "2025-01-18T14:51:03+00:00",
    "custom_properties": {
      "Custom Property 1": "hello"
    },
    "group_description": null,
    "invite_link": null,
    "is_muted": false,
    "members": {
      "918527184400@c.us": {
        "chat_id": "919537851844@c.us",
        "contact_color": "#B4876E",
        "contact_id": "918527184400@c.us",
        "contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F918527184400%40c.us.jpg?timestamp=1737690126280",
        "contact_labels": "",
        "contact_name": "Support",
        "is_admin": true,
        "is_internal": true,
        "is_super_admin": true,
        "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
        "org_phone": "918527184400@c.us"
      },
      "919537851844@c.us": {
        "chat_id": "919537851844@c.us",
        "contact_color": "#B4876E",
        "contact_id": "919537851844@c.us",
        "contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us.jpg?timestamp=1737689973340",
        "contact_labels": "label1, label2",
        "contact_name": "BK Local1",
        "is_admin": true,
        "is_internal": false,
        "is_super_admin": true,
        "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
        "org_phone": "918527184400@c.us"
      }
    },
    "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
    "org_phone": "918527184400@c.us"
  },
  "message": {
    "body": "You have been invited to join Test New 1039\n\nhttps://chat.whatsapp.com/invite/CGiTdfn1dUM8J67GEx1lyx\n\nIf you cannot click the link, please respond to this message, and the link will become active",
    "chat_id": "919537851844@c.us",
    "media_path": "",
    "message_id": "true_919537851844@c.us_3EB0ABB7C973860FC19EBE05FD934141CCEC2D8B",
    "org_phone": "918527184400@c.us",
    "performed_by": null,
    "sender_name": "Support",
    "sender_phone": "918527184400",
    "timestamp": "2025-01-24T05:11:08+00:00"
  },
  "ticket": {
    "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
    "status": "closed",
    "subject": "New subject 1",
    "assignee": "",
    "due_date": "2026-05-25T03:58:31+00:00",
    "priority": 2,
    "closed_at": "2026-05-19T11:31:29.268+00:00",
    "closed_by": "",
    "raised_by": null,
    "ticket_id": "",
    "created_at": "2026-05-19T07:58:29.726+00:00",
    "is_deleted": false,
    "assigned_by": "",
    "ticket_labels": "",
    "closed_message": null,
    "first_assigned_at": null,
    "quoted_message_id": "3EB0ABB7C973860FC19EBE05FD934141CCEC2D8B",
    "ticket_custom_properties": {}
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

ticket_id

string

required

The unique identifier of the ticket

Example:

"BKT-001"

Body

application/json

assignee

string

Update the assignee of the ticket. Must be an email of a user in the organization

Example:

""

closed_by

string

Email of the user who is closing the ticket. Must be the email of a user in the organization

Example:

"bharat@hashlabs.dev"

closed_message

string

A closing message saved alongside the ticket for additional context when it is closed

Example:

"Issue resolved after customer confirmation"

custom_properties

object

A record (key-value pair) of the property name or property id as keys, along with the updated value

Show child attributes

due_date

any | null

Updates the due date of the ticket.
Must be a string that can be parsed to a date

Example:

null

labels

string

A comma-separated list of labels to be assigned to the tickets. All labels are case-insensitive.
If any label currently does not exist, it will be created

Example:

""

priority

string

Updates the priority of the ticket.
Only accepts the following values - 1,2,3,4
- 1 = Low
- 2 = Medium
- 3 = High
- 4 = Urgent

Example:

"2"

status

string

Updates the status of the ticket.
Only accepts the following values - open, inprogress, closed, archived

Example:

""

subject

string

Updates the subject of the ticket

Example:

"New subject 1"

Response

200 - application/json

200 OK

The response is a ticket object. Refer to the ticket object here

Get Tickets Create Ticket

API

Chat APIs

Group Settings APIs

Message APIs

Contact APIs

Ticket APIs

Custom Property APIs

Task APIs

Queue APIs

Phone APIs

Notes APIs

Reaction APIs

Knowledge Base APIs

Member APIs

AI APIs

Webhook APIs

Webhooks

Authorizations

Path Parameters

Body

Response