Update a Site Record Type

put/public/v1/site-record-types/{siteRecordType}

Only the fields you send are changed. Sending required_for_site_tags replaces the whole list; send an empty list to clear it.

put/public/v1/site-record-types/{siteRecordType}

curl --request PUT \
  --url 'https://api.app.astalty.com.au/public/v1/site-record-types/{siteRecordType}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "expires": true,
  "required": true,
  "requires_documents": true,
  "visible_to_support_workers": true,
  "required_for_site_tags": [
    {
      "id": "string"
    }
  ]
}'

Response

{
  "data": {
    "id": "s1r2t3y4-p5e6-47f8-9a0b-1c2d3e4f5a6b",
    "name": "NDIS Service Agreement",
    "expires": true,
    "required": true,
    "requires_documents": true,
    "visible_to_support_workers": true,
    "created_at": "2024-01-15T10:30:00+00:00",
    "archived_at": "2024-01-15T10:30:00+00:00",
    "required_for_site_tags": [
      {
        "id": "s1i2t3e4-t5a6-47g8-9b0c-1d2e3f4a5b6c",
        "name": "Vacancy",
        "colour": "#e30425",
        "created_at": "2024-01-15T10:30:00+00:00"
      }
    ]
  }
}

Authorization

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

Path parameters

siteRecordTypestringrequired
The site record type UUID

Body

application/json

namestringmax length 255
expiresboolean
requiredboolean
requires_documentsboolean
visible_to_support_workersboolean
required_for_site_tagsobject[]max items 5000
▶Show 1 child attributesHide child attributes
- idstringrequired

Response

200application/json

App.PublicApi.V1.SiteRecordTypes.SiteRecordTypeResource

dataobjectrequired
▶Show 9 child attributesHide child attributes
- idstringrequired
  Example:s1r2t3y4-p5e6-47f8-9a0b-1c2d3e4f5a6b
- namestringrequired
  Example:NDIS Service Agreement
- expiresbooleanrequired
  Example:true
- requiredbooleanrequired
  Example:true
- requires_documentsbooleanrequired
  Example:true
- visible_to_support_workersbooleanrequired
  Example:true
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- archived_atstring | nullrequired
  Example:2024-01-15T10:30:00+00:00
- required_for_site_tagsobject[]required
  ▶Show 4 child attributesHide child attributes
  idstringrequired
  Example:s1i2t3e4-t5a6-47g8-9b0c-1d2e3f4a5b6c
  namestringrequired
  Example:Vacancy
  colourstring | nullrequired
  Example:#e30425
  created_atstringrequired
  Example:2024-01-15T10:30:00+00:00

Errors

401Unauthenticated
403Authorization error
404Not found
422Validation error