Skip to main content
PATCH
Change the Pendo config

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.

Body

application/json

Only what you send changes; the rest, and every query, stay.

account_id_field
string | null

The Pendo account field that holds the CRM account ID, for example salesforce.accountid. It is a group and a field joined by a dot, such as custom.crm_id, and the group is not metadata. null or an empty text clears it. The save is refused while a saved query uses {PENDO_ACCOUNT_ID_FIELD}

Maximum string length: 200
expected_version
integer | null

The config version you read. Sent: a change against a version that is no longer live is a 409 and writes nothing (0 = the config was never saved). Left out, the change always lands

Required range: x >= 0
surveys
PendoSurveySettings · object | null

The NPS survey settings to change. Send only the settings you want to change: the others keep their saved values, and a first save starts from the defaults. null is refused (422): the settings cannot be removed. The save then applies the app's survey setup rules, see the description of this call

week_start_day
integer | null

The day product usage weeks start on: 0 = Monday … 6 = Sunday

Required range: 0 <= x <= 6

Response

200 - application/json

Successful Response

The Pendo settings. The queries are their own resource (/queries).

account_id_field
string | null
required

The Pendo account field that holds the CRM account ID, for example salesforce.accountid. A query reads it with the token {PENDO_ACCOUNT_ID_FIELD}. null until an admin sets it. Find it with /account-fields: a high filled count marks a likely field; check its values with /preview before saving it

surveys
PendoSavedSurveySettings · object | null
required

The NPS survey job's settings. null when never saved: the job then uses the defaults. With no saved Pendo config at all (version 0), the job reads nothing

version
integer
required

The config's version: send it as expected_version with a change (0 = never saved)

week_start_day
integer
required

The day product usage weeks start on: 0 = Monday … 6 = Sunday