Skip to main content
PUT
Update the matching account, or create it

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Query Parameters

match
enum<string>
required

The key that finds the account to update; its value comes from the body

Available options:
crm_account_id,
domain

Body

application/json
alias_domains
string[]

Further domains of the account

arr
integer

Annual recurring revenue, whole dollars

crm_account_id
string

The account's id in your CRM

domain
string

The account's web domain, e.g. acme.com; normalised and lowercased

fields
Fields · object | null

Custom field keys to values

name
string

The account's name

renewal_date
string<date>

YYYY-MM-DD

type
string

One of the account types describe lists

Response

Successful Response

id
string
required
result
enum<string>
required
Available options:
created,
updated
account_summary__s_
string | null
arr
integer | null
crm_account_id
string | null
currency
string | null
domain
string | null
experience_health
string | null
feature_requests_health
string | null
fields
Fields · object
health
string | null
health_summary
string | null
hierarchy
string | null
last_activity_date
string | null
name
string | null
outcomes_health
string | null
owner_names
string[]
owners
AccountOwner · object[]
parent
string | null
product_usage_health
string | null
relationship_health
string | null
renewal_date
string | null
risks_health
string | null
type
string | null