> ## 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 custom field rule ## OpenAPI ````yaml /openapi.json patch /custom-field-rules/{uuid} openapi: 3.1.0 info: title: Journeybee API description: >- Public REST API for the Journeybee PRM platform. Manage partners, leads, deals, products, pricing calculators, tasks, and more programmatically. All endpoints require authentication via API key. Use `Authorization: Bearer ` or `Api-Key ` header. See the [Authentication guide](/guides/authentication) for details. version: 1.0.0 servers: - url: https://api.journeybee.io/v1 description: Production security: - apiKey: [] tags: - name: Assets description: File and media asset management - name: Leads description: Lead management - name: Lead Contacts description: Partner contacts on a lead - name: Lead Tasks description: Tasks on a lead - name: Lead Notes description: Notes on a lead - name: Lead Tags description: Tags on a lead - name: Lead Users description: Assigned users on a lead - name: Lead Custom Field Values description: Custom field values on a lead - name: Lead Attributions description: Attribution records on a lead - name: Lead Distributor description: Distributors for a lead - name: Lead Products description: Products attached to a lead - name: Lead Quotes description: >- Quotes on a lead — generated from pricing calculators with line items and totals - name: Deals description: Deal management - name: Deal Notes description: Notes on a deal - name: Deal Tags description: Tags on a deal - name: Deal Products description: Products attached to a deal - name: Deal Payments description: Payment records on a deal (read-only) - name: Deal Custom Field Values description: Custom field values on a deal - name: Deal Commission description: Commission calculation on a deal - name: Deal Tasks description: Tasks on a deal - name: Commissions description: >- Commission rule configurations with calculation entries, tier/category/partnership scoping - name: Contacts description: Partner contacts across partnerships - name: Tasks description: Task management - name: Task Users description: Assigned users on a task - name: Products description: Product catalog - name: Pricing Calculators description: Pricing calculator configurations - name: Pricing Calculator Fields description: Input fields on a pricing calculator - name: Pricing Calculator Products description: Products attached to a pricing calculator - name: Pricing Calculator Formulas description: Discount/tax/surcharge formulas on a pricing calculator - name: Partners description: Core partner CRUD - name: Partner Contacts description: Contacts on a partner - name: Partner Notes description: Notes on a partner - name: Partner Tags description: Tags on a partner - name: Partner Users description: Assigned users on a partner - name: Partner Domains description: Domains on a partner - name: Partner Custom Field Values description: Custom field values on a partner - name: Partner Resellers description: Reseller assignments on a distributor - name: Attributions description: Attribution type definitions - name: Currencies description: Available currencies - name: Users description: Company team members - name: Partner Stages description: Partner pipeline stages - name: Deal Stages description: Deal pipeline stages - name: Tiers description: Partner tiers - name: Categories description: Partner categories - name: Tags description: Tag definitions - name: Custom Fields description: Custom field definitions - name: Custom Field Options description: Options on select/multi-select custom fields - name: Custom Field Values description: Custom field values - name: Resources description: Learning resources - name: Resource Blocks description: Content blocks within a resource - name: Resource Tags description: Tags on a resource - name: Resource Categories description: Categories on a resource - name: Resource Folders description: Folders on a resource - name: Certifications description: LMS certifications - name: Certification Resources description: Curriculum resources in a certification - name: Certification Enrollments description: User enrollments in a certification - name: Certification Categories description: Categories on a certification - name: Certification Folders description: Folders on a certification - name: Folders description: Content folders - name: Rooms description: Partner portal rooms - name: Room Blocks description: Content blocks within a room - name: Room Tiers description: Tier-based room access control - name: Room Categories description: Category-based room access control - name: Room Stages description: Stage-based room access control - name: Room Tags description: Tag-based room access control - name: Room Partnerships description: Direct partnership room access - name: Webhook Events description: Outbound webhook payloads sent to your configured URLs when events occur paths: /custom-field-rules/{uuid}: patch: tags: - Custom Field Rules summary: Update a custom field rule operationId: updateCustomFieldRule 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: uuid required: true requestBody: required: true content: application/json: schema: type: object properties: label: type: string minLength: 1 maxLength: 255 description: Rule label active: description: Whether the rule is active type: boolean source_custom_field_uuid: type: string description: Source custom field UUID source_values: description: Values that trigger the rule maxItems: 100 type: array items: anyOf: - type: string - type: number - type: boolean action_type: type: string enum: - set_value - show_field - value_mapping description: 'Rule action: set_value, show_field, or value_mapping' target_custom_field_uuid: type: string description: Target custom field UUID target_value: anyOf: - 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' - type: 'null' description: Value to set when action_type is set_value value_mappings: anyOf: - maxItems: 100 type: array items: type: object properties: sourceValue: anyOf: - type: string - type: number - type: boolean targetValue: 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). required: - sourceValue - targetValue additionalProperties: false - type: 'null' description: Value mapping pairs for value_mapping rules locked: description: Whether the target field is locked when the rule matches type: boolean entity_type: type: string enum: - partner - lead - lead_deal - contact description: Entity type this rule applies to additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: uuid: type: string label: type: string active: type: boolean source_custom_field_uuid: type: string source_values: type: array items: anyOf: - type: string - type: number - type: boolean action_type: type: string enum: - set_value - show_field - value_mapping target_custom_field_uuid: type: string target_value: anyOf: - 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' - type: 'null' value_mappings: anyOf: - type: array items: type: object properties: sourceValue: anyOf: - type: string - type: number - type: boolean targetValue: 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). required: - sourceValue - targetValue additionalProperties: false - type: 'null' locked: type: boolean entity_type: type: string enum: - partner - lead - lead_deal - contact created_at: type: string updated_at: type: string required: - uuid - label - active - source_custom_field_uuid - source_values - action_type - target_custom_field_uuid - target_value - value_mappings - locked - entity_type - created_at - updated_at additionalProperties: false components: securitySchemes: apiKey: type: http scheme: bearer description: API key authentication. Use "Bearer " or "Api-Key ". ````