Brightpearl icon

Brightpearl

Work with orders, products, and price lists in Brightpearl

Contact Custom Field → Update

AI-generated

Summary

Updates a Brightpearl contact’s custom fields by sending a JSON Patch to the contact endpoint. Choose Builder to create patch operations from field entries, or Raw JSON Patch to provide the complete patch yourself.

Inputs

  • Authentication — Select OAuth2 or Private App authentication.
  • Contact ID (required) — The Brightpearl contact ID to update.
  • Input Mode — Choose Builder or Raw JSON Patch.
  • Custom Fields — In Builder mode, add one or more fields with an operation (Add / Set, Replace, or Remove), field code, value type, and value. Add creates or overwrites; Replace requires an existing value; Remove deletes an existing value. The type must match the Brightpearl field: Text / Date, Number, Boolean, or List / Select using an option ID.
  • JSON Patch — In Raw JSON Patch mode, provide an RFC 6902 patch array with operations and paths such as "/CCF_EXAMPLE". Values must use the JSON type expected by the field; Select values use an object containing the numeric option ID.

Output shape

Not established by the provided source pack.

The source pack shows the update implementation only as a signature, so it does not establish the response shape. Brightpearl may return an error for mismatched field types; the properties specifically note that mismatches can produce a 500 response.

Examples

Example 1: Builder mode

To set a text field, add an entry with Add / Set, its field code, Text / Date type, and the value. For a Select field, choose List / Select and enter the numeric option ID.

Example 2: Raw JSON Patch mode

Provide the complete patch array, for example an add operation with path "/CCF_EXAMPLE" and the appropriately typed value.

Links

Discussion