Skip to main content
PATCH
Update a sending domain

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
dkimEnabled
boolean
spfEnabled
boolean
dmarcEnabled
boolean
trackingEnabled
boolean
trackingHostname
string
Minimum string length: 1
clickTrackingEnabled
boolean
openTrackingEnabled
boolean
unsubscribesEnabled
boolean
returnPathEnabled
boolean

Response

success
boolean
required
Example:

true

message
string
required
data
object
required