younifyd
Menu

Update a role

Update a role

PUT/settings/roles/{role}

Use it in a workflow

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

Request

Path parameters

roleinteger (int64)required

The unique ID of the role.

Request body

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

rolesarray<object>required

Specify the array containing the role object to update.

reporting_toobject1 fields

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

share_with_peersboolean

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 updated description for the role.

namestringrequired

Specify the updated display name for the role.

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

Response

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

rolesarray<object>

Represents the list containing the role update result.

codestringrequired

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

One ofSUCCESS

detailsobjectrequired1 fields

Represents additional details about the updated role.

messagestringrequired

Represents the status message for the role update result.

statusstringrequired

Represents the status of the role update operation. Possible values: **success** - The role update 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.