v1

latestOpenAPI 3.0.32026-07-2621102.1 MB

Corporate Hierarchy

Delete Groups

Use the Delete Groups endpoint to delete one or more groups. You cannot delete a group that has subgroups or linked accounts. To delete a group that has subgroups or linked accounts, follow the steps in <a href="doc:creating-a-corporate-hierarchy#delete-a-group" target="_blank">Delete a Group</a> in Creating a Corporate Hierarchy.

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

post/deleteGroups

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.