Download OpenAPI specification:
Contains functionality around tickets.
For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.
Removes specified tickets from member watch-list.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| ticketIds required | Array of strings <uuid> [ items <uuid > ] |
{- "ticketIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Adds specified tickets to member watch-list. Note that in order to access a ticket, a member needs to have access to any/all of the associated contacts (depending on the access rule).
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| ticketIds required | Array of strings <uuid> [ items <uuid > ] |
{- "ticketIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Updates a ticket. Note that in order to access a ticket, a member needs to have access to any/all of the associated contacts (depending on the access rule).
If updated, the assignee must have access to any/all of the associated contacts (depending on the same access rule).
All changes are registered in the ticket’s change-log.
Possible ApiError.SubCode values:
AssigneeInsufficientAccess: Assignee does not have sufficient access to associated contact/s.
| ticketId required | string <uuid> |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| updateProperties | Array of strings or null unique |
| title | string or null |
| description | string or null |
| dueDate | string or null <date-time> |
| assigneeMemberUid | string or null <uuid> |
| statusUid | string or null <uuid> |
{- "updateProperties": [
- "string"
], - "title": "string",
- "description": "string",
- "dueDate": "2019-08-24T14:15:22Z",
- "assigneeMemberUid": "27d6fe27-3080-43af-b6d4-203ff6d445ea",
- "statusUid": "49fc7e10-0ed8-49df-b287-b94b02624203"
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Updates specified comment in the specified ticket. Old version of the comment is still accessible via the comment history. Note that in order to access a ticket, a member needs to have access to any/all of the associated contacts (depending on the access rule), and that in order to update a comment, a member needs to be the one who originally added it.
| ticketId required | string <uuid> |
| commentId required | string <uuid> |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request data
| comment required | string |
{- "comment": "string"
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Creates a ticket. If specified, the assignee must have access to any/all of the associated contacts (depending on the access rule).
Participant association is automatically set (if available in JWT), unless directly specified in request body when called with a bypass token.
Either category-uid or category-key must be specified.
Possible ApiError.SubCode values:
AssigneeInsufficientAccess: Assignee does not have sufficient access to associated contact/s.
CreatorInsufficientAccess: User does not have sufficient access to associated contact/s.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| title required | string |
| description | string or null |
| categoryUid | string or null <uuid> |
| categoryKey | string or null |
| dueDate | string or null <date-time> |
| assigneeMemberUid | string or null <uuid> |
| contactUids required | Array of strings <uuid> [ items <uuid > ] |
| referenceUid | string or null <uuid> |
| participantUids | Array of strings or null <uuid> [ items <uuid > ] |
{- "title": "New product on-boarding",
- "description": "Working with new instruments",
- "categoryUid": "1a2f3ae0-fea3-46d7-acab-465fb43d1ff4",
- "dueDate": "2026-03-25T09:56:29.1965357+00:00",
- "assigneeMemberUid": "58000000-0000-0000-0000-000000000000",
- "contactUids": [
- "fd0f0bbf-a59e-4650-bfa4-2698b949d08d",
- "fb1b28a6-c2d1-48ce-bafc-9f7d9b454d0f"
], - "referenceUid": "56e64c33-1972-4270-ba3c-23b4c5a5da84"
}{- "ticketId": "e3e3e8ea-b02a-4536-85a2-a9c90f4ee74f"
}Adds a comment to a ticket. Note that in order to access a ticket, a member needs to have access to any/all of the associated contacts (depending on the access rule).
| ticketId required | string <uuid> |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request data
| comment required | string |
{- "comment": "string"
}{- "commentId": "ee0469af-2fa1-4b7e-b5f1-8e711a95821b"
}