Skip to main content
POST
/
action-items
/
{id}
/
complete
Complete an action item
curl --request POST \
  --url https://sitevisit.app/api/v1/action-items/{id}/complete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "completed_by": "<string>",
  "completion_note": "<string>",
  "completion_photo_key": "<string>"
}
'
{
  "id": "<string>",
  "siteVisitId": "<string>",
  "propertyId": "<string>",
  "propertyName": "<string>",
  "title": "<string>",
  "evidenceImageUrls": [
    "<string>"
  ],
  "order": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "category": "<string>",
  "location": "<string>",
  "assignee": "<string>",
  "timestampSec": 123,
  "transcriptQuote": "<string>",
  "completedAt": "2023-11-07T05:31:56Z",
  "completedBy": "<string>",
  "completionNote": "<string>",
  "completionPhotoUrl": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional idempotency key, scoped to the authenticated account. Repeating a write with the same key + same body returns the original response; same key + different body returns 422 idempotency_key_in_use.

Maximum string length: 255

Path Parameters

id
string
required

Body

application/json
completed_by
string
required
Required string length: 1 - 100
completion_note
string
Maximum string length: 5000
completion_photo_key
string

R2 storage key from a previous presigned upload. The capture-token flow makes uploading from a phone easy.

Maximum string length: 500

Response

Resource updated.

id
string
required
siteVisitId
string
required
propertyId
string
required
propertyName
string
required
title
string
required
priority
enum<string>
required
Available options:
LOW,
MEDIUM,
HIGH
status
enum<string>
required
Available options:
OPEN,
IN_PROGRESS,
DONE
evidenceImageUrls
string[]
required
order
integer
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
description
string | null
category
string | null
location
string | null
assignee
string | null
timestampSec
number | null
transcriptQuote
string | null
completedAt
string<date-time> | null
completedBy
string | null
completionNote
string | null
completionPhotoUrl
string | null