Atomicwork | Product

Requests

Create request

POST https://{tenant}.atomicwork.com/api/v1/requests

Authorization

X-Api-Keyheaderstringrequired

API key authentication.

Headers

X-Workspace-Idheaderstring

Body

request_typebodystring
request_sourcebodyenum (string)
Allowed valuesEMAILSLACKTEAMSPORTALWORKFLOWJOURNEYAPIUNIVERSAL_AGENT
descriptionbodystring
email_contentbodystring
plain_text_description_overridebodystring

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.

statusbodystring
prioritybodystring
parent_request_idbodyinteger
agent_groupbodyinteger
assigneebodyinteger
subjectbodystring
notesbodyarray of object
workspace_idbodyinteger
conversation_infobodyobject
tagsbodyarray of integer
cc_emailsbodyarray of string
bcc_emailsbodyarray of string
attachmentsbodyarray of integer
requesterbodyinteger
to_emailbodystring
request_created_frombodyobject
custom_fieldsbodyobject
created_atbodystring
updated_atbodystring
external_idbodystring
external_sourcebodyenum (string)
Allowed valuesSAAS_GENIESNOWJSM_BRIDGE
resolution_timebodystring

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

first_response_timebodystring

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

first_response_due_timebodystring

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

resolution_due_timebodystring

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

closed_status_atbodystring

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

200

Successful response