Replace Pick list values

POST/settings/fields/{fieldId}/actions/replace_pick_list_values

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Replace Pick list values action (under Metadata).
Fill in the fields below, then reference the result from later steps as {{replacePickListValues.response.data}}.

Request

Path parameters

fieldIdstring (int64)required

Specify the unique numeric identifier of the field. Refer to the [Get Fields Metadata](fields.json#$.paths./settings/fields/{fieldId}.get) resource for valid values.

Query parameters

modulestringrequired

Specify the API name of the CRM module that contains the field. Refer to the [Get Modules](modules.json#$.paths./settings/modules.get) resource for valid values.

Request body

Enter the body as JSON in the step's Body field.

replace_pick_list_valuesarray<object>required

Replace picklist value with from and to options (Required)

old_valueobjectrequired2 fields

Represents the picklist option to be replaced, providing the display value and unique identifier. At least one of id or display_value must be provided.

new_valueobjectrequired2 fields

Represents the picklist option that will act as the replacement, providing the display value and unique identifier. At least one of id or display_value must be provided.

delete_old_valueboolean | null

Boolean value to delete the old_value along with replace

json

{
  "replace_pick_list_values": [
    {
      "old_value": {
        "display_value": "string",
        "id": "string"
      },
      "new_value": {
        "display_value": "string",
        "id": "string"
      },
      "delete_old_value": false
    }
  ]
}

Response

Returns 202 with an object. Read it in later steps with {{replacePickListValues.response.data.<field>}}.

replace_pick_list_valuesarray<object>

Description of the replace option on schedule

codestringrequired

Code of the scheduler response

One ofSCHEDULED

detailsobjectrequired1 fields

Contains the scheduler job identifier for an asynchronous operation that was accepted for processing.

messagestringrequired

Message of the scheduled details

One ofPicklist option replace operation scheduled successfully

statusstringrequired

status on replace operation of the scheduler

One ofsuccess

json

{
  "replace_pick_list_values": [
    {
      "code": "SCHEDULED",
      "details": {
        "job_id": "string"
      },
      "message": "Picklist option replace operation scheduled successfully",
      "status": "success"
    }
  ]
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?