Update QR Code Tag

PATCH /api/qrcode-tags/uuid/{uuid}

Update one or more fields of an existing QR code tag. All body fields are optional — only provided fields will be updated.

Path Parameters

Parameter	Type	Required	Description
`uuid`	string	Yes	UUID of the tag to update

Request Body

Parameter	Type	Required	Description
`tag_display_name`	string	No	Updated display name for the client
`tag_name`	string	No	Updated internal name of the client
`tag_number`	string	No	Updated unique number for the client
`status`	string	No	Status: `ACTIVE` or `INACTIVE`
`type`	string	No	Tag type: `SITE` or `CLIENT`
`deleted`	boolean	No	Soft-delete the client
`service_alert_recipients`	array	No	List of notification recipients
`cancel_scheduled_subscription`	boolean	No	Set to `true` to cancel the scheduled subscription

Service Alert Recipient

Each recipient object in service_alert_recipients:

Field	Type	Required	Description
`contact_type`	string	Yes	Type of contact (e.g. `email`, `phone`)
`contact_value`	string	Yes	Contact email or phone number
`contact_name`	string	No	Name of the contact person
`formatted_phone_number`	string	Yes	Formatted phone number (if contact type is phone)
`is_active`	boolean	No	Whether this recipient is active

Example

json

{
  "tag_display_name": "Updated Entrance",
  "status": "INACTIVE"
}

See Errors & Rate Limits for the common error contract used across the API.

Error Codes

Status	Meaning
400	Bad Request — validation error or duplicate tag
401	Unauthorized
403	Access Denied or subscription required
404	Not Found
500	Internal Server Error

Example Request

curl

curl -X PATCH http://staging.didyougo.com.au/api/qrcode-tags/uuid/XYZ789UVW123RST456MNOP \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your_api_key:your_api_secret" \
  -d '{
    "tag_display_name": "Updated Entrance",
    "status": "INACTIVE"
  }'

Try It

Try it

Authorization Required

Requests are sent without cookies — you must provide a valid Bearer <api_key>:<api_secret> header.

Request Body JSON

API Response

Click the Send API Request button above and see the response here!

Example Response

json

{
  "uuid": "XYZ789UVW123RST456MNOP",
  "qr_code_uuid": "ABC123DEF456GHI789JKLM",
  "tag_display_name": "Updated Entrance",
  "tag_name": "entrance-01",
  "tag_number": "TAG-001",
  "type": "SITE",
  "status": "INACTIVE",
  "deleted": false,
  "is_favourite": false,
  "created_on": "2025-01-15T10:30:00Z",
  "updated_on": "2025-01-16T14:00:00Z",
  "deleted_on": null
}