Skip to navigation

Ticket Service Portals

View as Markdown

tool.ticket.service-portals

  • Endpoint: /tool/ticket/service-portals | Methods: GET, PATCH, POST
  • Request shape: fields go at the top level of the JSON body, with no resource wrapper. The item’s id goes in the URL for reads and updates, not in the body.
  • Updates: a JSON merge-patch. Send only the fields you change, plus version: {num, change_description} with the num from your last read. Lists and maps you send replace the stored ones whole.

Endpoints

All paths are relative to https://api.moveworks.ai/configurations/v1alpha1. Each endpoint page lists the request and response schema, an example, and the errors it can return.

MethodPathEndpoint reference
GET/tool/ticket/service-portalsList ticket service portals
POST/tool/ticket/service-portalsCreate ticket service portal
GET/tool/ticket/service-portals/{id}Get ticket service portal
PATCH/tool/ticket/service-portals/{id}Update ticket service portal

Fields

FieldTypeRequiredNotes
idstringread-onlyUnique identifier of this configuration, assigned by the server. Send it in update requests to identify the configuration.
connector_idstring✅The ticketing system connector this service portal belongs to. Cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
portal_urlstring✅The full URL of the customer-facing service portal homepage.
updated_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersion✅Document version. On update, send back the num from your last read.

Example create body

{
"connector_id": "<connector-uuid>",
"portal_url": "https://example.com/path",
"version": {
"change_description": "Create ticket service portal"
}
}