Change a member's role
Console only — not available with API keys. Signed-in owners and admins use this from the fxapis console. It is not in the SDKs or the Postman collection.
Only the owner changes roles, and the owner's own role cannot be changed here. Takes effect on the member's next request.
Making an admin a member also revokes every API key they made in this workspace, in the same change: a member cannot make keys, so none they made may outlive the role. Each revocation is audited, the owner is emailed the list, and keysRevoked says how many there were. Keys made by anyone else, or with no recorded maker, are not touched. Making a member an admin revokes nothing.
Authorization
apiKey Authorization: Bearer fx_live_<id>_<secret>.
A key is shown once, at creation. We cannot show it again or recover it for you.
Keys carry a label (live or test) in the key itself, so each configuration is easy to tell
apart. Both reach real brokers: test with a broker demo account.
Scopes are per key. A key without accounts:write can read accounts and nothing else.
In: header
Path Parameters
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/members/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "role": "admin" }'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "string", "role": "owner", "you": true, "keysCreated": 0, "createdAt": "2019-08-24T14:15:22Z", "keysRevoked": 0 }}Revoke a key POST
**Needs an admin key** (`fx_admin_…`), made by the workspace owner in the console — or a signed-in owner or admin. Ordinary API keys are refused with `ADMIN_KEY_REQUIRED`. Refused from its very next request — there is no cache to wait for. Revoking an already-revoked key succeeds and changes nothing, so a retried revoke is safe.
Invite someone POST
**Console only — not available with API keys.** Signed-in owners and admins use this from the fxapis console. It is not in the SDKs or the Postman collection. Returns a link to send them; there is no email yet. An address that already has an open invitation gets that invitation back — the same link, not a new one — with `handedBack: true`. To change the role on it, revoke it and invite again. The owner may invite admins and members; an admin may invite members.