auth.v1.AddressBookService
UpdateAddressBookTag
Method
POST
Path
auth.v1.AddressBookService/UpdateAddressBookTag
Service
auth.v1.AddressBookService
Visibility
Authentication
Session token
MFA Requirement
Not required
POST
auth.v1.AddressBookService/UpdateAddressBookTag Request
Testnet
curl --request POST \ \
--url 'https://api.testnet.polyester.com/auth.v1.AddressBookService/UpdateAddressBookTag' \
--header 'Content-Type: application/json' \
--header 'Connect-Protocol-Version: 1' \
--data '{
"color": "#7C3AED",
"name": "Treasury",
"tagId": "1"
}'Responses
{
"tag": {
"color": "#7C3AED",
"createdAt": "2025-01-01T00:00:00Z",
"name": "Treasury",
"scope": {
"rootAccountId": "7563897446546",
"scopeType": "SCOPE_ROOT",
"subaccountId": "6789012345678"
},
"tagId": "1",
"updatedAt": "2025-01-01T00:00:00Z"
}
}Request
auth.v1.UpdateAddressBookTagRequestResponse
auth.v1.UpdateAddressBookTagResponse tagId string (fixed64)
Tag id to update.
name string
Replacement tag name. Omit to preserve the current name.
color string (color)
Replacement UI color token. Omit to preserve; an empty value clears it.
6 fields
tagId string (fixed64)
Stable public id of the tag.
3 fields
scopeType enum
Address-book scope type.
SCOPE_ROOT SCOPE_SUBACCOUNT
rootAccountId string (fixed64)
Root account that owns this address book.
subaccountId string (fixed64)
Subaccount for subaccount-scoped books. Empty for root account books.
name string
Human-readable tag name.
color string (color)
Optional UI color token for this tag.
createdAt string (date-time)
Time the tag was created, as a UTC timestamp.
updatedAt string (date-time)
Time this tag was last updated, as a UTC timestamp.
| Key | HTTP status | Connect code | Error | When |
|---|---|---|---|---|
| unauthenticated | 401 | unauthenticated | Unauthenticated | Authentication required. |
| permission-denied | 403 | permission_denied | Permission Denied | Permission denied. |
| invalid-argument | 400 | invalid_argument | Invalid Argument | Invalid argument. |
| not-found | 404 | not_found | Not Found | Not found. |
| unavailable | 503 | unavailable | Unavailable | Service unavailable. |