2.Group Management

Updated by MoreLogin

2.1 New Group

Basic info

POST  /group/profile/add

Interface description:Add a group. After successful addition, it can be used for grouping browser profiles. The name must be unique. Upon successful creation, the group ID will be returned.

Request parameters

Header parameters

Parameter name

Type

Required

Default value

Sample

Desc_

x-api-key

string

Yes

-

-

Each MoreLogin user has their own special API-key, you can see in the system api page

Body Parameters, Optional Parameters can be omitted. The parameter format is JSON.

Parameter name

Type

Required

Default value

Sample

Desc_

name

string

Yes

-

group1

Group Name(Maximum 100 characters)

Return data

{
"ret": 0, //error code
"msg": "string", //error information
"data": {
"id": 0 //group id
}
}

2.2 Edit Group

Basic info

POST  /group/profile/edit

Interface description:You can modify the group information, including the group name. The name must be unique. Please make sure to update your system to version 1.9.7.18 or above (currently only supported on Windows).

Request parameters

Header parameters

Parameter name

Type

Required

Default value

Sample

Desc_

x-api-key

string

Yes

-

-

Each MoreLogin user has their own special API-key, you can see in the system api page

Body Parameters, Optional Parameters can be omitted. The parameter format is JSON.

Parameter name

Type

Required

Default value

Sample

Desc_

id

integer

Yes

-

XXXXX

Group ID

name

string

Yes

-

XXXXX

Group Name(Maximum 100 characters)

Return data

{
"ret": 0, //error code
"msg": "string" //error information
}

2.3 Delete Group

Basic info

POST  /group/profile/delete

Interface description:You can delete the specified group.

Request parameters

Header parameters

Parameter name

Type

Required

Default value

Sample

Desc_

x-api-key

string

Yes

-

-

Each MoreLogin user has their own special API-key, you can see in the system api page

Body Parameters, Optional Parameters can be omitted. The parameter format is JSON.

Parameter name

Type

Required

Default value

Sample

Desc_

id

integer

Yes

-

XXXXX

Group ID

Return data

{
"ret": 0, //error code
"msg": "string" //error information
}

2.4 Get group list

Basic info

GET  /group/profile/list

Interface description:You can query the information of groups, including the group ID and group name. The group ID is used for grouping browser profiles.

Request parameters

Header parameters

Parameter name

Type

Required

Default value

Sample

Desc_

x-api-key

string

Yes

-

-

Each MoreLogin user has their own special API-key, you can see in the system api page

Query Parameters, Optional Parameters can be omitted.

Parameter name

Type

Required

Default value

Sample

Desc_

page

integer

N

1

1

Page number: Default 1, used when the number of pages large and needs to be turned

page_size

integer

N

10

20

Page size: Default 10 per page, maximum 100

Return data

{
"ret": 0,
"msg": "string",
"count": 0, //total count number
"data": [ //group list
{
"id": 0, //group id
"name": "string" //group name
}
]
}


How did we do?