offers
This section allows you to manage and get get subscribed information about your project email offer.
Get information about subscribed offers
Retrieve information about the offers you are subscribed to using the project_id and region parameters.
path Parameters
regionThe region you want to target
query Parameters
project_idID of the Project. (UUID format)
Get information about subscribed offers › Responses
total_countNumber of offer-subscriptions matching the requested criteria.
Single page of offer-subscriptions matching the requested criteria.
Update a subscribed offer
path Parameters
regionThe region you want to target
Update a subscribed offer › Request Body
project_idID of the Project. (UUID format)
nameName of the offer-subscription.
Update a subscribed offer › Responses
organization_idID of the offer-subscription Organization.
project_idID of the offer-subscription Project.
offer_nameName of the offer associated with the Project.
subscribed_atDate and time of the subscription. (RFC 3339 format)
cancellation_available_atDate and time of the end of the offer-subscription commitment. (RFC 3339 format)
slaService Level Agreement percentage of the offer-subscription.
max_domainsMax number of domains that can be associated with the offer-subscription for a particular Project.
max_dedicated_ipsMax number of dedicated IPs that can be associated with the offer-subscription for a particular Project.
max_webhooks_per_domainMax number of webhooks that can be associated with the offer-subscription for a particular Project.
max_custom_blocklists_per_domainMax number of custom blocklists that can be associated with the offer-subscription for a particular Project.
included_monthly_emailsNumber of emails included in the offer-subscription per month.
List the available offers.
Retrieve the list of the available and free-of-charge offers you can subscribe to.
path Parameters
regionThe region you want to target
List the available offers. › Responses
total_countNumber of offers matching the requested criteria.
Single page of offers matching the requested criteria.
Get information about a sending pool.
Retrieve information about a sending pool, including its creation status and configuration parameters.
path Parameters
regionThe region you want to target
query Parameters
project_idID of the Project. (UUID format)
pageRequested page number. Value must be greater or equal to 1.
page_sizeRequested page size. Value must be between 1 and 1000.
Get information about a sending pool. › Responses
total_countNumber of pools matching the requested criteria.
Single page of pools matching the requested criteria.