VTvtex
Task

Update task

Changed on

Updates the status of a VTEX DO task, filtering by task ID.

Permissions

This endpoint does not require License Manager resources.

put/tasks/{taskId}

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br/api/do
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/do/tasks/{taskId}
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

Path parameters

taskIdstring required
Example:123456abc

Task ID.

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

status'Open' | 'Closed' | 'Suspended' | 'InProgress' required

Task status update.

Example request

{
  "status": "InProgress"
}

Response

OK

unknown required

Changes

  • fcdd3eb25f83Revision changes
    • breaking

      removed the enum value Active of the request property

    • breaking

      removed the enum value Canceled of the request property

    • breaking

      removed the enum value Canceling of the request property

    • breaking

      removed the enum value Deleted of the request property

    • breaking

      removed the enum value Disabled of the request property

    • breaking

      removed the enum value Done of the request property

    • breaking

      removed the enum value InQueue of the request property

    • breaking

      removed the enum value Processing of the request property

    • info

      added the new Closed enum value to the request property

    • info

      added the new Open enum value to the request property

    • info

      added the new Suspended enum value to the request property

  • 0f098ad343e4Revision changes
    • info

      added the new InProgress enum value to the request property