Update Line Todo List

User Guide > Resources > Update Line Todo List

This request changes the line todo list, you can add or remove items from the todo list.

Resource

PATCH /me/todo_lines/<OID>

Where OID is the object ID of the phone line.

Parameters

None

Payload

Patch Document

Fields

name Patch Operations

x1ListItems.comments

replace

x1ListItems.communcation

replace

x1ListItems.orderNumber

replace

x1ListItems.assignedTo

replace

x1ListItems.status

replace

x1ListItems.startTime

replace

x1ListItems.endTime

replace

x1ListItems.reminders

add, remove, replace submember

Response

None

Context

Authorization

User

Errors

Common Errors

Example

Request
PATCH https://xelion.nl/api/v1/master/me/todo_lines/1651614
Payload

add an item to the todo list, value is the Referable oid

{
  "operations": [
      {
      "op": "add",
      "path": "/x1ListItems/1"
      "value": "1651479"
      },
      {
      "op": "replace",
      "path": "/x1ListItems/1/communication"
      "value": "1486979"
      },
      {
      "op": "replace",
      "path": "/x1ListItems/1/comments"
      "value": "do this fast"
      },
      {
      "op": "replace",
      "path": "/x1ListItems/1/assignedTo"
      "value": "1651218"
      },
      {
      "op": "replace",
      "path": "/x1ListItems/1/status"
      "value": "booked"
      }
      {
      "op": "replace",
      "path": "/x1ListItems/1/startTime"
      "value": "2023-02-09 14:00:00"
      }
    ]
}

edit an existing item of the todo list, value is the X1ListItem oid

{
  "operations": [
      {
      "op": "replace",
      "path": "/x1ListItems/234562/comments"
      "value": "do this now"
      },
      {
      "op": "add",
      "path": "/x1ListItems/234562/reminders/1"
      },
      {
      "op": "replace",
      "path": "/x1ListItems/234562/reminders/1/reminderDateEnum"
      "value": "_10_MINUTES"
      }
    ]
}

remove an item from the todo list, value is the X1ListItem oid
do not use the referable oid, because it could be added multiple times to the todo list!

{
    "operations": [
            {
            "op": "remove",
            "path": "/x1ListItems/234562"
            }
    ]
}