GAgalileo-ft
Corporate Hierarchy

Update Group

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 <a href="doc:creating-a-corporate-hierarchy" target="_blank">Creating a Corporate Hierarchy</a> for instructions on using this endpoint.

post/updateGroup

Request

  • Base URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
  • URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/updateGroup
  • Auth
    none declared

Request body application/x-www-form-urlencoded

apiLoginstring required

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

apiTransKeystring required

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

providerIdinteger required

Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10 digits Example: 9999

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

groupIdstring required

Identifier of the group (group_id) as returned by the <a href="ref:post_creategroup" target="_blank">Create Group</a> endpoint. Pattern: Max 10 numeric characters Example: "4522"

groupNamestring

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

maxLevelinteger nullable

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

externalIdstring nullable

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

doingBusinessAsstring nullable

Operating name of the company, if different from businessLegalName. Pattern: 2–150 alphanumeric characters, as shown in <a href="ref:api-reference-special-characters#businessname-parameter" target="_blank">businessName parameter</a> Example: "SportsBall Enterprises"

businessLegalNamestring nullable

Legal name of the business. Pattern: 2–150 alphanumeric characters, as shown in <a href="ref:api-reference-special-characters#businessname-parameter" target="_blank">businessName parameter</a> Example: "CDE Corporation, Inc."

phoneCountryCodestring nullable

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

phonestring nullable

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

primaryContactNamestring nullable

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

primaryContactEmailstring nullable

Email address of primaryContactName. Pattern: Email address, 3–63 characters Example: "mseward@cde-corp.com"

smartdata'Y' | 'N' nullable

Specifies whether the root group is to be enrolled in <a href="doc:business-banking-enhancements#mastercard-smart-data" target="_blank">Mastercard Smart Data</a>. Pattern: String Example: "Y"

employerIdstring nullable

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

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "groupId": "123",
  "groupName": "CDE Corp",
  "externalId": "L0000",
  "doingBusinessAs": "SportsBall Enterprises",
  "businessLegalName": "CDE Corporation, Inc.",
  "phoneCountryCode": "+011",
  "phone": "18015551456",
  "primaryContactName": "Maxina Seward",
  "primaryContactEmail": "mseward@cde-corp.com",
  "smartdata": "Y",
  "employerId": "12-3456789"
}

Response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed

response_dataobject required

A structure for the response data. This endpoint does not return response data, so it will always be empty.

Changes

No recorded changes to this operation across all 2 revisions of this API.