Nexmo Subaccounts
Nexmo Subaccounts is an API for managing separate Vonage/Nexmo account partitions under a parent communications account.
- Base URL:
https://api.nexmo.com/accounts - Auth:
basic(pass your key via theapiKeyinput)
Operations
retrievebalancetransfers— GET /{api_key}/balance-transfers — Retrieve list of balance transfersretrievecredittransfers— GET /{api_key}/credit-transfers — Retrieve list of credit transfersretrievesubaccountslist— GET /{api_key}/subaccounts — Retrieve list of subaccountsretrievesubaccount— GET /{api_key}/subaccounts/{subaccount_key} — Retrieve a subaccounttransferbalance— POST /{api_key}/balance-transfers — Transfer balancetransfercredit— POST /{api_key}/credit-transfers — Transfer credit
Inputs
apiKey— your nexmo-subaccounts API keyoperation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: retrievebalancetransfers
apiKey: <your key>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
apiKey |
string | yes | — | DEPRECATED — bind an API Key credential to the task with credentialName instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change. |
operation |
string | yes | — | One of: retrievebalancetransfers, retrievecredittransfers, retrievesubaccountslist, retrievesubaccount, transferbalance, transfercredit |
api_key |
string | no | — | Path parameter api_key (required by some operations). |
subaccount_key |
string | no | — | Path parameter subaccount_key (required by some operations). |
query |
string | no | — | Optional query params as a JSON object string, e.g. {"limit": 10}. |
body |
string | no | — | Request body as a JSON object string (for create/update operations). |