Appearance
Mark a tour or highlight as viewed, completed, or dismissed ​
This Widget operation is available through POST /widget/tours/viewed. Use the reference below to inspect its request contract and documented responses before connecting it to your application.
Request preparation ​
Send a POST request to /widget/tours/viewed on the appropriate server. Check the API overview for base URL guidance and the server information in the interactive reference. Replace path placeholders with identifiers from the intended account or site; a similarly named record in another workspace is not interchangeable.
No separate path or query parameters are declared for this operation in the current specification. Do not invent filtering or pagination options from another endpoint; use only the contract shown here.
No request body is declared in the current specification. Check the route and any documented parameters before sending the request rather than adding an arbitrary JSON payload.
Authentication and scope ​
The specification lists these security alternatives: BearerAuth, AccessToken. Read any operation-specific restrictions as well: browser-session, account-role, and signed-user requirements may impose additional conditions. See authentication before choosing a credential.
Keep credentials in the appropriate private configuration and remove secrets from shared logs. Confirm the target resource belongs to the intended workflow before issuing a request. Authentication alone should not be treated as confirmation that a supplied account, site, or customer identifier is correct.
Response handling ​
The documented responses for Mark a tour or highlight as viewed, completed, or dismissed are:
- 200: OK
- 401: Signed user token required
Exercise this operation with controlled test data before enabling it in an automated workflow. Validate the request against the schema and inspect the response before updating local state. Do not assume that a successful response means background processing has finished; follow any documented status or follow-up operation when the action queues additional work.
If a connection fails after submission, investigate the current server state before repeating an action whose outcome is uncertain. When requesting support, retain the method, route, response status, and sanitized error message. The interactive reference below provides the detailed schemas and examples for this specific operation.
Mark a tour or highlight as viewed, completed, or dismissed​
Powered by VitePress OpenAPI