Skip to navigation

Create a guide

At most 100 guides per expert and 30 steps per guide. A new guide goes last unless position is given.

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.
namestringRequired<=120 characters
nudgestring or nullOptional<=200 characters
triggermap from strings to anyOptional

When the guide offers itself: { type: manual } | { type: first_visit, pattern? } | { type: page, pattern } | { type: event, name } | { type: stuck, seconds, pattern? }. Patterns are path globs (* in one segment, ** across).

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.

stepslist of objectsOptional
isActivebooleanOptional
positionintegerOptional>=0

Response

OK
idstring
A UUID.
agentIdstring
A UUID.
namestring
triggermap from strings to any

When the guide offers itself: { type: manual } | { type: first_visit, pattern? } | { type: page, pattern } | { type: event, name } | { type: stuck, seconds, pattern? }. Patterns are path globs (* in one segment, ** across).

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.

stepslist of objects
isActiveboolean
positioninteger
createdAtdatetime
updatedAtdatetime
nudgestring or nullOptional

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error