Skip to main content
PATCH
Update an object

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer aw_live_…. Manage keys in the dashboard under Settings → API Keys.

Path Parameters

id
string<uuid>
required

Body

application/json
type
string
Required string length: 1 - 64
Pattern: ^[A-Za-z0-9-]+$
external_id
string | null
name
string | null
description
string | null
metadata
object
destination
object
is_active
boolean
article_ids
string<uuid>[]

Articles this resource links as knowledge. When a visitor scans it and lands on a chatbot, the chatbot searches its own knowledge plus these articles — so item-specific content (a room's TV manual) can live here instead of on the shared chatbot. Replace-only on write: send the full desired set, omit to leave untouched, [] to detach all.

Example:
category_ids
string<uuid>[]

Article categories (folders) this resource links as knowledge. A linked category includes every article inside it and its sub-categories, now and in future. Replace-only on write: send the full desired set, omit to leave untouched, [] to detach all.

Example:

Response

Updated object

object
string
required
Allowed value: "object"
id
string<uuid>
required
type
string
required
external_id
string | null
required
public_slug
string
required
url
string<uri>
required
name
string | null
required
description
string | null
required
metadata
object
required
destination
object
required
is_active
boolean
required
total_scans
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
last_scanned_at
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
created_at
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
updated_at
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
article_ids
string<uuid>[]
required

Articles this resource links as knowledge. When a visitor scans it and lands on a chatbot, the chatbot searches its own knowledge plus these articles — so item-specific content (a room's TV manual) can live here instead of on the shared chatbot. Replace-only on write: send the full desired set, omit to leave untouched, [] to detach all.

Example:
category_ids
string<uuid>[]
required

Article categories (folders) this resource links as knowledge. A linked category includes every article inside it and its sub-categories, now and in future. Replace-only on write: send the full desired set, omit to leave untouched, [] to detach all.

Example: