Skip to main content
PATCH
Update a sender identity

Authorizations

X-API-Key
string
header
required

An organization API key, prefixed bk_live_. Takes precedence over Authorization when both are sent. The key is bound to one organization, and the scopes it was issued with are enforced per endpoint.

Headers

X-Organization-Id
string<uuid>

Required when authenticating with an access token. Optional with an API key, whose own organization binding is authoritative; a value contradicting it is refused with 403.

Path Parameters

id
string
required

Body

application/json
label
string
Minimum string length: 1
value
string
Minimum string length: 1
fromName
string | null
Minimum string length: 1
replyTo
string<email> | null
metadata
object | null
sendingDomainId
string<uuid> | null
isDefault
boolean

Response

success
boolean
required
Example:

true

message
string
required
data
object
required