Update the business onboarding todo flags

Overview

Updates one or more onboarding todo flags for the business in context. Send only the flags you want to change; omitted flags keep their current value. The full, refreshed flag set is returned.

Allowed values are done and skipped (skipped marks a step the business explicitly dismissed in the checklist). Sending any other value is rejected with 422.

Only the business owner may write. A request from a staff member who is not the owner is accepted and returns 200, but no flag is changed.

Available for Staff & Directory tokens. Directory tokens MUST send the business in the X-On-Behalf-Of header (a Directory token without it is rejected with 403).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum

Product tour was completed. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done when the business info page of the signup flow is submitted (both the new business-info step and the old second step). It is not set when a user registers with the slim flag. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done when the business reaches the last page of the scheduling wizard (the step before success / early upgrade call). Synced with HubSpot. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done after a staff member is invited (auto-refreshed when the business has more than one staff member). Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done when the business connects a calendar to vcita. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done when a service is created or an existing service is updated in the settings page; in the wizard it is set only when the services page is viewed. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done when the business successfully connects a payment gateway (PayPal / Stripe / Square / Braintree) or an external payment wallet app. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done on completion of the LiveSite walk-me, or when the LiveSite editor is loaded from Frontage. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done when the website-widgets page is loaded (auto-refreshed once the site has been published). Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done when the business imports clients (including Square import) or has more than 5 clients. Synced with HubSpot. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done when a campaign is sent, an automatic campaign is visited, or the campaign wizard is completed. Synced with HubSpot. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done after login from the mobile app only. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

A client card was viewed. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Scheduling options were configured. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done when the business enters the notification settings page. Setting notifications during the scheduling wizard does not mark it as done. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done when the user clicks connect to Yext. Thryv only. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done when the Yext listing is approved. Thryv only. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done when Yext social is set up. Thryv only. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done when the first invoice is sent (auto-refreshed when the business has any invoice). Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done when the user fills in their business intents / onboarding tiles. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done when any of phone, address, profession or website is entered for the business. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done when social networks are linked. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done when an SMS keyword is claimed (Zipwhip). Thryv only. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done when the business connects to Soci. Thryv only. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

Set to done once the business has an estimate that carries a deposit. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

PDF customization was configured. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

A scheduled payment was set up. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

The 'new payment' tip was seen. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

The 'take payment' tip was seen. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

The 'close balance' tip was seen. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
string
enum

The 'request payment' tip was seen. Status of the item. done — completed; skipped — explicitly dismissed by the business; null — not started. The internally stored value manual is always translated to done in the response.

Allowed:
Headers
string

The business UID to act on behalf of. Required when authenticating with a Directory token; not needed for a Staff token (e.g., "fyclhomrzdspdyk6").

Responses

401

Missing or invalid access token.

403

The token is not allowed to access this business — for example a Directory token sent without the X-On-Behalf-Of header, or a staff member without admin account access.

422

A flag was sent with a value other than done or skipped.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json