> ## Documentation Index
> Fetch the complete documentation index at: https://docs.roofkit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create lead conversion

> Creates a public conversion snapshot. This does not dispatch automations or webhooks.

**Required scopes:** `leads.write`


## OpenAPI

````yaml /api-reference/openapi.yaml post /api/v1/leads/{lead_id}/conversions
openapi: 3.1.0
info:
  title: RoofKit Partner API
  version: 1.0.0
  summary: REST JSON API for external RoofKit partner integrations.
  contact:
    name: RoofKit Engineering
  description: >
    RoofKit Partner API v1 authenticates requests with workspace API keys. API
    keys bind each request to exactly one workspace; Partner API paths do not
    accept roofer_id, workspace_id, or tenant identifiers. Authenticated
    endpoints are limited to 60 requests per minute per API key, method, and
    route template; invalid authentication attempts are limited separately at 20
    requests per minute per client and endpoint. Date-time parameters and fields
    accept ISO 8601 with Z or a ±HH:MM offset, for example 2026-09-07T04:00:00Z
    or 2026-09-07T00:00:00-04:00. Both name the same instant and return the same
    result. Encode + as %2B in a query string. Responses return UTC.


    A date-time without an offset, for example 2026-09-07T04:00:00, is
    deprecated. Until the sunset on 2027-01-10T00:00:00Z it is read as UTC, and
    the response carries a `Deprecation` header (RFC 9745) and a `Sunset` header
    (RFC 8594). From the sunset, Z or a ±HH:MM offset is required. A date-time
    without an offset then returns 400 with the `VALIDATION_ERROR` code, and the
    response carries no `Deprecation` or `Sunset` header.


    Each API key holds only the scopes that a workspace owner or admin chose
    when the key was created, and its scopes never change. Each operation lists
    the scopes it requires in `x-required-scopes`. A new key in Settings starts
    on the Read-only preset: `leads.read`, `analytics.read`, `reports.read`, and
    `data_objects.read`. A Read-only key can call every read operation except
    exports, Sales Visualizer reads, and trashed Data Objects, and it cannot
    call any write operation. A call that needs a scope the key does not hold
    returns 403 `FORBIDDEN`, and `error.details.required_scope` names a missing
    scope.
servers:
  - url: https://api.roofkit.ai
    description: Canonical RoofKit Partner API origin
security:
  - ApiKeyBearer: []
tags:
  - name: Foundation
    description: Authentication and contract foundation endpoints.
  - name: Leads
    description: Partner CRM lead sync endpoints.
  - name: Attribution
    description: >-
      Partner marketing attribution, campaign analytics, and event ingestion
      endpoints.
  - name: Pipeline
    description: Partner-readable lead pipeline metadata.
  - name: Reports
    description: Partner report import, listing, fetch, export, and download endpoints.
  - name: Visualizer
    description: >-
      Partner Sales Visualizer creation, generation, hosted photo upload links,
      image reads, session history, and share-link endpoints.
  - name: Estimates
    description: Partner Budget Estimate creation and reads for the key-bound workspace.
  - name: Objects
    description: >-
      Partner Data Objects discovery, schema, records, relations, views, and
      admin endpoints.
paths:
  /api/v1/leads/{lead_id}/conversions:
    post:
      tags:
        - Leads
      summary: Create lead conversion
      description: >-
        Creates a public conversion snapshot. This does not dispatch automations
        or webhooks.
      operationId: Create lead conversion
      parameters:
        - $ref: '#/components/parameters/LeadId'
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConversionWrite'
      responses:
        '200':
          description: Existing conversion replayed or returned by external_event_id.
          headers:
            Idempotency-Replayed:
              $ref: '#/components/headers/IdempotencyReplayed'
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            Sunset:
              $ref: '#/components/headers/Sunset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversionCreateResponse'
        '201':
          description: Conversion created.
          headers:
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            Sunset:
              $ref: '#/components/headers/Sunset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversionCreateResponse'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    LeadId:
      name: lead_id
      in: path
      required: true
      schema:
        type: string
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: true
      description: >-
        A unique value for each new request, such as a UUID. Send the same value
        to retry a request safely. The same key and payload replay the first
        response with `Idempotency-Replayed: true`.
      schema:
        type: string
        minLength: 1
        maxLength: 160
  schemas:
    ConversionWrite:
      type: object
      additionalProperties: false
      required:
        - external_event_id
      properties:
        external_event_id:
          type: string
          minLength: 1
          maxLength: 200
        session_id:
          type:
            - string
            - 'null'
        visualization_id:
          type:
            - string
            - 'null'
        conversion_url:
          type:
            - string
            - 'null'
          format: uri
        entry:
          description: Website entry for this conversion touch. Omitted when unset.
          type: string
          enum:
            - button
            - embed
            - direct
        contact_name:
          type:
            - string
            - 'null'
        contact_email:
          type:
            - string
            - 'null'
          format: email
        contact_phone:
          description: US-only phone. Invalid or non-US values return VALIDATION_ERROR.
          type:
            - string
            - 'null'
        property_address:
          description: >-
            Optional property address. Empty, explicit US country, or US state +
            ZIP formats are accepted; clearly non-US values return
            VALIDATION_ERROR.
          type:
            - string
            - 'null'
        occurred_at:
          type: string
          format: date-time
          description: ISO 8601 date-time with Z or a ±HH:MM offset. Stored as UTC.
        lead_type:
          description: >-
            Channel of this touch. Send the key or the current label of a
            workspace lead type. Defaults to external. An unknown value returns
            VALIDATION_ERROR.
          type: string
          minLength: 1
          maxLength: 100
        form_name:
          description: Name of the form that sent this touch.
          type:
            - string
            - 'null'
          maxLength: 200
        form_key:
          description: Stable identifier of the form that sent this touch.
          type:
            - string
            - 'null'
          maxLength: 500
    ConversionCreateResponse:
      type: object
      additionalProperties: false
      required:
        - conversion
        - created
      properties:
        conversion:
          $ref: '#/components/schemas/Conversion'
        created:
          type: boolean
    Conversion:
      type: object
      additionalProperties: false
      required:
        - id
        - lead_id
        - external_event_id
        - conversion_number
        - session_id
        - attribution
        - created_at
      properties:
        id:
          type: string
        lead_id:
          type: string
        external_event_id:
          type:
            - string
            - 'null'
        conversion_number:
          type: integer
        session_id:
          type: string
        visualization_id:
          type:
            - string
            - 'null'
        attribution:
          $ref: '#/components/schemas/Attribution'
        lead_type:
          description: >-
            Lead type key of this touch. Null on an older touch without a
            channel.
          type:
            - string
            - 'null'
        landing_url:
          description: Page of this touch, without the query string.
          type:
            - string
            - 'null'
        form_name:
          description: Name of the form that sent this touch.
          type:
            - string
            - 'null'
        contact_name:
          type:
            - string
            - 'null'
        contact_email:
          type:
            - string
            - 'null'
        contact_phone:
          description: Phone snapshot at conversion time.
          type:
            - string
            - 'null'
        property_address:
          description: Property address snapshot at conversion time.
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - message
            - request_id
          properties:
            code:
              $ref: '#/components/schemas/ErrorCode'
            message:
              type: string
            request_id:
              type: string
            details:
              type: object
              additionalProperties: true
    Attribution:
      type: object
      additionalProperties: false
      properties:
        source:
          type:
            - string
            - 'null'
        medium:
          type:
            - string
            - 'null'
        campaign:
          type:
            - string
            - 'null'
        content:
          type:
            - string
            - 'null'
        conversion_url:
          type:
            - string
            - 'null'
          format: uri
        entry:
          description: >-
            Website entry for this touch. Omitted when unset. Does not replace
            source.
          type: string
          enum:
            - button
            - embed
            - direct
    ErrorCode:
      type: string
      enum:
        - UNAUTHORIZED
        - FORBIDDEN
        - RATE_LIMITED
        - VALIDATION_ERROR
        - NOT_FOUND
        - CONFLICT
        - INSUFFICIENT_CREDITS
        - INTERNAL_ERROR
  headers:
    IdempotencyReplayed:
      description: Present and true when a stored successful write response was replayed.
      schema:
        type: string
        enum:
          - 'true'
    Deprecation:
      description: >
        Present only when the request sent a date-time without a UTC offset.
        That form is deprecated and was read as UTC. The value is the RFC 9745
        deprecation date as `@` and Unix seconds.
      schema:
        type: string
        example: '@1791763200'
    Sunset:
      description: >
        Present only with Deprecation. The RFC 8594 HTTP-date from which a
        date-time without a UTC offset returns 400.
      schema:
        type: string
        example: Sun, 10 Jan 2027 00:00:00 GMT
    RateLimitLimit:
      description: Maximum requests allowed in the current window.
      schema:
        type: string
    RateLimitRemaining:
      description: Requests remaining in the current window.
      schema:
        type: string
    RateLimitReset:
      description: ISO timestamp when the current rate-limit window resets.
      schema:
        type: string
        format: date-time
    RetryAfter:
      description: Seconds until the caller should retry.
      schema:
        type: string
  responses:
    ValidationError:
      description: Request payload, query, or required header is invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing, malformed, revoked, deleted, or unknown API key.
      headers:
        WWW-Authenticate:
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: >-
        The API key lacks a required scope, or the workspace is not active. A
        scope failure names a missing scope in `details.required_scope`. When
        the key lookup refuses the call, `details.missing_scopes` lists every
        required scope that the key does not hold.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missing_scope:
              summary: A Read-only key calls a write operation
              value:
                error:
                  code: FORBIDDEN
                  message: 'API key does not include the required scope: leads.write.'
                  request_id: req_123
                  details:
                    required_scope: leads.write
                    missing_scopes:
                      - leads.write
    NotFound:
      description: Resource not found in the key-bound workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Conflict:
      description: Request conflicts with idempotency or external event identity.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimited:
      description: Rate limit exceeded for this key and endpoint or invalid-auth bucket.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal authentication or server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: RoofKit API key
      description: 'Use `Authorization: Bearer rk_live_...`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.