API Reference

/api/v1/projects/{projectId}/tickets/{ticketId}

patch
https://api.capmo.de/api/v1/projects//tickets/

This can be used to update a specific project ticket by its ID.

Path Params
string
required
string
required
Body Params
string

The unique identifier of the source. This is a user-generated string. You can use this to link the person to a resource in an external system.

string | null

The name of the ticket. Usually a short description of the issue.

string | null

The description of the ticket. A more detailed description of the issue.

string | null

Unique ID of the category this ticket belongs to. If not provided, the ticket will be uncategorised.

string | null
enum

The status of the ticket.

Allowed:
tag_ids
array of strings | null

List of the unique IDs of tags associated with this ticket. If not provided, the ticket will be untagged.

tag_ids
string | null

ID of the ticket type. If not provided, the ticket will be uncategorised.

string | null

The deadline for resolving the ticket. Can be as simple as a date or a full timestamp.

string | null

Unique ID of the project company responsible for this ticket. This can be obtained from the project contact book.

responsible_ids
array of strings | null

List of the unique IDs of the responsible users for this ticket. These are not the IDs of the people in the project contact book. Instead, these are their user IDs as registered in our platform.

responsible_ids
number | null

The estimated cost associated with the ticket in Euros.

string | null

ID of the room listing to associate with this ticket.

uuid | null

ID of the plan this ticket is pinned to. Must be provided together with location_x and location_y. Send all three fields as null to clear the plan location; omit all three fields to preserve the existing location.

number | null
0 to 1

X coordinate of the ticket on the linked plan PDF. Normalized to [0, 1], growing left to right, with origin (0, 0) in the top-left corner. Must be provided together with plan_id and location_y. Send all three fields as null to clear the plan location; omit all three fields to preserve the existing location.

number | null
0 to 1

Y coordinate of the ticket on the linked plan PDF. Normalized to [0, 1], growing top to bottom, with origin (0, 0) in the top-left corner. Must be provided together with plan_id and location_x. Send all three fields as null to clear the plan location; omit all three fields to preserve the existing location.

Headers
string

The HTTP Request-Id request header is an optional and unofficial HTTP header, used to trace individual HTTP requests from the client to the server and back again. It allows the client and server to correlate each HTTP request. If not provided by the client, the server should generate a unique request ID and include it in the response.

Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?