> ## 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. # Update a partnership lead ## OpenAPI ````yaml /partner-openapi.json patch /partner/{partnershipId}/leads/{leadId} 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/{leadId}: patch: tags: - Partner summary: Update a partnership lead operationId: updatePartnerLead 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 - 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: leadId 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' rejected_reason: anyOf: - type: string - type: 'null' status: type: string enum: - new - converted - rejected tag: type: object properties: id: type: string label: type: string background_color: type: string text_color: anyOf: - type: string - type: 'null' added: type: boolean removed: type: boolean required: - label - background_color - text_color additionalProperties: false custom_field_values: type: array items: type: object properties: customFieldId: type: string type: type: string enum: - text - textarea - number - date - boolean - select - multi_select value: anyOf: - type: object properties: text: description: Value for text/url/email/phone fields 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 description: >- Custom field value. Set the key matching the field type: text (text/url/email/phone), number, date, boolean (checkbox), select (option ID), or multi_select (array of option IDs). - type: 'null' required: - customFieldId - type additionalProperties: false distributor: type: object properties: id: type: number add: type: boolean remove: type: boolean required: - id additionalProperties: false partner_custom_field_values: type: array items: type: object properties: customFieldId: type: string type: type: string enum: - text - textarea - number - date - boolean - select - multi_select value: anyOf: - type: object properties: text: description: Value for text/url/email/phone fields 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 description: >- Custom field value. Set the key matching the field type: text (text/url/email/phone), number, date, boolean (checkbox), select (option ID), or multi_select (array of option IDs). - type: 'null' required: - customFieldId - type additionalProperties: false additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: uuid: type: string created_at: type: string updated_at: type: string source: type: string status: type: string enum: - new - converted - rejected 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' direction: anyOf: - type: string enum: - sent - received - type: 'null' lock_lead_status: type: boolean partnership_id: anyOf: - type: string - type: 'null' campaign_id: anyOf: - type: string - type: 'null' campaign_title: anyOf: - anyOf: - type: string - type: 'null' - type: 'null' partnership: anyOf: - type: object properties: id: type: string uuid: type: string name: anyOf: - type: string - type: 'null' partner_type: type: string enum: - referral - reseller - distributor logo_square_id: anyOf: - type: number - type: 'null' logo_square_uuid: anyOf: - type: string - type: 'null' partnership_distributors_id: anyOf: - type: string - type: 'null' distributor_name: anyOf: - type: string - type: 'null' distributor_logo_square_id: anyOf: - type: number - type: 'null' distributor_logo_square_uuid: anyOf: - type: string - type: 'null' required: - id - uuid - name - partner_type - logo_square_id - logo_square_uuid - partnership_distributors_id - distributor_name - distributor_logo_square_id - distributor_logo_square_uuid additionalProperties: false - type: 'null' tags: type: array items: type: object properties: id: type: string label: type: string background_color: type: string text_color: anyOf: - type: string - type: 'null' required: - id - label - background_color - text_color additionalProperties: false assigned_users: type: array items: type: object properties: id: type: string first_name: anyOf: - type: string - type: 'null' last_name: anyOf: - type: string - type: 'null' email: type: string profile_image_id: anyOf: - type: number - type: 'null' profile_image_uuid: anyOf: - type: string - type: 'null' required: - id - first_name - last_name - email - profile_image_id - profile_image_uuid additionalProperties: false assigned_contacts: type: array items: type: object properties: id: type: string first_name: anyOf: - type: string - type: 'null' last_name: anyOf: - type: string - type: 'null' email: type: string profile_image_id: anyOf: - anyOf: - type: number - type: 'null' - type: 'null' profile_image_uuid: anyOf: - type: string - type: 'null' required: - id - first_name - last_name - email - profile_image_id - profile_image_uuid additionalProperties: false custom_fields: type: array items: type: object properties: id: type: string label: type: string type: type: string enum: - text - textarea - number - date - boolean - select - multi_select value: anyOf: - type: object properties: text: description: Value for text/url/email/phone fields 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 description: >- Custom field value. Set the key matching the field type: text (text/url/email/phone), number, date, boolean (checkbox), select (option ID), or multi_select (array of option IDs). - type: 'null' options: anyOf: - type: array items: type: object properties: id: type: number label: type: string required: - id - label additionalProperties: false - type: 'null' custom_field_value_id: anyOf: - type: string - type: 'null' required: - id - label - type - value - options - custom_field_value_id additionalProperties: false has_quote: type: boolean lead_deals: type: array items: type: object properties: id: type: string uuid: type: string label: type: string deal_value: type: number stage_id: anyOf: - type: string - type: 'null' stage_label: anyOf: - type: string - type: 'null' stage_series: anyOf: - type: number - type: 'null' stage_phase: anyOf: - type: string enum: - new - in_progress - won - lost - expired - on_hold - type: 'null' currency_code: anyOf: - type: string - type: 'null' created_at: type: string total_commission_value: anyOf: - anyOf: - type: number - type: 'null' - type: 'null' lead_deal_payments: anyOf: - type: array items: type: object properties: payment_completed: type: boolean payment_value: type: number required: - payment_completed - payment_value additionalProperties: false - type: 'null' required: - id - uuid - label - deal_value - stage_id - stage_label - stage_series - stage_phase - currency_code - created_at - total_commission_value - lead_deal_payments additionalProperties: false id: type: string required: - uuid - created_at - updated_at - source - status - company_name - first_name - last_name - email - phone_number - direction - partnership_id - campaign_id - campaign_title - partnership - tags - assigned_users - assigned_contacts - custom_fields - has_quote - lead_deals - id additionalProperties: false components: securitySchemes: apiKey: type: http scheme: bearer description: API key authentication. Use "Bearer " or "Api-Key ". ````