Introduction
This stage turns a signed deal into a contract, gets it signed through DocuSign, records the sales-to-onboarding handover, and creates the onboarding checklist for each contracted product line.
| Endpoint | Method and path | What it does |
|---|---|---|
| Get contract config | GET /credit/v6/contracting/get-contract-config | Returns the dropdown values, pricing catalog and template paths the contract form needs. |
| Reload a saved contract | GET /credit/v6/contracting/prefill-contract-data | Returns a saved contract's payload, with fresh pricing, so the form can be refilled. |
| Save or submit a contract | POST /credit/v6/contracting/create-contract-v2 | Saves the form as a draft, or submits it and moves the contract to Contract-Initiated. |
| Send for signature | POST /credit/v6/contracting/send-for-signature | Sends the contract PDF through DocuSign and moves it to Contract-Pending-User-Signature. |
| Receive DocuSign events | POST /credit/v6/contracting/docusign-webhook | Called by DocuSign. Moves the contract to Contracted and creates the rooftop and product records. |
| Save handover details | POST /console/v1/contracting/onboarding/update-handover-details-v2 | Saves the handover details (systems, platforms, website, markets, languages, notes) on one product line. |
| Schedule an onboarding meeting | POST /console/v1/product-onboarding/schedule-onboarding-meeting | Creates a Google Calendar event with a Google Meet link and invites the attendees. |
| Update handover sub-stage | POST /user-management/v1/product-line/update-stage | Moves a product line through the handover sub-stages. "Meet Done" moves it to Onboarding. |
| Create the onboarding checklist | POST /console/v1/onboarding/task/create-onboarding-task-v2 | Creates the checklist tasks for one product line. Runs automatically on "Meet Done". |
| Get the onboarding task template | POST /credit/v2/product-line-registry/get-onboarding-task-config | Internal dependency of the checklist call. Returns the task template of a product line registry. |
Order to call them
- Load the form config with Get contract config.
- Optionally reload a saved draft with Reload a saved contract.
- Save or submit the contract with Save or submit a contract.
- Send it for signature with Send for signature.
- Let DocuSign report the signature to Receive DocuSign events.
- Capture handover details with Save handover details.
- Schedule a meeting with Schedule an onboarding meeting.
- Move the product line through the handover sub-stages with Update handover sub-stage.
- Create the checklist with Create the onboarding checklist. This runs automatically on "Meet Done".
The last endpoint, Get the onboarding task template, is an internal dependency of the checklist call.
Base URL and headers
Every path starts with https://api.spyne.ai. Send the bearer token of a signed-in Spyne Console user on every call except the DocuSign webhook:
Authorization: Bearer YOUR_TOKEN
Content-Type: application/jsonResponse shape
Get contract config, Reload a saved contract, Save or submit a contract, Send for signature, Receive DocuSign events, Update handover sub-stage and Get the onboarding task template return the same envelope:
{ "message": "…", "error": false, "code": "", "details": null, "data": { } }Save handover details, Schedule an onboarding meeting and Create the onboarding checklist use their own shapes, shown on each page.
Updated about 2 hours ago