Audiences

Update an audience

Send only the fields to change. Lists replace the stored list. Campaigns keep the copy they attached.

Scope: audiences:write.

Send an Idempotency-Key header to make retries safe.

patch/audiences/{audienceId}

Request

Base URL
https://www.fandom.ai/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/skilledstars/apis/super-fans-enterprise-api/docs/audiences/:audienceId/patch.ts
A function with typed inputs. Its response is checked against the schema.

audienceIdstring required

Audience id.

Idempotency-Keystring

Any unique string. Repeating a request with the same key returns the first result instead of doing it twice.

namestring

descriptionstring

Who these people are, in plain words. Drives targeting.

keywordsstring[]

topicsstring[]

tagsstring[]

dataStoreIdsstring[]

Data stores this audience is built from.

Success

idstring required

namestring required

descriptionstring required

kindstring required

custom, rfp (from a brief) or preset.

keywordsstring[] required

topicsstring[] required

tagsstring[] required

dataStoreIdsstring[] required

createdAtstring nullable required

updatedAtstring nullable required