> This page is for API Reference & Tools.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.moveworks.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.moveworks.com/_mcp/server.

# Ticket Service Portals

> Create, read and update Ticket Service Portals through the Moveworks Configuration API: endpoints, fields and examples.

`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.

| Method  | Path                                | Endpoint reference                                                                                                             |
| ------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `GET`   | `/tool/ticket/service-portals`      | [List ticket service portals](/api-reference/configuration-api/ticketing/ticket-service-portals/list-ticket-service-portals)   |
| `POST`  | `/tool/ticket/service-portals`      | [Create ticket service portal](/api-reference/configuration-api/ticketing/ticket-service-portals/create-ticket-service-portal) |
| `GET`   | `/tool/ticket/service-portals/{id}` | [Get ticket service portal](/api-reference/configuration-api/ticketing/ticket-service-portals/get-ticket-service-portal)       |
| `PATCH` | `/tool/ticket/service-portals/{id}` | [Update ticket service portal](/api-reference/configuration-api/ticketing/ticket-service-portals/update-ticket-service-portal) |

### Fields

| Field          | Type    | Required  | Notes                                                                                                                                                                            |
| -------------- | ------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`           | string  | read-only | Unique identifier of this configuration, assigned by the server. Send it in update requests to identify the configuration.                                                       |
| `connector_id` | string  | ✅         | 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_url`   | string  | ✅         | The full URL of the customer-facing service portal homepage.                                                                                                                     |
| `updated_time` | string  | read-only | When the configuration was last updated.                                                                                                                                         |
| `updated_by`   | string  | read-only | Who last updated the configuration.                                                                                                                                              |
| `version`      | Version | ✅         | Document version. On update, send back the num from your last read.                                                                                                              |

### Example create body

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