Skip to navigation

Create ticket service portal

View as Markdown

Creates a ticket service portal and returns it with its server-assigned id and version.

Send the fields at the top level of the body. Don’t send id or version.num; version.change_description is required.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Request

This endpoint expects an object.
connector_idstringRequiredformat: "uuid">=1 character

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_urlstringRequiredformat: "(?:https?:\/\/)?.*">=1 character

The full URL of the customer-facing service portal homepage.

versionobjectRequired
Document version. On update, send back the num from your last read.

Response

The created ticket service portal
idstringOptionalRead-only
Unique identifier of this configuration, assigned by the server. Send it in update requests to identify the configuration.
connector_idstringOptionalformat: "uuid">=1 character

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_urlstringOptionalformat: "(?:https?:\/\/)?.*">=1 character

The full URL of the customer-facing service portal homepage.

updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error