Update Custom Object Record

zendesk/update-custom-object-record — Update an existing custom object record.

Where it appears

The Update Custom Object Record block lives in the Integrations group of the Workflow Builder. Connect the Zendesk integration before adding it.

Fields

Field	Type	Required	Default	Description
`customObjectKey`	text (supports references)	Yes	—	The key of the Zendesk custom object type the record belongs to (e.g. `home_delivery_order`). Accepts literal text or <StepName.field>.
`recordId`	text (supports references)	Yes	—	ID of the custom object record to update. Use a literal ID or <StepName.field> from a previous step.
`name`	text (supports references)	No	—	Optional new display name for the record. Leave blank to keep the current name. Accepts literal text or <StepName.field>.
`externalId`	text (supports references)	No	—	Optional new external identifier for the record. Accepts literal text or <StepName.field>.
`customFields`	code	No	—	JSON object of custom object field keys to new values. Only the keys you include are updated.

Inputs and outputs

Inputs are the configurable fields above. The block produces these outputs:

Outputs

Reference an output downstream with <Update Custom Object Record.field>.

Name	Type	Description
`success`	boolean	Success status
`record`	json	Updated custom object record (object — fields: `id`, `name`, `external_id`, `custom_object_key`, `custom_object_fields`, `created_at`, `updated_at`)
`error`	string	Error message if failed

Example

A minimal configuration for this block:

{
  "type": "zendesk/update-custom-object-record",
  "config": {
    "customObjectKey": "<PreviousStep.field>",
    "recordId": "<PreviousStep.field>"
  }
}

Limits and failure modes

Requires a connected Zendesk integration. Calls fail if that integration is disconnected or its authorization has expired.
Required fields (customObjectKey, recordId) must be set, or the block fails validation before it runs.
On failure the error output is populated; downstream blocks that reference other outputs may not receive values.