Updates a connection's metadata. Uses merge semantics: new keys are added, existing keys are updated, keys set to null are removed.
Authentication required.
Path Params
id
string
required
The Connection ID or slug
Body Params
metadata
object
Arbitrary key-value pairs to set on an entity. Uses merge semantics: new keys are added, existing keys are updated, keys set to null are removed. Keys must be alphanumeric/underscore, max 40 characters. Values must be scalars (string, number, boolean) or null (to delete). Max 50 keys, 32KB total.
PUT
https://api.are.na/v3/connections/{id}
Full connection resource with abilities and links.
id
integer!
Unique identifier for the connection
position
integer!
Position of the item within the channel (1-indexed)
pinned
boolean!
Whether the item is pinned
metadata
Metadata
Custom key-value metadata
Metadata
Metadata
Arbitrary key-value pairs stored on an entity.
[key: string]
string | number | boolean
unknown
null
connected_at
string (date-time)!
When the item was connected
connected_by
EmbeddedUser!
User who created this connection
EmbeddedUser
EmbeddedUser
Embedded user representation (used when user is nested in other resources)
id
integer!
Unique identifier for the user
type
string!
User type
User
name
string!
User's display name
slug
string!
URL-safe identifier (use this in API paths)
avatar
string | null (uri)!
URL to user's avatar image
initials
string!
User's initials
unknown
null
can
ConnectionAbilities!
Actions the current user can perform on this connection
remove
boolean!
Whether the user can remove this connection
_links
Links!
HATEOAS links for navigation and discovery.
self
Link!
A hypermedia link containing the URL of a linked resource.
href
string (uri)!
The URL of the linked resource
[key: string]
Link
A hypermedia link containing the URL of a linked resource.
href
string (uri)!
The URL of the linked resource