Update QR Code Address

Update QR Code Address

PATCH /api/qrcodes/uuid/{uuid}

Update one or more fields of an existing QR code address. Only the fields provided in the request body will be modified.

Path Parameters

Parameter Type Required Description
uuid string Yes UUID of the QR code address (path parameter)

Request Body

Parameter Type Required Description
address_line_1 string No Street address
address_line_2 string No Unit / Apartment
suburb string No Suburb or city
state string No State or province
postcode string No Postal code
country string No Country name
type string No Type: SITE or CLIENT_HOME
status string No Status: ACTIVE or INACTIVE
name string No Name or label for the QR code address
deleted boolean No Soft-delete the QR code address

Example

json
{
    "address_line_1": "123 Main Street",
    "address_line_2": "Suite 4",
    "suburb": "Melbourne",
    "state": "VIC",
    "postcode": "3000",
    "country": "Australia",
    "organization_uuid": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "type": "SITE",
    "name": "Main Office",
}

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

Error Codes

Status Meaning
400 Bad Request
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/qrcodes/uuid/d290f1ee-6c54-4b01-90e6-d701748f0851 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your_api_key:your_api_secret" \
  -d '{
    "address_line_1": "123 Main Street",
    "address_line_2": "Suite 4",
    "suburb": "Melbourne",
    "state": "VIC",
    "postcode": "3000",
    "country": "Australia",
    "type": "SITE",
    "name": "Main Office",
  }'

Try It

Try it

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

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

Example Response

json
{
  "uuid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "address_line_1": "456 New Street",
  "address_line_2": null,
  "suburb": "Sydney",
  "state": "NSW",
  "postcode": "2000",
  "country": "Australia",
  "location": "456 New Street, Sydney NSW 2000, Australia",
  "latitude": -33.8688,
  "longitude": 151.2093,
  "organization_uuid": "org-uuid-here",
  "status": "ACTIVE",
  "type": "SITE",
  "name": "Updated Office",
  "deleted": false,
  "created_on": "2025-01-15T10:30:00Z",
  "updated_on": "2025-01-16T14:00:00Z"
  "deleted_on": null,
}