On This Page

Update Group Details

You can update an organization group by modifying its description. You can also add organizations to the group, remove organizations from the group, or do both in a single request.

A request to update group details generates a response status code but not a response body. Any of these response codes may be generated:

200

The organization group was successfully updated.

400

The request was invalid or cannot be processed.

401

Authentication credentials are missing or invalid.

403

The request is understood but access is not allowed.

404

The requested resource does not exist.

500

An unexpected system error occurred or the request timed out.

Endpoints

Production:

PATCH https://api.cybersource.com/groups/{groupId}

Test:

PATCH https://apitest.cybersource.com/groups/{groupId}

Required Fields for Updating Group Details

groupId: The unique numeric identifier for a group.

organizationId: The unique identifier of the organization that owns the group.

Optional Fields for Updating Group Details

addOrganizationIds: The list of organization IDs to add as new members to the group.

description: The description of the group that explains the purpose of the group.
removeOrganizationIds: The list of organization IDs to remove from the group.

REST Example: Update Group Details

Request

{
   "organizationId": "test_organization_id",
   "description": "test group description",
   "addOrganizationIds": [
      "test_organization_id1",
      "test_organization_id2"
   ],
   "removeOrganizationIds": [
      "test_organization_id3"
   ]
}

Response to a Successful Request

200 OK