Skip to content
campaiDeveloper
campai.com

Misc · Todo · Items

POST/{organizationId}/misc/todo/items/{itemId}

Update todo item

Updates the editable details of a todo item

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Permission checks in detail
Required permissions
  • todoItem.edit
Also checked, depending on the request and the records it touches
  • conversation.read

Request

Path parameters

  • organizationIdidrequired
  • itemIdidrequired

Body

Content-Type: application/json

  • titlestringrequired

    1–140 characters

  • descriptionstringrequired

    1–10000 characters

  • customFieldsobject of one of 7 types | object of one of 7 types | object (recursive)[] | (one of 7 types)[][]required

    The answers of a form, by the ID of each field. A repeating group holds a list of its entries under its own ID.

  • tagsstring[]required

    at most 20 items · each 1–40 characters

  • dueDatestring · date-timerequirednullable
  • projectIdidnullable
  • expectedUpdatedAtstring · date-timerequirednullable
  • parentItemIdidrequirednullable
  • attachmentsobject[]required

    at most 10 items

    3 properties
    • fileNamestring

      at most 128 characters

    • resourcestringrequired
    • idstring

      exactly 6 characters

  • contextobjectrequirednullable
    Variant 1: 2 properties
    • typestringrequired
    • teamIdidrequirednullable
    Variant 2: 2 properties
    • typestringrequired
    • eventIdidrequirednullable
    Variant 3: 2 properties
    • typestringrequired
    • resourceIdidrequirednullable
    Variant 4: 2 properties
    • typestringrequired
    • conversationIdidrequirednullable
  • assignees(object)[]

    at most 100 items

    Variant 1: 2 properties
    • typestringrequired
    • userIdstringrequired

      16–64 characters

    Variant 2: 2 properties
    • typestringrequired
    • contactIdidrequired
  • reviewerUserIdstringnullable

    16–64 characters

Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/items/YOUR_ITEM_ID' \
  --header 'X-API-Key: YOUR_API_KEY'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

No response body is specified.

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.