Create records in a specified module

POST/{module}

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Create records in a specified module action (under Records).
Fill in the fields below, then reference the result from later steps as {{createRecordsInASpecifiedModule.response.data}}.

Request

Path parameters

modulestringrequired

Specify the API name of the module. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module ID and API name.

Request body

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

dataarray<object>required

Represents the data value.

Layoutobject1 fields

Represents the layout value. Use the [Get Layouts Metadata API](layouts.yaml#$.paths./settings/layouts.get) to retrieve the Layout ID.

Wizardobject1 fields

Represents the wizard value. Use the [Get Wizards API](wizards.yaml#$.paths./settings/wizards.get) to retrieve the Wizard ID.

apply_feature_executionarray<object>

Use the "apply_feature_execution" array to trigger supported CRM features when creating or updating a record through the API. Specify "layout_rules" to apply layout rules or "criteria_validation_rule" to trigger validation rules. For "layout_rules", ensure the request includes all fields required by the layout rule criteria; otherwise, the API returns an error. For "criteria_validation_rule", all applicable validation rules are evaluated, and the API returns "MULTIPLE_OR_MULTI_ERRORS" if multiple rules fail.

namestringrequired

Represents the apply feature execution value.

One oflayout_rulesrange_validationassignment_rulesfunction_validation_rulecriteria_validation_ruleglobal_map_dependencyterritory_subordinates

skip_feature_executionarray<object>

Use the "skip_feature_execution" array to skip Cadences execution when creating a record through the API. Specify "cadences" as the value of the "name" key and include this key alongside "data" in the request.

namestringrequired

Represents the skip feature execution value.

One ofassignment_rulescadencesconnected_workflows

triggerarray<string>

Specifies the CRM features to execute for the API request. Supported values are "workflow", "approval", and "blueprint". If the "trigger" parameter is not specified, workflows, approvals, and blueprints related to the API are executed. Specify an empty array [] to prevent these features from executing.

json

{
  "data": [
    {
      "Layout": {
        "id": "4832675000000850800"
      },
      "Wizard": {
        "id": "string"
      }
    }
  ],
  "apply_feature_execution": [
    {
      "name": "layout_rules"
    }
  ],
  "skip_feature_execution": [
    {
      "name": "assignment_rules"
    }
  ],
  "trigger": [
    "approval"
  ]
}

Response

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

dataarray<object>

Represents the data value.

codestringrequired

Represents the error code identifying the type of failure.

One ofSUCCESS

messagestringrequired

Represents the error message describing why the operation failed.

statusstringrequired

Indicates the overall result status of the request.

One ofsuccess

detailsobjectrequired14 fields

Contains additional context about the error.

json

{
  "data": [
    {
      "code": "SUCCESS",
      "message": "string",
      "status": "success",
      "details": {
        "id": "string",
        "Modified_Time": "2025-01-01T00:00:00Z",
        "Created_Time": "2025-01-01T00:00:00Z",
        "Created_By": {
          "name": "string",
          "id": "string"
        },
        "Modified_By": {
          "name": "string",
          "id": "string"
        },
        "$approval_state": "string",
        "$state": "save",
        "$wizard_connection_path": "string",
        "$process_flow": false,
        "$locked_for_me": false,
        "$approved": false,
        "$status": "cv_1"
      }
    }
  ]
}

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

Was this page helpful?