Skip to main content
PATCH
/
clients
/
me
/
backup-share-pairs
Update backup share pair statuses
curl --request PATCH \
  --url https://api.portalhq.io/api/v3/clients/me/backup-share-pairs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "backupSharePairIds": [
    "bsp_abc123",
    "bsp_def456"
  ],
  "status": "STORED_CLIENT_BACKUP_SHARE"
}
'
{
  "error": "<string>"
}

Authorizations

​
Authorization
string
header
required

Client API Key or Client Session Token (CST). Pass as a Bearer token in the Authorization header.

Body

application/json
​
backupSharePairIds
string[]
required

Array of backup share pair IDs to update.

​
status
enum<string>
required

Target status. Valid values:

  • STORED_CLIENT_BACKUP_SHARE_KEY — requires current status STORED_CUSTODIAN_BACKUP_SHARE
  • STORED_CLIENT_BACKUP_SHARE — accepts STORED_CUSTODIAN_BACKUP_SHARE or STORED_CLIENT_BACKUP_SHARE_KEY
Available options:
STORED_CLIENT_BACKUP_SHARE,
STORED_CLIENT_BACKUP_SHARE_KEY

Response

Backup share pairs updated successfully (no content)