API Referenceaccount

Update notification recipient

View as Markdown
Update one notification receiver value, label, or enabled state.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

recipientIdstringRequired
Unique notificationRecipient identifier generated by BCTRL.

Headers

BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.

Request

This endpoint expects an object.
enabledbooleanOptional
namestring or nullOptional1-200 characters
valuestringOptional1-500 characters

Response

OK
createdAtstring
enabledboolean
idstring
Unique notificationRecipient identifier generated by BCTRL.
namestring or null
subaccountIdstring or null1-64 characters
Opaque identifier for a BCTRL subaccount.
typeenum
updatedAtstring
valuestring

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error