Sign in

v1

latestOpenAPI 3.0.02026-07-148061.0 KB
Task

Create task

Creates a new task in VTEX DO.

Permissions

This endpoint does not require License Manager resources.

post/tasks

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

domainstring required

Task domain in the VTEX environment.

contextstring required

Task context.

namestring required

Task name.

prioritystring required

Task level of priority.

surrogateKeystring nullable required

Surrogate key unique identifier of the task.

descriptionstring

Additional task comment.

dueDatestring required

Task deadline in hh:mm:ss format.

parentTaskIdstring nullable

Parent task ID of another task related the task being created, when applicable.

Example request

{
  "target": [
    {
      "id": "v964735bdev-01",
      "type": "order",
      "url": "https://basedevmkp.environment.com.br/admin/checkout/#/orders/v964741bdev-01"
    }
  ],
  "domain": "oms",
  "context": "Marketplace",
  "name": "pricing",
  "priority": "Critical",
  "surrogateKey": "5052243-0",
  "description": "This task is important",
  "dueDate": "2024-05-01",
  "assignee": {
    "name": "Blake Smith",
    "email": "blake.smith@email.com"
  },
  "followers": [
    {
      "name": "Celaena Sardothien",
      "email": "celaena.sardothien@email.com"
    }
  ]
}

Response

OK

{"stackTrail":"paths:/tasks:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}