Ctrl+K

Set user notification subscriptions (admin)

put/api/notifications/v1/admin/user/{bitgoUserId}/subscriptions

Allows an admin to update or create notification subscriptions for a user. Accepts a batch of subscriptions and replaces the user's current subscriptions with the provided set. Useful for bulk management of user notification preferences.

Path Parameters

  • bitgoUserIdstringRequired

Request Body

notificationSubscriptions array[object] required
Min items: >= 0 items
Max items: <= 100 items
notificationName string
categoryName string
channel string required
Min length: >= 0 characters
Max length: <= 50 characters
isSubscribed boolean required

200 Response

string

400 Response

name string required
Error code
Allowed values: ValidationFailed IllegalArgument BadRequest DataIntegrityError NotImplementedError RETRIGGER_RATE_LIMITED USER_CREATION_FAILED USER_FALLBACK_FAILED
error string required
Human-readable error message
status integer <int32>required
HTTP status code
Allowed value: 400

403 Response

name string required
Error code
Allowed value: AccessDenied
error string required
Human-readable error message
status integer <int32>required
HTTP status code
Allowed value: 403

500 Response

name string required
Error code
Allowed values: UnexpectedError ThirdPartyError DatabaseError USER_FALLBACK_TIMEOUT
error string required
Human-readable error message
status integer <int32>required
HTTP status code
Allowed value: 500