Introduction

This stage loads what a rooftop has contracted, which Vini agents it bought, and its onboarding checklist. It then marks checklist tasks done as setup work finishes.

Order of calls

1. Get contracting data
2. Get contract product lines
3. List active Vini products
4. Get the onboarding checklist
5. Get contracted agent details
6. Mark a task done as each setup task finishes, then get the checklist again to refresh status.

Base URL and headers

Every path starts with https://api.spyne.ai. Send the signed-in console user's session token on every call:

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Content-Type is needed only on the POST call.

Agents, segmentName and entity

Each Vini agent has its own checklist segment. segmentName is the agent's product name. It is the key under product_group.segment_name in the checklist response, and the value you send as segmentName when you mark an Agent Setup or Go Live Readiness task done. entity is the agent key used by the per-agent Go Live readiness configuration.

When to send segmentName: leave it out for Rooftop Setup and Integrations tasks. Send it for Agent Setup and Go Live Readiness tasks.

• segmentName is matched case-sensitively when you mark a task done. Send it exactly as shown.
• Acquisition inbound uses segment acquisitionAiInbound. There is no acquisition_inbound entity. The accepted entity values are sales_inbound, sales_outbound, service_inbound, service_outbound, receptionist, acquisition_outbound and reputation_outbound.
• A segment exists only for a rooftop that bought that agent. Checklist rows for a segment are created only for the product names the rooftop has.

Checklist task names

Pass these as taskName when you mark a task done. Matching is exact but ignores case, so spacing and punctuation must match. Task rows come from the product line's task template, and a row appears only if the template created it for the rooftop's segment. Check the strings against task_name in the checklist response before you hard-code them.

• Rooftop Setup and Integrations tasks are shared across the rooftop. Without segmentName, one call updates the matching task in every segment and every product line the rooftop has.
• Rooftop Setup is also accepted as RoofTop Setup, because matching ignores case.
• DMS Integration is sent without segmentName, so it updates every segment that has a task with that name.
• Chatbot Script is never marked done through this API. The checklist treats it as done when a website chat script exists for the rooftop.
• Which Go Live Readiness tasks a segment has depends on the template for that agent. The receptionist checklist does not show the Go Live Readiness section.