{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Task API V3 — Developer Guide","description":"Sprinklr offers robust, convenient, and simple RESTful Web service APIs to integrate data from Sprinklr to any external system.","keywords":["Sprinklr API","Sprinklr Developer Portal","OAuth 2.0","RESTful API","Social Media API","Customer Experience API","Unified-CXM","Social Listening API"]},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"task-api-v3--developer-guide","__idx":0},"children":["Task API V3 — Developer Guide"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Applies to:"]}," Sprinklr Task API V3 (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/task"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 API reference:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/task"},"children":["Task | Sprinklr Developer Portal"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"1-overview","__idx":1},"children":["1. Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sprinklr Task"]}," is a standard business object used in Modern Marketing to track and manage content using configurable agile Production Dashboards. A task is always created against an entity — a message, a campaign, an asset — identified by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType"]},", and it carries assignment, status, due-date, queue, subscriber, and custom-field state."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Task V3 exposes full CRUD on a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["single resource path"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/task"]}," and differentiates operations by HTTP method, with bulk support on the read, delete, and update paths through a comma-separated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]}," query parameter."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Path"},"children":["Path"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Bulk"},"children":["Bulk"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create task"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/task"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No — one task per call"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch task(s)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/task?id=taskId1,taskId2"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update task (full replace)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/task?id=taskId1,taskId2"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update task (partial upsert)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/task?id=taskId1,taskId2"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["new in V3"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete task(s)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/task?id=taskId1,taskId2"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"11-the-task-data-model","__idx":2},"children":["1.1 The task data model"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Layer"},"children":["Layer"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Object / field"},"children":["Object / field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What it holds"},"children":["What it holds"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identity"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parentTaskId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nextTaskId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sprinklr task ID and the task chain it belongs to."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Descriptive"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["title"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taskType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taskStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Task definition and current status."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Anchor entity"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The entity the task was created for (for example a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MESSAGE"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CAMPAIGN"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Assignment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assignment"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assigneeId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assigneeType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assignedById"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assignmentTime"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Scheduling"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dueDate"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["completionDate"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdTime"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifiedTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Epoch-millisecond timestamps"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Routing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueIds"]}," (request) / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueDetails"]}," (response)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Work queues the task sits in"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Collaboration"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["attachment"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Who is watching, and any attached media"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Extensibility"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customProperties"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom fields, keyed by custom-field ID, always ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["List<String>"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lifecycle / integration"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["inactive"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workFlowState"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalCases"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Soft-delete marker, workflow execution state, linked third-party cases"]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note"]},": Request and response schemas differ. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," operations accept a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TaskRequest"]}," object, while read operations return a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Task"]}," object. These schemas are not interchangeable."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"In TaskRequest (write)"},"children":["In ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TaskRequest"]}," (write)"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"In Task (read)"},"children":["In ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Task"]}," (read)"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueIds"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Array[String]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueDetails"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Array[Queue]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdTime"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifiedTime"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["inactive"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nextTaskId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅ (server-assigned)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["completionDate"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workFlowState"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalCases"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assignment"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taskType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taskStatus"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["title"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dueDate"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customProperties"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["attachment"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parentTaskId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note"]},": Write operations use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueIds (Array[String])"]},", while read operations return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueDetails (Array[Queue])"]},". Because these fields use different schemas, do not reuse a read response as a write payload."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"12-addressing-a-task","__idx":3},"children":["1.2 Addressing a task"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In V3, you can address a task only by its Sprinklr task ID, passed in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," query parameter."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"?id=6a1437f751d06294d5c8773e                                  # single\n?id=6a1437f751d06294d5c8773e,6a15305cad837f75fc5ac662         # bulk\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Task IDs are 24-character hex ObjectId strings. Store the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," returned in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," response."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-base-urls-and-environments","__idx":4},"children":["2. Base URLs and environments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["All API calls are sent to the production endpoint:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["So the task resource in production is:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3/task\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{env}"]}," with your assigned environment identifier. The V3 specification enumerates: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod0"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod2"]},", and so on. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/apis"},"children":["APIs | Sprinklr Developer Portal"]}," for the current environment list."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Do not hard-code the host name. Make the base URL a single configuration value so promotion between environments is a config change, not a code change."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3-authentication-and-common-headers","__idx":5},"children":["3. Authentication and common headers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All Task API calls are authenticated with OAuth 2.0. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/api-overview"},"children":["API Overview"]}," for portal registration, API key and secret generation, and the Authorize flow."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The V3 specification declares two security schemes, both applied to every operation:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Scheme"},"children":["Scheme"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Where"},"children":["Where"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bearerAuth"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP bearer, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bearerFormat: JWT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apiKeyAuth"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["API key"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]}," header"]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Header"},"children":["Header"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required on"},"children":["Required on"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer {{accessToken}}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authenticates the user with the server"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{apiKey}}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authenticates the application with the server"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Declares the request body media type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Declares the acceptable response type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"4-write-operations","__idx":6},"children":["4. Write operations"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"41-create-a-task","__idx":7},"children":["4.1 Create a task"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/task"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this endpoint to create a task for an existing entity."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body","__idx":8},"children":["Request body"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sub Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assignment"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Assignment details for the task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assigneeId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the user or entity assigned to the task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assigneeType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of assignee.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["USER"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["BOT"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assignedById"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the user who assigns the task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assignmentTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Time when the user assigns the task, in epoch milliseconds."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taskType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of work represented by the task.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Design Task"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Working task"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taskStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Status of the task.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["NEW"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["AVAILABLE"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["title"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Title of the task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Description of the work required for the task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the entity associated with the task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of entity associated with the task.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["MESSAGE"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["CAMPAIGN"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dueDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date and time when the task is due, in epoch milliseconds."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customProperties"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Map[String, List[String]]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom fields for the task, keyed by custom-field ID. Provide each custom-field value as an array of strings, including single-value fields."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["attachment"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Media or document attached to the task. The applicable fields depend on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["attachment"]},".",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[Object]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Users or entities that subscribe to task updates."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required within subscriber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of subscriber. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["USER"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GLOBAL"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["CLIENT"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ids"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Subscriber identifiers. The API interprets each identifier according to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers[]"]},".",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifiers of the work queues to which the task belongs."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parentTaskId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the parent task when the task belongs to a task hierarchy."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request","__idx":9},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/{env}/api/v3/task' \\\n--header 'Authorization: Bearer {{accessToken}}' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"assignment\": {\n        \"assigneeId\": \"600005371\",\n        \"assigneeType\": \"USER\"\n    },\n    \"taskType\": \"Working task\",\n    \"taskStatus\": \"AVAILABLE\",\n    \"title\": \"Review creative brief\",\n    \"description\": \"Review creative brief before approval\",\n    \"assetId\": \"{{assetId}}\",\n    \"assetType\": \"MESSAGE\",\n    \"dueDate\": 1779820200000,\n    \"customProperties\": {},\n    \"queueIds\": [\"100623\"]\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response","__idx":10},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A successful request returns ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["201 Created"]}," and the newly created task. The data property contains a single task object."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n\"data\": {\n    \"id\": \"6a15305cad837f75fc5ac662\",\n    \"assignment\": {},\n    \"taskType\": \"Working task\",\n    \"taskStatus\": \"AVAILABLE\",\n    \"title\": \"Review creative brief\",\n    \"description\": \"Review the creative brief before production starts.\",\n    \"assetId\": \"{{assetId}}\",\n    \"assetType\": \"MESSAGE\",\n    \"dueDate\": 1779820200000,\n    \"customProperties\": {\n        \"spr_task_status\": [\"AVAILABLE\"],\n        \"spr_task_type\": [\"Working task\"]\n    },\n    \"inactive\": false,\n    \"queueDetails\": [],\n    \"createdTime\": 1779773532036,\n    \"modifiedTime\": 1779773532036,\n    \"externalCases\": []\n},\n\"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Notes"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," responses return a single object in data. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," responses return an array in data. Your client must handle both formats."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sprinklr automatically maps ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taskStatus"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taskType"]}," to the reserved custom properties ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["spr_task_status"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["spr_task_type"]},". Do not populate these keys directly. Set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taskStatus"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taskType"]},", and allow the platform to maintain the mirror fields."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"411-attachment","__idx":11},"children":["4.1.1 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["attachment"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["attachment"]}," supports multiple attachment schemas. The V3 specification models it as a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["oneOf"]}," across 40+ attachment schemas, discriminated by the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," property — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IMAGE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VIDEO"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LINK"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DOCUMENT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUDIO"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CAROUSEL"]},", and others. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," is required on every variant."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fields commonly used on a task attachment (from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ImageAttachment"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DocumentAttachment"]},"):"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required when attachment is provided"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of attachment.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["IMAGE"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["VIDEO"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["LINK"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["DOCUMENT"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["AUDIO"]},", and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["CAROUSEL"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["url"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["URL of the attached media or document."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["title"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Title of the attachment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Description of the attachment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["previewUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["URL of the attachment preview."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the attachment in Sprinklr Digital Asset Management."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mimeType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["MIME type of the attachment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["alternateText"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Alternative text that describes the attachment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sizeInBytes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Size of the attachment in bytes."]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"\"attachment\": {\n    \"type\": \"IMAGE\",\n    \"url\": \"https://cdn.example.com/media/task-brief.jpg\",\n    \"title\": \"Creative brief v2\",\n    \"previewUrl\": \"https://cdn.example.com/media/task-brief_p.jpg\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"42-update-a-task--full-update","__idx":12},"children":["4.2 Update a task — full update"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v3/task?id={taskId}"]}]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TaskApiV3_updateTask"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this endpoint to replace the entire task. V2 full-update semantics remain unchanged. The API removes any fields that you omit from the request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameters","__idx":13},"children":["Query parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the task to update, or a comma-separated list of task identifiers for a bulk update."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["6a1437f751d06294d5c8773e"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-1","__idx":14},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request PUT 'https://api3.sprinklr.com/{env}/api/v3/task?id={{taskId}}' \\\n--header 'Authorization: Bearer {{accessToken}}' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"assignment\": {\n        \"assigneeId\": \"{{assigneeId}}\",\n        \"assigneeType\": \"USER\"\n    },\n    \"taskType\": \"Working task\",\n    \"taskStatus\": \"AVAILABLE\",\n    \"title\": \"Review updated creative brief\",\n    \"description\": \"Review the updated creative brief before production starts.\",\n    \"assetId\": \"{{assetId}}\",\n    \"assetType\": \"MESSAGE\",\n    \"dueDate\": 1779820200000,\n    \"customProperties\": {},\n    \"queueIds\": [\n        \"{{queueId}}\"\n    ]\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-1","__idx":15},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A successful request returns ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["200 OK"]}," and the updated task. For information about the response parameters, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#_Response_parameters"},"children":["Response field reference — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Task"]}]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"️-put-replaces--it-does-not-merge","__idx":16},"children":["⚠️ ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," replaces — it does not merge"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The example above omits ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customProperties"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueIds"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parentTaskId"]},". Under replace semantics those are unset. Before issuing a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},":"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," the current task."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Merge your changes into the retrieved document."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Map ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueDetails[].queueId"]}," back to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueIds"]}," — the read and write shapes differ (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#11-the-task-data-model"},"children":["§1.1"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," the merged result back."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you only intend to change a few fields, use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#43-update-a-task--partial-update"},"children":["§4.3"]},") instead. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," eliminates the need for a read-modify-write cycle when you update only a subset of fields."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"43-update-a-task--partial-update","__idx":17},"children":["4.3 Update a task — partial update"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/v3/task?id={taskId}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the endpoint to update specific task fields without replacing the entire task. Only the fields included in the request body are updated. Supports bulk partial updates through a comma-separated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameters-1","__idx":18},"children":["Query parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the task to update, or a comma-separated list of task identifiers for a bulk partial update."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body--taskpatchrequestdto","__idx":19},"children":["Request body — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TaskPatchRequestDTO"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updateFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[Object]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Field update operations to apply to each identified task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updateFields[].fieldName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the task field to update. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Examples: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["title"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taskStatus"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dueDate"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updateFields[].value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Any"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["New value for the field. Use the data type defined for the selected task field."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updateFields[].op"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operation to apply to the field."]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["op"]}," values come from the shared ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Operation"]}," enum."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-2","__idx":20},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request PATCH 'https://api3.sprinklr.com/{env}/api/v3/task?id={{taskId}}' \\\n--header 'Authorization: Bearer {{accessToken}}' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"updateFields\": [\n        {\n        \"op\": \"UPDATE\",\n        \"fieldName\": \"title\",\n        \"value\": \"Reviewed creative brief\"\n        },\n        {\n        \"op\": \"UPDATE\",\n        \"fieldName\": \"taskStatus\",\n        \"value\": \"IN_PROGRESS\"\n        }\n    ]\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"44-method-comparison--when-to-use-which","__idx":21},"children":["4.4 Method comparison — when to use which"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"POST"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"PUT"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"PATCH"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Purpose"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a task"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Replace the full task document"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Upsert selected fields"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Addressing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None — server assigns the ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Body schema"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TaskRequest"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TaskRequest"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TaskPatchRequestDTO"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bulk"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes, via comma-separated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes, via comma-separated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unspecified fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Unset"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Preserved"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Safe for incremental sync"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No, without read-modify-write"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Available in V2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes (path-based)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No — new in V3"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," take ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["different body schemas"]},". You cannot reuse one payload for both methods."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"45-delete-tasks","__idx":22},"children":["4.5 Delete tasks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v3/task?id={taskId1},{taskId2}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this endpoint to delete one or more tasks by ID."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameters-2","__idx":23},"children":["Query parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the task to delete, or a comma-separated list of task identifiers for a bulk delete."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-3","__idx":24},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Single delete\ncurl --location --request DELETE 'https://api3.sprinklr.com/{env}/api/v3/task?id={{taskId}}' \\\n--header 'Authorization: Bearer {{accessToken}}' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Accept: application/json'\n\n# Bulk delete\ncurl --location --request DELETE 'https://api3.sprinklr.com/{env}/api/v3/task?id={{taskId1}},{{taskId2}}' \\\n--header 'Authorization: Bearer {{accessToken}}' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note"]},": Do not confuse deletion with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["inactive"]}," flag on the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Task"]}," object. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["inactive: true"]}," marks a task as inactive but is not the same as removing it. Verify the supported soft-delete behaviour before implementing either approach."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"5-read-operations","__idx":25},"children":["5. Read operations"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"51-get-apiv3task--fetch-tasks-by-id","__idx":26},"children":["5.1 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/task"]}," — Fetch tasks by ID"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/task?id=taskId1,taskId2"]}]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TaskApiV3_getTasks"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this endpoint to retrieve one or more tasks in a single request trip."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Comma-separated list of task IDs."]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Single fetch\ncurl --location 'https://api3.sprinklr.com/{env}/api/v3/task?id=6a1437f751d06294d5c8773e' \\\n--header 'Authorization: Bearer {{accessToken}}' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Accept: application/json'\n\n# Bulk fetch\ncurl --location 'https://api3.sprinklr.com/{env}/api/v3/task?id=6a1437f751d06294d5c8773e,6a15305cad837f75fc5ac662' \\\n--header 'Authorization: Bearer {{accessToken}}' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-2","__idx":27},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A successful request returns ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["200 OK"]}," and the requested task data. The response contains an array of task objects, including when you request a single task."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"data\": [\n        {\n            \"id\": \"6a1437f751d06294d5c8773e\",\n            \"assignment\": {},\n            \"taskType\": \"Working task\",\n            \"taskStatus\": \"AVAILABLE\",\n            \"title\": \"Task\",\n            \"assetId\": \"INSTAGRAM_37_18442753900191622_ACCOUNT_600037626_1779440700000_2026_05\",\n            \"assetType\": \"MESSAGE\",\n            \"dueDate\": 1779820200000,\n            \"customProperties\": {\n                \"spr_task_status\": [\"Available\"],\n                \"spr_task_type\": [\"Working task\"],\n                \"_c_64e462458f027e15378d09c5\": [\"5\"],\n                \"_c_64c38d050e8ea978f3f12b82\": [\"v12\"],\n                \"_c_61542d4bfd7c10301568d465\": [\"Not Authenticated\"],\n                \"_c_65169c803884d32abe7e159c\": [\"Value1\"]\n            },\n            \"inactive\": false,\n            \"queueDetails\": [],\n            \"createdTime\": 1779709943117,\n            \"modifiedTime\": 1779709943117,\n            \"externalCases\": []\n        }\n    ],\n    \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-field-reference--task","__idx":28},"children":["Response field reference — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Task"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assignment"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Assignment details for the task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assignment.assigneeId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the assigned user or entity."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assignment.assigneeType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of assignee."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assignment.assignedById"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the user who assigned the task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assignment.assignmentTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Time when the user assigned the task, in epoch milliseconds."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taskType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of work represented by the task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taskStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Current status of the task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["title"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Title of the task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Description of the work required for the task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the entity for which the task was created."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of entity for which the task was created."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parentTaskId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the parent task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nextTaskId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the next task in the task sequence."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["completionDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date and time when the task was completed, in epoch milliseconds."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dueDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date and time when the task is due, in epoch milliseconds."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customProperties"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Map[String, List[String]]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom fields returned for the task. Each custom-field ID maps to an array of strings."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["inactive"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies whether the task is inactive."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["attachment"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Media or document attached to the task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[Object]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Users or entities that subscribe to task updates."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers[].type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of subscriber."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers[].ids"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Subscriber identifiers."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueDetails"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[Object]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Work queues to which the task belongs."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueDetails[].queueId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the work queue."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueDetails[].assignmentTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Time when the task entered the queue, in epoch milliseconds."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Time when Sprinklr created the task, in epoch milliseconds."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifiedTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Time when Sprinklr last modified the task, in epoch milliseconds."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workFlowState"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Current workflow execution state for the task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workFlowState.executionTokenId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the workflow execution token."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workFlowState.processVariables"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Variables associated with the workflow execution."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalCases"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[Object]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Third-party cases linked to the task."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"52-externalcases","__idx":29},"children":["5.2 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalCases"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Represents third-party cases linked to a Sprinklr universal case."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the case in the third-party system."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["caseNumber"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Case number assigned by the third-party system."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Third-party platform that manages the case."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permalink"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["URL of the case in the third-party platform."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Time when the third-party system created the case, in epoch milliseconds."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifiedTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Time when the third-party system last modified the case, in epoch milliseconds."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the Sprinklr client linked to the case."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subDomain"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Subdomain associated with the third-party case."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Map[String, String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional attributes returned for the third-party case."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"6-response-format-and-status-codes","__idx":30},"children":["6. Response format and status codes"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"61-the-v3-envelope","__idx":31},"children":["6.1 The V3 envelope"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": [ ... ],\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object or Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The task (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},") or tasks (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},") affected. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," on an error response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[Error]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error objects — empty when there are no errors"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors[].id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["24-character hex ObjectId"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors[].code"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors[].message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dotted error key, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account.not.found"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]}," are all required on an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Error"]}," object."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Partial success on bulk operations."]}," For bulk operations, some task IDs can succeed while others fail."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"62-response-codes","__idx":32},"children":["6.2 Response codes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP code"},"children":["HTTP code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Declared on"},"children":["Declared on"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Scenario"},"children":["Scenario"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Success"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204 No Content"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete succeeded, no response body"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Malformed request — for example a missing or malformed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", or an invalid body"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing or invalid authentication"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Insufficient permissions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Task not found"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}," all return the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ErrorResponse"]}," schema — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"data\": null, \"errors\": [ … ], \"metadata\": { … } }"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"7-v2--v3-migration","__idx":33},"children":["7. V2 → V3 migration"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"71-endpoint-mapping","__idx":34},"children":["7.1 Endpoint mapping"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V2"},"children":["V2"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V3"},"children":["V3"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Change"},"children":["Change"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/create-task"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v2/task"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/task"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Version segment only. Body unchanged."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/read-task"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v2/task/{taskId}"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/task?id={taskId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Path param → query param. Bulk added. Response ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," becomes an array."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/update-task"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v2/task/{taskId}"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v3/task?id={taskId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Path param → query param. Bulk added. Replace semantics retained."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["(none)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/v3/task?id={taskId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New."]}," Partial upsert."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/delete-task"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v2/task/{taskId}"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v3/task?id={taskId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Path param → query param. Bulk added."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"72-what-changed-and-what-did-not","__idx":35},"children":["7.2 What changed, and what did not"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Aspect"},"children":["Aspect"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API V2"},"children":["API V2"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API V3"},"children":["API V3"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Impact"},"children":["Impact"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Task addressing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Path segment ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/task/{taskId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Query parameter ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update all code that constructs task URLs."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bulk operations"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not supported — one task per call"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," accept comma-separated IDs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["You can replace multiple calls with a single bulk request."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partial update"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not available"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updateFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," removes the need for a read-modify-write workflow for small updates."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," response ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Single object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Array"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[0]"]},", not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response envelope"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"data\": …, \"errors\": [] }"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"data\": …, \"errors\": [] }"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unchanged"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create request body"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TaskRequest"]}," fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identical fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No change needed"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete response"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204 No Content"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204"]}," per acceptance criteria; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," per specification"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Accept both — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#45-delete-tasks"},"children":["§4.5"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partial success"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A (single-entity calls)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Possible on bulk calls"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Inspect ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"73-migration-steps","__idx":36},"children":["7.3 Migration steps"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Update the base URL"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api3.sprinklr.com/{env}/api/v3"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Move the task ID from the path to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]}]}," on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]},". This change is straightforward but must be applied throughout your codebase. Search your codebase for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["api/v2/task/"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Change ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," response parsing from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[0]"]},"."]}," If existing code expects an object instead of an array, the migration can fail without obvious errors."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Collapse N-call loops into bulk calls."]}," Replace iterative single-task requests with bulk requests where possible."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Add partial-success handling."]}," After a bulk call, reconcile returned ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," against requested IDs and inspect ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Replace read-modify-write updates with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},"."]}," Any place you ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," a task purely to change one field and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," it back is a candidate. This also removes the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueDetails"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueIds"]}," remapping step."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Accept both ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204"]}," from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]},","]}," and tolerate an empty body."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Keep your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," payloads as-is."]}," Create request bodies did not change."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"8-use-cases","__idx":37},"children":["8. Use cases"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"81-create-a-task-on-an-inbound-message","__idx":38},"children":["8.1 Create a task on an inbound message"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Scenario:"]}," an inbound Instagram message needs design work before a reply goes out."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/task"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType: \"MESSAGE\""]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetId"]}," set to the message ID, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assignment.assigneeId"]}," set to the designer, and a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dueDate"]},". Store the returned ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," — it is the only key you can use to address the task later."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"82-hydrate-a-production-dashboard","__idx":39},"children":["8.2 Hydrate a production dashboard"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Scenario:"]}," a dashboard holds 40 task IDs and needs title, status, assignee, and due date for each."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v3/task?id=id1,id2,id3,…\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can retrieve all 40 tasks in a single request. Under V2 this was 40 sequential ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v2/task/{taskId}"]}," calls; This is a primary efficiency improvement in V3."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const ids = taskIds.join(',');\nconst res = await get(`/api/v3/task?id=${ids}`);\n\nif (res.errors && res.errors.length) {\n  handleErrors(res.errors);          // partial success is possible on bulk\n}\n\nconst byId = new Map(res.data.map(t => [t.id, t]));\nconst missing = taskIds.filter(id => !byId.has(id));   // reconcile, do not assume 1:1\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"83-advance-a-tasks-status","__idx":40},"children":["8.3 Advance a task's status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Scenario:"]}," an agent moves a task from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AVAILABLE"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IN_PROGRESS"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," — not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{ \"updateFields\": [ { \"op\": \"UPDATE\", \"fieldName\": \"taskStatus\", \"value\": \"IN_PROGRESS\" } ] }\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," here would require reconstructing the whole task document, including remapping ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueDetails"]}," back to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueIds"]},", to change one string."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"84-bulk-reschedule-a-set-of-tasks","__idx":41},"children":["8.4 Bulk-reschedule a set of tasks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Scenario:"]}," A campaign is delayed by one week and 15 tasks need a new due date."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"PATCH /api/v3/task?id=id1,id2,…,id15\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{ \"updateFields\": [ { \"op\": \"UPDATE\", \"fieldName\": \"dueDate\", \"value\": 1780425000000 } ] }\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updateFields"]}," set is applied to every listed task. If the tasks need ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["different"]}," due dates, issue one call per distinct value."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"85-full-sync-from-an-external-project-management-tool","__idx":42},"children":["8.5 Full sync from an external project-management tool"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Scenario:"]}," an external PM tool owns task state and pushes the complete record."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v3/task?id=…"]}," with the full ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TaskRequest"]},". Because the external tool is authoritative, replace semantics are correct. Still ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," first if Sprinklr-side agents can edit custom fields, subscribers, or queues — otherwise the sync erases their work (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#42-update-a-task--full-update"},"children":["§4.2"]},")."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"86-clean-up-a-batch-of-cancelled-tasks","__idx":43},"children":["8.6 Clean up a batch of cancelled tasks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Scenario:"]}," a cancelled campaign leaves 8 orphaned tasks."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"DELETE /api/v3/task?id=id1,id2,…,id8\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Handle both ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204 No Content"]}," as successful responses, and re-",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," the IDs if you need positive confirmation of removal."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"9-caveats-and-best-practices","__idx":44},"children":["9. Caveats and best practices"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method selection"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Default to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," for edits. Use PUT only when you have the complete authoritative task document."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," request can remove queue membership, subscribers, and custom properties if you omit them."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," take different body schemas. Payloads are not interchangeable."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Identifiers and shapes"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Task IDs are 24-character hex ObjectId strings."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," as an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["array"]},", even for a single ID. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," as an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["object"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You write ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueIds"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Array[String]"]},"); you read ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueDetails"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Array[Queue]"]},", with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queueId"]}," as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["int64"]},"). Do not use a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," response directly in a write operation without remapping fields."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["All timestamps — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dueDate"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["completionDate"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdTime"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifiedTime"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assignmentTime"]}," — are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["epoch milliseconds"]},", not seconds and not ISO-8601."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Bulk operations"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Provide multiple IDs as a comma-separated list in the id query parameter. Do not repeat the parameter"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Bulk calls can partially succeed. Reconcile returned ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," against requested IDs and always inspect ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The specification does not state a maximum number of IDs per call. Verify the supported bulk-request limit before sending large batches."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom properties"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customProperties"]}," is a map of custom-field ID → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Array[String]"]}]},". Even single-valued fields take a list."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["spr_task_status"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["spr_task_type"]}," are platform-maintained mirrors of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taskStatus"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taskType"]},". Set the top-level fields, not the mirrors."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Error handling"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Always inspect the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," array even on a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," response."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]}," response typically indicates insufficient permissions."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Code defensively for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["429"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["5xx"]}," even though the specification does not declare them for these operations."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]}]},"headings":[{"value":"Task API V3 — Developer Guide","id":"task-api-v3--developer-guide","depth":1},{"value":"1. Overview","id":"1-overview","depth":2},{"value":"1.1 The task data model","id":"11-the-task-data-model","depth":3},{"value":"1.2 Addressing a task","id":"12-addressing-a-task","depth":3},{"value":"2. Base URLs and environments","id":"2-base-urls-and-environments","depth":2},{"value":"3. Authentication and common headers","id":"3-authentication-and-common-headers","depth":2},{"value":"4. Write operations","id":"4-write-operations","depth":2},{"value":"4.1 Create a task","id":"41-create-a-task","depth":3},{"value":"Request body","id":"request-body","depth":4},{"value":"Request","id":"request","depth":4},{"value":"Response","id":"response","depth":4},{"value":"4.1.1 attachment","id":"411-attachment","depth":4},{"value":"4.2 Update a task — full update","id":"42-update-a-task--full-update","depth":3},{"value":"Query parameters","id":"query-parameters","depth":4},{"value":"Request","id":"request-1","depth":4},{"value":"Response","id":"response-1","depth":4},{"value":"⚠️ PUT replaces — it does not merge","id":"️-put-replaces--it-does-not-merge","depth":4},{"value":"4.3 Update a task — partial update","id":"43-update-a-task--partial-update","depth":3},{"value":"Query parameters","id":"query-parameters-1","depth":4},{"value":"Request body — TaskPatchRequestDTO","id":"request-body--taskpatchrequestdto","depth":4},{"value":"Request","id":"request-2","depth":4},{"value":"4.4 Method comparison — when to use which","id":"44-method-comparison--when-to-use-which","depth":3},{"value":"4.5 Delete tasks","id":"45-delete-tasks","depth":3},{"value":"Query parameters","id":"query-parameters-2","depth":4},{"value":"Request","id":"request-3","depth":4},{"value":"5. Read operations","id":"5-read-operations","depth":2},{"value":"5.1 GET /api/v3/task — Fetch tasks by ID","id":"51-get-apiv3task--fetch-tasks-by-id","depth":3},{"value":"Response","id":"response-2","depth":4},{"value":"Response field reference — Task","id":"response-field-reference--task","depth":4},{"value":"5.2 externalCases","id":"52-externalcases","depth":3},{"value":"6. Response format and status codes","id":"6-response-format-and-status-codes","depth":2},{"value":"6.1 The V3 envelope","id":"61-the-v3-envelope","depth":3},{"value":"6.2 Response codes","id":"62-response-codes","depth":3},{"value":"7. V2 → V3 migration","id":"7-v2--v3-migration","depth":2},{"value":"7.1 Endpoint mapping","id":"71-endpoint-mapping","depth":3},{"value":"7.2 What changed, and what did not","id":"72-what-changed-and-what-did-not","depth":3},{"value":"7.3 Migration steps","id":"73-migration-steps","depth":3},{"value":"8. Use cases","id":"8-use-cases","depth":2},{"value":"8.1 Create a task on an inbound message","id":"81-create-a-task-on-an-inbound-message","depth":3},{"value":"8.2 Hydrate a production dashboard","id":"82-hydrate-a-production-dashboard","depth":3},{"value":"8.3 Advance a task's status","id":"83-advance-a-tasks-status","depth":3},{"value":"8.4 Bulk-reschedule a set of tasks","id":"84-bulk-reschedule-a-set-of-tasks","depth":3},{"value":"8.5 Full sync from an external project-management tool","id":"85-full-sync-from-an-external-project-management-tool","depth":3},{"value":"8.6 Clean up a batch of cancelled tasks","id":"86-clean-up-a-batch-of-cancelled-tasks","depth":3},{"value":"9. Caveats and best practices","id":"9-caveats-and-best-practices","depth":2}],"frontmatter":{"seo":{"title":"Task API V3 — Developer Guide"}},"lastModified":"2026-10-22T18:27:14.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/developer-guides-v3/task-api-v3-developer-guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}