Skip to main content
PATCH
Update referral_sources

Authorizations

Authorization
string
header
required

API key from Developers → API Keys, sent as Authorization: Bearer .

Path Parameters

id
integer
required

Body

application/json
name
string

The source's display name, up to 255 characters, unique per account.

Maximum string length: 255
visibility
enum<string>

public or private: public sources are offered on online booking and public form lists, private ones only in-house.

Available options:
public,
private
active
boolean

Whether the source can still be picked — patients.referral_source_id must name an active row. Deactivate instead of deleting; there is no DELETE.

category
integer | null

Optional integer grouping. The PracticeHub UI doesn't set it; carried for legacy data.

sort_order
integer | null

Position in the account's referral source lists.

metadata
object

Integrator-owned key/value metadata (max 50 keys). Values are strings (≤500 chars), numbers or booleans and read back with the type they were written with. On write, a null value removes the key. Filter with metadata[key]=op:value; number operands compare numerically.

Response

The resource

data
object
Example: