---
name: "openGroupCreate"
mode: "kit"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.4.20" }
title: "openGroupCreate"
---

## openGroupCreate

> [VERSION] @ray-js/ray >= 1.4.20

### Description

Open the group creation page

### Parameters

`Params`

| Parameter | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `params` | `OpenGroupCreateParams` | Yes | - | Parameters for creating a group |

### Referenced Types

##### `interface` OpenGroupCreateParams

| Property | Type | Description |
| --- | --- | --- |
| `deviceId` | `string` | Device ID |
| `name` | `string` | Name |
| `type` | `string` | Sub-feature display type |
| `optionType` | `string` | Sub-feature grouping type |
| `from` | `"RN" \| "小程序" \| "APP"` | Sub-feature source |
| `order` | `number` | Sort order |
| `isShow` | `boolean` | Whether to display |
| `success` | `() => void` | Callback on successful API call |
| `fail` | `(err: Object) => void` | Failure callback |
| `complete` | `() => void` | Completion callback (executed on both success and failure) |

##### `type` OpenGroupCreateParams.fail.err

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` |  |
| `errorCode` | `string \| number` |  |
| `innerError` | `Object` |  |

##### `type` OpenGroupCreateParams.fail.err.innerError

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` |  |
| `errorMsg` | `string` |  |


### Examples

```ts
openGroupCreate({
  deviceId: 'xxxx',
  success() {
    console.log('Opened the group creation page successfully');
  },
  fail(err) {
    console.log('Failed to open the group creation page', err);
  },
});
```
