Skip to main content
PATCH
Update a Custom Link
Requires custom_links:write. Only fields present in the request are changed. Hobbes creates a thumbnail job only when a thumbnail-affecting field changes; those updates also require an Idempotency-Key header.

Authorizations

Authorization
string
header
required

Hobbes API key with the hb_live_ prefix.

Headers

Idempotency-Key
string | null
Required string length: 1 - 255

Path Parameters

Custom Link UUID.

Body

application/json
displayName
string | null
Required string length: 1 - 255
firstName
string | null
Maximum string length: 255
lastName
string | null
Maximum string length: 255
email
string | null
Maximum string length: 255
phone
string | null
Maximum string length: 50
role
string | null
Maximum string length: 255
company
string | null
Maximum string length: 255
context
string | null
Maximum string length: 10000
shareTitle
string | null
Maximum string length: 255
shareDescription
string | null
Maximum string length: 500
shareThumbnailUrl
string<uri> | null
Required string length: 1 - 2083
prospectLogoUrl
string<uri> | null
Required string length: 1 - 2083
prospectDomain
string | null
Maximum string length: 255
active
boolean | null
campaign
CampaignReference · object | null

Response

Successful Response

job
CustomLinkJobResponse · object | null