Submitting Your First Deal

This guide shows the simplest sales lead flow: create the lead as a Karia contact, then create an origination deal connected to that contact.

Workflow

1. Collect and validate the lead details from your form or sales intake flow.
2. Create the contact in the target organisation and workspace.
3. Use the returned contact.data.id as the contactId for the deal.
4. Create the origination deal with priority, follow-up, expected closure, salary, and sales context.
5. Return a successful response only after both Karia records have been created.

Related OpenAPI Operations

{
  "type": "Bearer API key"
}

{
  "orgId": "org_123",
  "workspaceId": "workspace_123"
}

{
  "firstName": "Jane",
  "lastName": "Citizen",
  "preferredName": "Jane",
  "contactMethods": [
    {
      "value": "jane.citizen@example.com",
      "type": "email"
    },
    {
      "value": "+61400111222",
      "type": "phone"
    }
  ]
}

{
  "type": "Bearer API key"
}

{
  "orgId": "org_123",
  "workspaceId": "workspace_123"
}

{
  "name": "Jane Citizen",
  "contactId": "contact_123",
  "assignedTo": "00000000-0000-0000-0000-000000000000",
  "priority": "high",
  "expectedClosureDate": "2026-06-15T00:00:00.000Z",
  "followUpDate": "2026-05-05T00:00:00.000Z",
  "description": "New Deal for Jane Citizen, lease Term: 36 months, Annual KMs: 15000, Salary: 90000",
  "employerName": "Example Employer",
  "grossAnnualSalary": "90000"
}

Create The Contact

Create the contact first so the deal can be linked to a known customer record. Include the lead's email and phone number as contact methods when you have them.

• Map the lead's legal name to firstName and lastName.
• Use preferredName when the lead has supplied one; otherwise the first name is a sensible default.
• Send any known email and phone values in contactMethods.
• Stop the flow if the contact create request returns an error.

Create The Deal

Once the contact exists, create the origination deal. The example below schedules follow-up for tomorrow and sets expected closure six weeks from submission.

• Set contactId to the ID returned by the contact create request.
• Use a clear name and description so the Karia workspace can identify the lead.
• Set followUpDate based on when your sales team should next act on the lead.
• Set expectedClosureDate based on the expected sales cycle for the opportunity.
• Replace placeholder assignedTo and employerName values with real workspace data before using this in production.
• Return success to your caller only after the deal create request succeeds.