Introduction

For the sales agents, Go-Live means you read and save the rooftop's go-live readiness answers, then switch the agent live (or offline) through the agent upsert call.

EndpointMethod and pathWhat it does
Get readiness answersGET /central-config/v1/vini-config/go-live-readinessReads the saved readiness answers for one agent type at one rooftop.
Save readiness answersPOST /central-config/v1/vini-config/go-live-readinessCreates or updates readiness answers, one step at a time.
Put an agent livePOST /console/v1/product-onboarding/vini/agentSets isOnboarded: true so the agent takes part in routing and outreach.
Take an agent offlinePOST /console/v1/product-onboarding/vini/agentSets isOnboarded: false to pause the agent. Settings are kept.

Before you start

  • Every path starts with https://api.spyne.ai.
  • Authenticate with a Bearer token from the signed-in user's session: Authorization: Bearer YOUR_TOKEN. Get readiness answers is the one route with no auth check.
  • You need the dealer group (enterpriseId) and the rooftop (teamId). For agents you also need the team-agent mapping ID (agentId) from Agent Setup.

Sales agents

  1. Get readiness answers to pre-fill the readiness questions.
  2. Save readiness answers. The readiness checklist tasks (After Hours, Office Hours, Run First Campaign) are marked done with the task name, for example After Hours, through Mark a task done in Checklist.
  3. Put an agent live: a POST to /console/v1/product-onboarding/vini/agent with agentId and isOnboarded: true. The endpoint is also covered in Update an agent.
  4. Take an agent offline when the dealer wants to pause.

Readiness answers are a stored questionnaire. They do not gate go-live, and Put an agent live does not check them.

Receptionist

The Receptionist go-live calls live under Marketing → Receptionist Agent.

Sales readiness answers

This section covers the sales agents only. Readiness answers differ by agent; everything else on this step is common. The sales page is Save sales readiness answers. Readiness steps by agent: sales_inbound: afterHours, officeHoursOverflow, officeHoursAllLeads. sales_outbound: runFirstCampaign only.


Did this page help you?