Edit Group

General Information

Service	API	Method	Data Model	Workflow
urac	/admin/group	PUT	Groups	Edit Group Flow

Description

This API updates the record of a group that has an id that matches the one sent in the request body. The group should be in the tenant that has the external key sent in the request headers.

Input

Type: application/json

Name

Source

Mandatory

Type

Special Format

Description

id

Body

YES

String

N/A

Group ID

name

Body

YES

String

Group Name

description

Body

NO

String

Group Description

packages

Body

NO

Array

Array of Objects

Packages

Name	Type	Description
product	String	Product Code
package	String	Package Code

environments

Body

NO

Array

Array of Strings

Environments

Output

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response

Valid Response

Valid Response Sample

{ 
  result: true,
  data: 1
}

Invalid Response

Error Response Sample

{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes

Code	Description
400	Business logic required data are missing
602	Model error: + %model_error%

Edit Group

[data-colorid=j97z5brme9]{color:#091e42} html[data-color-mode=dark] [data-colorid=j97z5brme9]{color:#bdd2f6}General Information

Description

Input

Output

Response

Valid Response

Invalid Response

Response schema

SOAJS Error Codes

0 Comments

General Information