Skip to main content
POST
Archive a client fact

Authorizations

Authorization
string
header
required

A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.

Path Parameters

fact
string
required

The fact key, such as firm_bonus, from list_fact_definitions.

Required string length: 1 - 60

Body

application/json

The body is of type object.

Response

Success.

object
enum<string>
required
Available options:
fact_definition
id
string | null
required

Null for a built-in fact.

key
string
required

Such as salary, or firm_ and a slug for a fact the firm made.

label
string
required
type
enum<string>
required

text, date (YYYY-MM-DD) or amount (dollars).

Available options:
text,
date,
amount
single
boolean
required

A client holds one value, so accepting a new one replaces the old.

origin
enum<string>
required

redbark for Redbark's own, which cannot be changed; firm for the firm's own.

Available options:
redbark,
firm
archived
boolean
required

Filled from no new document. Values already accepted stay.

filled_by
object[]
required

The document fields that fill it.

clients_with_value
number
required

Clients holding an accepted value of it.