Project

Project is a term used in Desk Platform API which refers to a corresponding Sendbird application on the Sendbird Dashboard. With the Project API, you can update settings of a Desk project or retrieve the information on working hours.

Note: Every Desk project has a corresponding Sendbird application. The {desk_api_key} in the HTTP request header identifies a specific project.

Resource representation

The following table shows the list of properties in a project resource.

Property name	Type	Description
id	int	The unique ID of the project.
pid	string	The unique ID of the project which consists of random characters.
activeToIdleTime	int	Specifies the time in minutes taken from a ticket’s status to change from Active to Idle, which must be greater than 0 and less than 10080.
idleToClosedTime	int	Specifies the time in minutes taken from a ticket’s status to change from Idle to Closed, which must be greater than 0 and less than 10080.
wipToPendingTime	int	Specifies the time in minutes taken from a ticket’s status to change from In Progress to Pending, which must be greater than 0 and less than 10080.

Actions

API endpoints are relative to the base URL allocated to your application. In this page, the /projects endpoint refers to https://desk-api-{application_id}.sendbird.com/platform/v1/projects.

Note: If you want to know your application ID, sign in to your dashboard, go to Settings > Application > General, and then check the Application ID.

List of actions

Action	HTTP request
Update a project	`PATCH` /projects Updates settings of a specific project.
View working hours	`GET` /projects/working_hours Retrieves information on working hours per day.

Update a project

HTTP request

PATCH https://desk-api-{application_id}.sendbird.com/platform/v1/projects

Request body

The following table lists the properties of an HTTP request that this action supports.

Optional

Property name	Type	Description
activeToIdleTime	int	Specifies the time in minutes taken from a ticket’s status to change from Active to Idle, which must be greater than 0 and less than 10080.
idleToClosedTime	int	Specifies the time in minutes taken from a ticket’s status to change from Idle to Closed, which must be greater than 0 and less than 10080.
idleToClosedReminderTime	int	Specifies the time in minutes to send a reminder, which must be greater than 0 and less than `idleToClosedTime`. The reminder time works counterclockwise, meaning that it counts time backward from `idleToClosedTime`. For example, if `idleToClosedReminderTime` is 10 minutes, the reminder is sent 10 minutes before idle tickets automatically change to closed tickets.
wipToPendingTime	int	Specifies the time in minutes taken from a ticket’s status to change from In Progress to Pending, which must be greater than 0 and less than 10080.

Request body example

{
    "activeToIdleTime": 10,
    "idleToClosedTime": 20,
    "idleToClosedReminderTime": 10,
    "wipToPendingTime": 30
}

Response

If successful, this action returns a list of project resources in the response body.

Status: 200 OK

{
    "id": 1,
    "pid": "47895be2-5a6b-4dc4-bc63-c26c4b3330db",
    "activeToIdleTime": 10,
    "idleToClosedTime": 20,
    "idleToClosedReminderTime": 10,
    "wipToPendingTime": 30
}

View working hours

Retrieves information on working hours per day.

HTTP request

GET https://desk-api-{application_id}.sendbird.com/platform/v1/projects/working_hours

Response

If successful, this action returns the working hour information per day in the response body.

When the working hour function is disabled

{
    "isEnabled": false
}

When the working hour function is enabled

{
    "isEnabled": true,
    "timezone": "Asia/Seoul",
    "workingHours": {
        "monday": {
            "isEnabled": true,
            "workingHours": [
                {
                    "startTime": "09:00",
                    "endTime": "17:00"
                }
            ]
        },
        "tuesday": {
            "isEnabled": true,
            "workingHours": [
                {
                    "startTime": "09:00",
                    "endTime": "17:00"
                }
            ]
        },
        ... # more information on working hours from Wednesday to Sunday
    }
}

List of response properties

Property name	Type	Description
workingHours	nested object	The information of working hours per day.
isEnabled	boolean	Determines whether the working hour function is enabled.
timezone	string	The timezone of the working hours.
.isEnabled	boolean	Determines whether working hours are set for the day.
.workingHours	nested object	The information of start and end time of working hours.

Try API requests