v1

latestOpenAPI 3.1.02026-08-04147764567.0 KB
requests

Create request

post/api/v1/requests

Headers

X-Api-Keystring required
X-Workspace-Idstring

Request body

request_typestring
request_source'EMAIL' | 'SLACK' | 'TEAMS' | 'PORTAL' | 'WORKFLOW' | 'JOURNEY' | 'API' | 'UNIVERSAL_AGENT'
descriptionstring
email_contentstring
plain_text_description_overridestring

Internal-only override for the persisted plain-text rendering of the description. When non-empty, AbstractRequestService persists it as RequestDetail.description instead of running HTMLSanitizerUtil.getPlainText() on the HTML description. Set ONLY by the email ingestion path (EmailIntentBasedRequestCreationService), which derives it from reqDescription via normalizeHtmlToPlainText(getPlainTextForRichHtml(...)) so system-generated HTML emails (BlackLine offboarding, etc.) avoid mashed table cells and blank-line storms. Annotated @JsonIgnore so external HTTP clients cannot set it via the request body — without that annotation, any caller of POST /requests, /service-requests, /incidents could write arbitrary unsanitized text into RequestDetail.description, bypassing the getPlainText() pipeline. The Lombok @SuperBuilder still exposes a setter for in-process Java callers (the email path), since builder access does not go through Jackson.

statusstring
prioritystring
parent_request_idinteger
agent_groupinteger
assigneeinteger
subjectstring
workspace_idinteger
tagsinteger[]
cc_emailsstring[]
bcc_emailsstring[]
attachmentsinteger[]
requesterinteger
to_emailstring
custom_fieldsApiV1RequestsPostRequestBodyContentApplicationJsonSchemaCustomFields
created_atstring date-time
updated_atstring date-time
external_idstring
external_source'SAAS_GENIE' | 'SNOW' | 'JSM_BRIDGE'
resolution_timestring date-time

When the ticket was resolved in the source system. Only accepted during migration (requires external_id or external_source).

first_response_timestring date-time

When the first agent response occurred in the source system. Only accepted during migration (requires external_id or external_source).

first_response_due_timestring date-time

SLA due time for first response from the source system. Only accepted during migration (requires external_id or external_source).

resolution_due_timestring date-time

SLA due time for resolution from the source system. Only accepted during migration (requires external_id or external_source).

closed_status_atstring date-time

When the ticket was moved to closed status in the source system. Only accepted during migration (requires external_id or external_source). When provided with a closed status, also sets resolution_time if not explicitly provided.

Response

Successful response

RequestsPostapiV1RequestsResponse200 required

Empty response body