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

# Create a partnership lead

> Custom fields may be required or rule-controlled — call getPartnerLeadRequirements first to learn the field/rule constraints. Validation failures return per-field `details` with machine-readable `reason` codes.



## OpenAPI

````yaml /partner-openapi.json post /partner/{partnershipId}/leads
openapi: 3.1.0
info:
  title: Journeybee Partner API
  description: Partner-facing REST API for the Journeybee PRM platform.
  version: 1.0.0
servers:
  - url: https://api.journeybee.io/v1
    description: Production
security:
  - apiKey: []
tags:
  - name: Partner
    description: Partner-facing API endpoints — used only by the partner spec
paths:
  /partner/{partnershipId}/leads:
    post:
      tags:
        - Partner
      summary: Create a partnership lead
      description: >-
        Custom fields may be required or rule-controlled — call
        getPartnerLeadRequirements first to learn the field/rule constraints.
        Validation failures return per-field `details` with machine-readable
        `reason` codes.
      operationId: createPartnerLead
      parameters:
        - schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
          in: path
          name: partnershipId
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                company_name:
                  anyOf:
                    - type: string
                    - type: 'null'
                first_name:
                  anyOf:
                    - type: string
                    - type: 'null'
                last_name:
                  anyOf:
                    - type: string
                    - type: 'null'
                email:
                  anyOf:
                    - type: string
                    - type: 'null'
                phone_number:
                  anyOf:
                    - type: string
                    - type: 'null'
                tags:
                  type: array
                  items:
                    type: string
                customFields:
                  type: array
                  items:
                    type: object
                    properties:
                      customFieldId:
                        type: string
                      type:
                        type: string
                        enum:
                          - text
                          - textarea
                          - email
                          - website
                          - phone
                          - number
                          - date
                          - boolean
                          - checkbox
                          - select
                          - multi_select
                      value:
                        anyOf:
                          - type: object
                            properties:
                              text:
                                description: Value for text-like fields
                                anyOf:
                                  - type: string
                                  - type: 'null'
                              textarea:
                                description: >-
                                  Legacy value key for textarea fields; write
                                  using text
                                anyOf:
                                  - type: string
                                  - type: 'null'
                              number:
                                description: Value for number fields
                                anyOf:
                                  - anyOf:
                                      - type: number
                                      - type: string
                                  - type: 'null'
                              date:
                                description: Value for date fields (ISO 8601 date string)
                                anyOf:
                                  - type: string
                                  - type: 'null'
                              boolean:
                                description: Value for checkbox fields
                                anyOf:
                                  - anyOf:
                                      - type: boolean
                                      - type: string
                                  - type: 'null'
                              select:
                                description: Option ID for single-select fields
                                anyOf:
                                  - type: number
                                  - type: 'null'
                              multi_select:
                                description: Option IDs for multi-select fields
                                anyOf:
                                  - type: array
                                    items:
                                      type: number
                                  - type: 'null'
                            additionalProperties: false
                          - type: 'null'
                    required:
                      - customFieldId
                      - type
                    additionalProperties: false
                assignedUsers:
                  type: array
                  items:
                    type: string
                assignedContacts:
                  type: array
                  items:
                    type: string
                partnership_distributors_id:
                  type: string
                quote:
                  type: object
                  properties:
                    calculator_id:
                      type: string
                    field_values:
                      type: object
                      additionalProperties:
                        anyOf:
                          - type: integer
                            minimum: -1000000
                            maximum: 1000000
                          - type: string
                            maxLength: 1000
                          - type: boolean
                    selected_optional_products:
                      type: array
                      items:
                        type: string
                    customer_name:
                      type: string
                    customer_email:
                      type: string
                    customer_company:
                      type: string
                    valid_days:
                      type: number
                  required:
                    - calculator_id
                    - field_values
                    - customer_name
                  additionalProperties: false
                referralMode:
                  type: string
                  enum:
                    - send
                    - record
              additionalProperties: false
      responses:
        '201':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  uuid:
                    type: string
                  quote_uuid:
                    type: string
                required:
                  - id
                  - uuid
                additionalProperties: false
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

````