PUT - /admin/group

General Information


ServiceAPIMethodData ModelWorkflow
urac/admin/groupPUTGroupsEdit 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
NameSourceMandatoryTypeSpecial FormatDescription
idBodyYESStringN/AGroup ID
nameBodyYESString
Group Name
descriptionBodyNOString
Group Description
packagesBodyNOArrayArray of ObjectsPackages

NameTypeDescription
productStringProduct Code
packagesArray of StringsAn array of Package Codes
environmentsBodyNOArrayArray of StringsEnvironments

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: true
}

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

602Model error: + %model_error%