Docs
API Reference

Messages

Job timeline messages, including system status/assignment/station updates

Messages live in organisations/{orgId}/messages and are filtered by ticketId. System types (status_update, assignment_update, station_update) are written by the API when those job fields change — they are not client-settable.

Required scopes: messages:read / messages:write / messages:delete.

  • GET/organisations/{orgId}/tickets/{ticketId}/messages
  • POST/organisations/{orgId}/tickets/{ticketId}/messages
  • GET/organisations/{orgId}/tickets/{ticketId}/messages/{messageId}
  • PUT/organisations/{orgId}/tickets/{ticketId}/messages/{messageId}
  • DELETE/organisations/{orgId}/tickets/{ticketId}/messages/{messageId}

Author

userId is the OAuth consenting admin, or the admin who created the API key (createdBy). API-written messages also set messageParams.source = "api". mentionedUserIds must be active members or the request is 400.