API reference / Customers
Change the settings of customers
Says which events mean that a customer began to use the product, what steady use is, whether Troopy reads PostHog for what customers do, and the name of the product in the surveys. Send only what changes. Owners and admins only.
/api/v1/customer-settingsOther ways to call it
troopy customers setBody
application/jsonactivationarray<string>At most 10 items
successobject3 properties
eventsarray<string>The names of the events of steady use. Empty: the activation events
At most 10 items
daysintegerOn how many days a customer must do one of them
At least 1 · At most 14
windowintegerWithin how many days in a row
At least 1 · At most 60
posthogbooleansuggestbooleanproductstringThe name of the product in the questions of the surveys. Empty: the name of the business
At most 60 characters
Response
200 · application/jsondata*object13 properties
connected*booleanWhether a payment provider is connected in the workspace
providers*array<object>The payment providers that Troopy reads customers from, and which of them the workspace connected
3 properties
id*enum<string>stripelemonsqueezypolarpaddledodopayments
name*stringconnected*booleansyncedAt*string | nullWhen Troopy last read the customers
syncing*booleanA read waits or runs now
error*string | nullWhat the last read said, when it failed
customers*integerhistory*enum<string>reading: Troopy still reads the older payments, so revenue is not whole yet
readingdone
activation*array<string>The names of the events that mean a customer began to use the product: goals of the tracking script, events of PostHog, or events of the backend
success*objectSteady use: one of the events, on some days within a window of days
3 properties
events*array<string>The names of the events of steady use. Empty: the activation events
At most 10 items
days*integerOn how many days a customer must do one of them
At least 1 · At most 14
window*integerWithin how many days in a row
At least 1 · At most 60
posthog*booleanTroopy also reads what customers do from the PostHog of the workspace
suggest*booleanA teammate suggests the type and the themes of what customers said. A person accepts each one
product*stringThe name of the product in the questions of the surveys
users*integerThe customers that Troopy knows as users of the product