Updates a MarginX group name and/or its complete member set. Requires Main User Level access with TRANSFER permission.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Updates a MarginX group's name, member set, or both. Member arrays specify the complete desired membership, not members to add or remove incrementally.
Rate limit: 10 requests per minute per API key.
API key access
Requires a signed LTP Open API request with TRANSFER permission.
| API key type | Can call | Scope |
|---|---|---|
| Main User Level API key (also the Main Portfolio key) | Yes | Margin groups belonging to the main user. |
| Sub-user Level API key | No | Not supported. |
| Dedicated Sub Portfolio Level API key | No | Not supported. |
| Exchange-native API key | No | Use an LTP Main User Level API key. |
Parameters
Path
| Name | Type | Required | Description |
|---|---|---|---|
groupId | string | Yes | Margin group ID, not a member ID. A positive integer expressed as a string. |
JSON body
| Name | Type | Required | Description |
|---|---|---|---|
name | string | No | New group name, 1–64 characters after trimming leading/trailing whitespace. Must be unique within the main user's groups. Omit to retain the existing name. |
dmaGroupMemberList | array of objects | Conditional | Complete desired DMA membership. Each item contains memberId, the DMA account ID. Supply together with rxGroupMemberList. |
rxGroupMemberList | array of objects | Conditional | Complete desired RapidX membership. Each item contains memberId, the Portfolio ID, and venue, its exchange. Supply together with dmaGroupMemberList. |
How updates work
- Rename only: send
nameand omit both member arrays. Existing members are retained. - Update members: send both arrays, including every member to retain. Omit
nameto retain the existing group name. - An existing member omitted from the submitted complete set is removed. Use
[]to remove all members of one account family, but the two arrays must contain 1–30 members in total. - Supplying only one array, both arrays empty, or an empty body is rejected. A group must always have at least one member.
- DMA identity is
memberId; RapidX identity ismemberIdplusvenue. The same Portfolio's Binance and OKX venues are separate members. - New members must be eligible for MarginX and cannot belong to another group. Frozen, restricted or external accounts cannot be added. Members retained in the current group are allowed.
- A member being removed must have its debt settled; in-flight orders and the resulting group's risk conditions are also checked.
- If validation fails, neither the name nor the member set is partially saved.
Read all pages of Get Margin Group Members before constructing a complete replacement set. Do not treat one page as the full group.
Signing
See Authentication. Nested member arrays use the same signing representation as Create Margin Group — Signing a body containing member arrays: for example, [{memberId=71001, venue=BINANCE}]. The HTTP body remains standard JSON. Omitted fields are not included in the signing string.
For a rename-only body {"name":"Group Alpha Renamed"}, the HMAC input is:
name=Group Alpha Renamed&<nonce>Response fields
| Field | Type | Description |
|---|---|---|
code | integer | 200 means success; any other value indicates an error. |
message | string | Result message. |
data.id | string | Updated margin group ID. |
data.updated | boolean | true when the update succeeds. |
The response panel includes rename-only, membership-only and combined request examples, plus success and error responses. Query the group list and member list to read back the saved name and membership.
Error codes
Errors can return HTTP 200 with a non-success JSON code. Check code, not HTTP status alone. See Error Codes for shared errors.
| Code | When it occurs | What to do |
|---|---|---|
1000 | A member list has the wrong JSON type. Example: Invalid JSON type for dmaGroupMemberList. | Send member lists as JSON arrays. |
1001 | A required nested field is missing; for example, Missing required field: venue. | Supply the field identified by the message. |
100400 | Invalid ID/name, empty body, only one member array, no members, duplicate members or an unsupported venue. | Check the update rules above. An unsupported RapidX venue can return Unsupported RapidX venue. |
-1 | Group or member business validation fails, or the name is already used. Observed messages include Group not found., Account data temporarily unavailable, MarginX group data unavailable and a duplicate-name message. | Check the group ID, name and member eligibility. These messages do not necessarily indicate a transient outage; do not blindly retry. |
2000 | Signature verification fails. | Check the authentication headers and nested-array signing format. |
2003 | The calling API key level is not allowed. | Use a Main User Level API key. |
2004 | The key lacks a required permission. | Use a key with TRANSFER permission. |
100429 | Rate limit exceeded. | Reduce the request rate. |
If a request times out, query the saved name and members before retrying.