Action items

Update action item

Updates the title, description, status, or assignee of an action item. Returns the updated action item.

put/action-item/{actionItemId}

Request

Base URL: https://circleback.ai/api
URL: https://circleback.ai/api/action-item/{actionItemId}
Auth: HTTP bearer

Path parameters

actionItemIdinteger required

The unique identifier of the action item.

Request body

titlestring

The title of the action item.

descriptionstring

The detailed description of the action item.

assigneeProfileIdinteger nullable

The ID of the profile to assign the action item to, or null to remove the assignee.

status'PENDING' | 'DONE'

The completion status of the action item.

Response

Successful response.

idnumber required

The unique identifier of the action item.

titlestring required

The title of the action item.

descriptionstring required

The detailed description of the action item.

completedAtstring date-time nullable required

The time the action item was marked as done, or null if it is not completed.

status'PENDING' | 'DONE' required

The completion status of the action item.

meetingIdsstring[] required

The IDs of the associated meetings you can access. Empty if the action item has no accessible meetings.

Example response

{
  "id": 252,
  "title": "Contact event venues",
  "description": "Reach out to Sunriver Events and other potential event venues to see if they would be open to hosting the event this summer.",
  "status": "PENDING",
  "meetingIds": [
    "WRweb12iCBimU6Vo8cD7z"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.