Set Account Group Relationships

post

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

Use the Set Account Group Relationships endpoint to associate one or more accounts with a group. This endpoint can update up to 100 accounts in one request. You can also use this endpoint to reassign an account to a different group without first deleting the existing relationship. 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
618-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.

Form Data

apiLogin

string

required

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

apiTransKey

string

required

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

providerId

int32

required

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

transactionId

string

required

1 to 60

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency. A UUID is preferred.
Pattern: Maximum 60 characters
Example: "9845dk-39fdk3fj3-4483483478"

accountNos

array of strings or null

required

length between 1 and 100

PRN of the account or a list of PRNs to link to the groupId. Up to 100 PRNs can be listed in this parameter.
To input a JSON list as the value, you must set the Content-Type in the header to application/json. If the Content-Type is not json, then pass one parameter/value pair for each value. See Inputting multiple values for examples.Pattern: PRN or list of PRNs
Example: ["222222222222", "333333333333"] or ["444444444444"]

accountNos*

The PRN of the account.
Pattern: PRN
Example: "074103447228"

groupId

string

required

length between 1 and 10

^[\d]+$

Parent Group Id. Unique SoFi Tech Solutions-defined identifier for the parent group
Example: "123"

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