Address Book

BatchAddAddressBookEntriesToGroup

Batch add existing address book entries to an address book entry group. Initiates a quorum action.

post/v2/vaults/{vault_id}/addressBookEntries:batchAdd

Request

Base URL
https://api.utila.io
Auth
HTTP bearer
TypeScript
https://skmtc.dev/utila/apis/utila-api/docs/v2/vaults/:vault_id/addressBookEntries:batchAdd/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

vault_idstring required

Request body

addressBookEntryGroupstring required

The resource name of the address book entry group that the entries should be added to.

Format: vaults/{vault_id}/addressBookEntryGroups/{group_id}

namesstring[] required

The resource names of the address book entries to add to the group.

Format: vaults/{vault_id}/addressBookEntries/{entry_id}

Example request

{
  "addressBookEntryGroup": "vaults/1b25635a5b3f/addressBookEntryGroups/abc123",
  "names": [
    "vaults/1b25635a5b3f/addressBookEntries/95257c5a522f"
  ]
}

Response

A successful response.

Changes

No recorded changes to this operation across all 2 revisions of this API.