younifyd
Menu

Update Module Labels and Profiles

Update Module Labels and Profiles

PUT/settings/modules/{moduleIdentifier}

Use it in a workflow

  1. Add a step and choose the Zoho CRM connector.
  2. Pick the Update Module Labels and Profiles action (under Metadata).
  3. Fill in the fields below, then reference the result from later steps as {{updateModuleLabelsAndProfiles.response.data}}.

Request

Path parameters

moduleIdentifieroneOfrequired

Specify the module identifier, either the numeric module ID or the module API name(case-sensitive).

Request body

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

modulesarray<object>required

Single-element array containing the module object with the labels and profile assignments to update. Exactly one item is required.

singular_labelstringrequired

Singular display label for the module. Accepts 1–50 alphanumeric characters and spaces; special characters are not permitted.

plural_labelstringrequired

Plural display label for the module. Accepts 1–50 alphanumeric characters and spaces; special characters are not permitted.

idstring (int64)required

Unique numeric identifier of the module to update. Must match an existing module. Represented as a numeric string encoding a 64-bit positive integer (Java long/DB bigint).

profilesarray<object>required1 fields

Non-empty list of unique profiles that should have access to this module. Accepts 1–203 unique profile objects; order is not significant. This cannot be empty.

json
{
  "modules": [
    {
      "singular_label": "Custom Module",
      "plural_label": "Custom Modules",
      "id": "string",
      "profiles": [
        {
          "id": "111111000000000497"
        }
      ]
    }
  ]
}

Response

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

modulesarray<object>

Single-element array containing the success result for the updated module.

codestringrequired

Always "SUCCESS". Indicates the module update completed without errors.

One ofSUCCESS

detailsobjectrequired1 fields

Contains the identifier of the successfully updated module.

messagestringrequired

Displays the success message and confirms that the update was applied.

One ofmodule updated successfully

statusstringrequired

Indicates that the operation completed successfully.

One ofsuccess

json
{
  "modules": [
    {
      "code": "SUCCESS",
      "details": {
        "id": "111111000000242167"
      },
      "message": "module updated successfully",
      "status": "success"
    }
  ]
}

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

Update Module Labels and Profiles — Zoho CRM — Documentation