Update

API Reference

Todos

Update

client.todos.update(stringid, TodoUpdateParamsbody?, RequestOptionsoptions?): idstringcompleted_atunioncreated_atstringdescriptionuniontagsarraytitlestringupdated_atstringTodo

put/v1/todos/{id}

Parameters

idstring

bodycompleted_atuniondescriptionuniontag_idsarraytitlestringTodoUpdateParams

Hide ParametersShow Parameters

completed_atunion

optional

string | null

descriptionunion

optional

string | null

tag_idsarray

optional

Array<string>

titlestring

optional

Returns

idstringcompleted_atunioncreated_atstringdescriptionuniontagsarraytitlestringupdated_atstringTodo

HTTPTypeScript

import TodoNinja from 'todo-ninja';

const client = new TodoNinja({
  bearerToken: 'My Bearer Token',
});

const todo = await client.todos.update('todo_nc6bzmkmd014706rfda898to');

console.log(todo.id);

200 Example

{
  "id": "todo_nc6bzmkmd014706rfda898to",
  "completed_at": "2021-01-01T00:00:00.000Z",
  "created_at": "2021-01-01T00:00:00.000Z",
  "description": "Get butter, milk, and bread",
  "tags": [
    {
      "id": "tag_tz4a98xxat96iws9zmbrgj3a",
      "created_at": "2021-01-01T00:00:00.000Z",
      "label": "Work",
      "updated_at": "2021-01-01T00:00:00.000Z"
    }
  ],
  "title": "Buy groceries",
  "updated_at": "2021-01-01T00:00:00.000Z"
}