Skip to navigation

Update ticket integration destination

View as Markdown

Changes the fields you send and returns the full updated document.

Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, and every list or map you send replaces the stored one whole. The id goes in the URL; if you also send id in the body it must match.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The id of the ticket integration destination, as returned when it was created or listed.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
bmc_remedy_configobjectOptional

BMC Remedy destination settings. Set exactly one system-specific settings field.

cherwell_configobjectOptional

Cherwell destination settings. Set exactly one system-specific settings field.

fresh_service_configobjectOptional

Freshservice destination settings. Set exactly one system-specific settings field.

jira_service_desk_configobjectOptional

Jira Service Management destination settings. Set exactly one system-specific settings field.

service_now_configobjectOptional

ServiceNow destination settings. Set exactly one system-specific settings field.

zendesk_configobjectOptional

Zendesk destination settings. Set exactly one system-specific settings field.

wolken_configobjectOptional

Wolken destination settings. Set exactly one system-specific settings field.

manage_engine_configobjectOptional

ManageEngine destination settings. Set exactly one system-specific settings field.

ivanti_configobjectOptional

Ivanti destination settings. Set exactly one system-specific settings field.

salesforce_configobjectOptional

Salesforce destination settings. Set exactly one system-specific settings field.

sysaid_configobjectOptional

SysAid destination settings. Set exactly one system-specific settings field.

solarwinds_configobjectOptional

SolarWinds destination settings. Set exactly one system-specific settings field.

fresh_desk_configobjectOptional

Freshdesk destination settings. Set exactly one system-specific settings field.

connect_wise_configobjectOptional

ConnectWise destination settings. Set exactly one system-specific settings field.

workday_configobjectOptional

Workday destination settings. Set exactly one system-specific settings field.

bmc_remedyforce_configobjectOptional

BMC Remedyforce destination settings. Set exactly one system-specific settings field.

workday_itsm_configobjectOptional

Workday ITSM destination settings. Set exactly one system-specific settings field.

symphony_configobjectOptional

Symphony destination settings. Set exactly one system-specific settings field.

microsoft_dynamics_configobjectOptional

Microsoft Dynamics destination settings. Set exactly one system-specific settings field.

ticket_gateway_configobjectOptional

Ticket gateway destination settings. Set exactly one system-specific settings field.

Response

The updated ticket integration destination, at its new version
idstringOptionalRead-only
Unique ID of this configuration, assigned by the server.
connector_idstringOptionalformat: "uuid">=1 character

Connector for the ticketing system that tickets are filed in. Cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).

bmc_remedy_configobjectOptional

BMC Remedy destination settings. Set exactly one system-specific settings field.

cherwell_configobjectOptional

Cherwell destination settings. Set exactly one system-specific settings field.

fresh_service_configobjectOptional

Freshservice destination settings. Set exactly one system-specific settings field.

jira_service_desk_configobjectOptional

Jira Service Management destination settings. Set exactly one system-specific settings field.

service_now_configobjectOptional

ServiceNow destination settings. Set exactly one system-specific settings field.

zendesk_configobjectOptional

Zendesk destination settings. Set exactly one system-specific settings field.

wolken_configobjectOptional

Wolken destination settings. Set exactly one system-specific settings field.

manage_engine_configobjectOptional

ManageEngine destination settings. Set exactly one system-specific settings field.

ivanti_configobjectOptional

Ivanti destination settings. Set exactly one system-specific settings field.

salesforce_configobjectOptional

Salesforce destination settings. Set exactly one system-specific settings field.

sysaid_configobjectOptional

SysAid destination settings. Set exactly one system-specific settings field.

solarwinds_configobjectOptional

SolarWinds destination settings. Set exactly one system-specific settings field.

fresh_desk_configobjectOptional

Freshdesk destination settings. Set exactly one system-specific settings field.

connect_wise_configobjectOptional

ConnectWise destination settings. Set exactly one system-specific settings field.

workday_configobjectOptional

Workday destination settings. Set exactly one system-specific settings field.

bmc_remedyforce_configobjectOptional

BMC Remedyforce destination settings. Set exactly one system-specific settings field.

workday_itsm_configobjectOptional

Workday ITSM destination settings. Set exactly one system-specific settings field.

symphony_configobjectOptional

Symphony destination settings. Set exactly one system-specific settings field.

microsoft_dynamics_configobjectOptional

Microsoft Dynamics destination settings. Set exactly one system-specific settings field.

ticket_gateway_configobjectOptional

Ticket gateway destination settings. Set exactly one system-specific settings field.

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
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error