younifyd
Menu

Create a role

Create a role

POST/settings/roles

Use it in a workflow

  1. Add a step and choose the Zoho CRM connector.
  2. Pick the Create a role action (under Users).
  3. Fill in the fields below, then reference the result from later steps as {{createARole.response.data}}.

Request

Request body

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

rolesarray<object>required

Specify the array of role objects to create. You can include exactly one object per request (bulk create/update is not supported).

reporting_toobjectrequired1 fields

Specify the parent role to which this new role reports in the CRM role hierarchy. Refer to the [Get Roles](roles.yaml#$.paths./settings/roles.get) resource for valid values.

share_with_peersboolean | null

Specify whether users assigned to this role can share records with users in peer roles at the same level. Possible values: **true** - Users assigned to this role can share records with peer role users. **false** - Users assigned to this role cannot share records with peer role users.

descriptionstring | null

Specify the description of the role to provide additional context about its purpose and responsibilities.

namestringrequired

Specify the display name for the role.

json
{
  "roles": [
    {
      "reporting_to": {
        "id": "string"
      },
      "name": "string",
      "share_with_peers": false,
      "description": "string"
    }
  ]
}

Response

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

rolesarray<object>

Represents the list of role creation results.

codestringrequired

Represents the result code of the role creation operation. Possible values: **SUCCESS** - The role creation succeeded.

One ofSUCCESS

detailsobjectrequired1 fields

Represents additional details about the created role.

messagestringrequired

Represents the status message for the role creation result.

statusstringrequired

Represents the status of the role creation operation. Possible values: **success** - The role creation succeeded.

One ofsuccess

json
{
  "roles": [
    {
      "code": "SUCCESS",
      "details": {
        "id": "string"
      },
      "message": "string",
      "status": "success"
    }
  ]
}

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

Create a role — Zoho CRM — Documentation