Skip to navigation

Create an announcement

A what’s-new card the SDK shows; its button can start a guide of the same expert. At most 100 per expert.

Sessions: admins.

Needs the experts:write scope. A key without it gets 403 insufficient_scope. Routes not in this reference cannot be called with a key at all (403 not_available_to_api_keys).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
The expert id.

Request

This endpoint expects an object.
titlestringRequired<=120 characters
bodystringRequired<=1000 characters
ctaLabelstringOptional<=40 characters
guideIdstring or nullOptional
audiencemap from strings to anyOptional

Who sees it (every rule present must hold; {} is everyone): { traits?: [{ key, op, value? }], plans?: [..], seen?: [custom event names], notSeen?: [..] }. op: eq, neq, in, not_in, exists, not_exists, contains, gt, lt.

frequencyobject or nullOptional

How often one person sees it; absent means at most 3 times, 24 hours apart. Never again once clicked or dismissed.

startsAtdatetimeOptional
endsAtdatetime or nullOptional
isActivebooleanOptional

Response

OK
idstring
A UUID.
agentIdstring
A UUID.
titlestring
bodystring
ctaLabelstring
audiencemap from strings to any

Who sees it (every rule present must hold; {} is everyone): { traits?: [{ key, op, value? }], plans?: [..], seen?: [custom event names], notSeen?: [..] }. op: eq, neq, in, not_in, exists, not_exists, contains, gt, lt.

startsAtdatetime
isActiveboolean
createdAtdatetime
updatedAtdatetime
guideIdstring or nullOptional
frequencyobject or nullOptional

How often one person sees it; absent means at most 3 times, 24 hours apart. Never again once clicked or dismissed.

endsAtdatetime or nullOptional

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error