Browse Source

Wallet: Update docs with shared-key API response changes

v1
Steven Bower 7 years ago
parent
commit
1abb66922d
No known key found for this signature in database GPG Key ID: 53B6FEF7AAF4ACDF
  1. 12
      api-docs-slate/source/includes/_wallet.md

12
api-docs-slate/source/includes/_wallet.md

@ -1240,7 +1240,8 @@ account = 'default';
```json
{
"success": true
"success": true,
"addedKey": true
}
```
@ -1250,6 +1251,9 @@ Add a shared xpubkey to wallet. Must be a multisig wallet.
Note that since it must be a multisig, the wallet on creation should be set with <code>m</code> and <code>n</code> where <code>n</code> is greater than 1 (since the first key is always that wallet's own xpubkey)
</aside>
Response will return `addedKey: true` true if key was added on this request. Returns
`false` if key already added, but will still return `success: true` with status `200`.
### HTTP Request
`PUT /wallet/:id/shared-key`
@ -1295,12 +1299,16 @@ const account = 'default';
```json
{
"success": true
"success": true,
"removedKey": true
}
```
Remove shared xpubkey from wallet if present.
Response will return `removedKey: true` true if key was removed on this request. Returns
`false` if key already removed, but will still return `success: true` with status `200`.
### HTTP Request
`DEL /wallet/:id/shared-key`

Loading…
Cancel
Save