Command Palette

Search for a command to run...

Log In

Update a Site Record

put/public/v1/site-records/{siteRecord}

Accepts documents as temporary upload ids, to attach a replacement document when a certificate is reissued.

  • Authorizationstringrequired

    Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

  • siteRecordstringrequired

    The site record UUID

Body

application/json
  • issue_datestring<date>required
  • expiry_datestring
  • referencestring | nullmax length 255

Response

200application/json

SiteRecordResource

  • dataobjectrequired
    ▶Show 9 child attributes
    • idstringrequired
      Example:r1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b
    • namestring | nullrequired
      Example:Fire Safety Certificate
    • referencestring | nullrequired
      Example:REF-12345
    • statusstringrequired
      Example:current
    • issue_datestring | nullrequired
      Example:2024-01-15T00:00:00+00:00
    • expiry_datestring | nullrequired
      Example:2025-01-15T00:00:00+00:00
    • created_atstringrequired
      Example:2024-01-15T10:30:00+00:00
    • siteobjectrequired
      ▶Show 2 child attributes
      • idstringrequired
        Example:s1t2e3a4-b5c6-47d8-9e0f-1a2b3c4d5e6f
      • namestringrequired
        Example:Main Office
    • record_typeobjectrequired
      ▶Show 2 child attributes
      • idstringrequired
        Example:rt1a2b3c-d4e5-6f7a-8b9c-0d1e2f3a4b5c
      • namestringrequired
        Example:Fire Safety Certificate
  • 401Unauthenticated
  • 403Authorization error
  • 404Not found
  • 422Validation error