Skip to main content

End-to-End Examples

This page collects copy-ready workflows for common integration tasks.

Create a Site Visit With Site Assets​

POST /api/v1/site-visits
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json
Idempotency-Key: 0f7d1a6e-9642-41ba-aed5-77aa357c1ca6
{
  "clientSiteId": "DEMO-STORE-100",
  "description": "Replace damaged kiosk screen",
  "clientTicketNumber": "CLIENT-TKT-10027",
  "serviceType": "Break / Fix",
  "jobInstructions": "Check in with store manager before opening the equipment.",
  "projectId": 123,
  "itemName": "TEST ITEM",
  "startDate": "2026-04-15T16:00:00Z",
  "dueDate": "2026-04-16T01:00:00Z",
  "arePartsRequired": false,
  "partsReturnRequired": false,
  "schedulingRule": "Date/Time Specific",
  "siteAssetIds": [456, 457]
}

Reconcile Assigned Assets on an Existing Site Visit​

PATCH /api/v1/site-visits/{id}
Authorization: Bearer YOUR_ACCESS_TOKEN
If-Match: "1"
Content-Type: application/json
{
  "siteAssetIds": [457]
}

Confirm Assigned Assets​

GET /api/v1/site-visits/{id}
Authorization: Bearer YOUR_ACCESS_TOKEN

Look for:

  • assetsToService
  • siteVisitAssets

Invalid Cross-Site Assignment​

If you submit a siteAssetId that belongs to a different site than the site visit, the API returns 409 Conflict.

For broader setup and authentication steps, start with the Getting Started flow.