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

cURL

curl -X POST 'https://{tenant}.atomicwork.com/api/v1/requests' \
  -H 'X-Api-Key: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"request_type": "string", "request_source": "EMAIL", "description": "string", "email_content": "string", "plain_text_description_override": "string", "status": "string", "priority": "string", "parent_request_id": 0, "agent_group": 0, "assignee": 0, "subject": "string", "notes": [{"user_id": 0, "conversation_id": 0, "description": "string", "mentions": ["\u2026"], "is_private": true, "source": "EMAIL", "type": "ESD_NOTE", "attachments": ["\u2026"], "cc_emails": ["\u2026"], "bcc_emails": ["\u2026"], "is_broadcast": true, "external_id": "string", "external_source_type": "SAAS_GENIE", "email_content": "string", "event_created_at": "date-time"}], "workspace_id": 0, "conversation_info": {"channel_name": "string", "channel_id": "string", "start_timestamp": "unix-timestamp"}, "tags": [0], "cc_emails": ["string"], "bcc_emails": ["string"], "attachments": [0], "requester": 0, "to_email": "string", "request_created_from": {"id": "string", "type": "REQUEST_SETTINGS"}, "custom_fields": {}, "created_at": "date-time", "updated_at": "date-time", "external_id": "string", "external_source": "SAAS_GENIE", "resolution_time": "date-time", "first_response_time": "date-time", "first_response_due_time": "date-time", "resolution_due_time": "date-time", "closed_status_at": "date-time"}'

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

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

Response

200

Successful response

cURL

curl -X POST 'https://{tenant}.atomicwork.com/api/v1/requests' \
  -H 'X-Api-Key: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"request_type": "string", "request_source": "EMAIL", "description": "string", "email_content": "string", "plain_text_description_override": "string", "status": "string", "priority": "string", "parent_request_id": 0, "agent_group": 0, "assignee": 0, "subject": "string", "notes": [{"user_id": 0, "conversation_id": 0, "description": "string", "mentions": ["\u2026"], "is_private": true, "source": "EMAIL", "type": "ESD_NOTE", "attachments": ["\u2026"], "cc_emails": ["\u2026"], "bcc_emails": ["\u2026"], "is_broadcast": true, "external_id": "string", "external_source_type": "SAAS_GENIE", "email_content": "string", "event_created_at": "date-time"}], "workspace_id": 0, "conversation_info": {"channel_name": "string", "channel_id": "string", "start_timestamp": "unix-timestamp"}, "tags": [0], "cc_emails": ["string"], "bcc_emails": ["string"], "attachments": [0], "requester": 0, "to_email": "string", "request_created_from": {"id": "string", "type": "REQUEST_SETTINGS"}, "custom_fields": {}, "created_at": "date-time", "updated_at": "date-time", "external_id": "string", "external_source": "SAAS_GENIE", "resolution_time": "date-time", "first_response_time": "date-time", "first_response_due_time": "date-time", "resolution_due_time": "date-time", "closed_status_at": "date-time"}'

Authorization

Headers

Body

properties

properties

properties

Response

Authorization

Headers

Body

properties

properties

properties

Response