Skip to main content
POST
Create an IP pool request

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

sendingDomainId
string
required

Body

application/json
useType
enum<string>
required
Available options:
transactional,
marketing
estimatedVolume
number
required
Required range: x >= 1
ipCount
number
required
Required range: 1 <= x <= 10

Response

success
boolean
required
Example:

true

message
string
required
data
object
required