Create notification recipient

View as Markdown

Create a notification receiver. Use BCTRL-Subaccount-Id to create it for a subaccount. Supported receiver types are email, SMS, and WhatsApp.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

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.
typeenumRequired
valuestringRequired1-500 characters
namestringOptional1-200 characters

Response

Created
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
409
Conflict Error
429
Too Many Requests Error