Update Group

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/updateGroup

Use the Update Group endpoint to update an existing group, either a root group or a non-root group. Pass only the parameter(s) to update. All of the name parameters support the Latin-9 (ISO-8859-15) character set. You cannot change the parent ID of a group. See Creating a Corporate Hierarchy for instructions on using this endpoint.

Status codes

See Global Response Statuses for status codes that are common across endpoints.

The table below lists status codes that apply to this specific endpoint.

Status code	Description
615-01	Invalid group ID. The `groupId` does not exist in the core. Verify that `groupId` is correct by calling Get Group Hierarchy for the root group.
615-02	Maximum level for a root group cannot be decreased. Set `maxLevel` to a value higher than the current level.
615-03	Cannot update `maxLevel` for a non-root group. Verify that `groupId` is a root group or leave `maxLevel` blank.

Form Data

apiLogin

string

required

Web service username, as provided by Galileo.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Web service password, as provided by Galileo.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

providerId

int32

required

Galileo-issued provider identifier.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

1 to 60

A unique provider-generated ID to identify this API call. A UUID is preferred.
Pattern: 60 characters or less
Example: "9845dk-39fdk3fj3-4483483478"

groupId

string

required

length between 1 and 10

Identifier of the group (group_id) as returned by the Create Group endpoint.
Pattern: Max 10 numeric characters
Example: "4522"

groupName

string

length between 1 and 40

Name of the group.
Pattern: 1–40 alphanumeric characters, including spaces, hyphens, and single quotes
Example: "CDE Corp"

maxLevel

int32 | null

1 to 5

Maximum number of subgroup levels that can be created below this root group. Required when creating a root group. Not valid when parentGroupId is populated. This value cannot be changed to a smaller number after it is set.
Pattern: Numerals 0–5
Example: 3

externalId

string | null

Provider-specified identifier for the group.
Pattern: Max 30 alphanumeric characters
Example: "L0000"

doingBusinessAs

string | null

Operating name of the company, if different from businessLegalName.
Pattern: 2–150 alphanumeric characters, as shown in businessName parameter
Example: "SportsBall Enterprises"

businessLegalName

string | null

Legal name of the business.
Pattern: 2–150 alphanumeric characters, as shown in businessName parameter
Example: "CDE Corporation, Inc."

phoneCountryCode

string | null

2 to 4

Country code prefix for phone. If this parameter is populated, then phone is required.
Pattern: Plus sign (+) with 1–3 digits
Example: "+011"

phone

string | null

Phone number for the primaryContactName. If this parameter is populated, then phoneCountryCode is required.
Pattern: Phone number for the primaryContactName.
Example: "18015551456"

primaryContactName

string | null

The name of the primary point of contact at businessLegalName.
Pattern: 2–150 Latin-9 characters
Example: "Maxina Seward"

primaryContactEmail

string | null

Email address of primaryContactName.
Pattern: Email address, 3–63 characters
Example: "[email protected]"

smartdata

string | null

enum

Specifies whether the root group is to be enrolled in Mastercard Smart Data.
Pattern: String
Example: "Y"

Allowed:

employerId

string | null

The employer identification number (EIN) from the IRS.
Pattern: 99-9999999.
Example: "12-3456789"

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

Status codes

default