Schemas

ID of the blocklist.

Domain ID linked to the blocklist.

Date and time of the blocklist creation. (RFC 3339 format)

Date and time of the blocklist's last update. (RFC 3339 format)

Date and time when the blocklist ends. Empty if the blocklist has no end. (RFC 3339 format)

Email blocked by the blocklist.

Type of block for this email.

Reason to block this email.

True if this blocklist was created manually. False for an automatic Transactional Email blocklist.

List of blocklist created.

Email address.

(Optional) Name displayed.

Filename of the attachment.

MIME type of the attachment.

Content of the attachment encoded in base64.

Email header key.

Email header value.

Single page of emails matching the requested criteria.

ID of the domain.

ID of the domain's Organization.

ID of the domain's Project.

Domain name (example.com).

Status of the domain.

Date and time of domain creation. (RFC 3339 format)

Date and time of the next scheduled check. (RFC 3339 format)

Date and time the domain was last valid. (RFC 3339 format)

Date and time of the domain's deletion. (RFC 3339 format)

Snippet of the SPF record to register in the DNS zone.

DKIM public key to record in the DNS zone.

Domain's statistics.

The domain's reputation is available when your domain is checked and has sent enough emails.

List of records to configure to validate a domain.

Status of auto-configuration for the domain's DNS zone.

The region you want to target

The ID of the domain.

The domain name (example.com).

The SPF record verification data.

The DKIM record verification data.

The DMARC record verification data.

The MX record verification data.

The verification state of domain auto-configuration.

Technical ID of the email.

Message ID of the email.

ID of the Project to which the email belongs.

Email address of the sender.

Email address of the recipient.

Type of recipient.

Subject of the email.

Creation date of the email object. (RFC 3339 format)

Last update of the email object. (RFC 3339 format)

Status of the email.

Additional status information.

Number of attempts to send the email.

Information about the last three attempts to send the email.

Flags categorize emails. They allow you to obtain more information about recurring errors, for example.

Rank number of this attempt to send the email.

Date of the attempt to send the email. (RFC 3339 format)

The SMTP status code received after the attempt. 0 if the attempt did not reach an SMTP server.

The SMTP message received. If the attempt did not reach an SMTP server, the message returned explains what happened.

Number of blocklists matching the requested criteria.

Single page of blocklists matching the requested criteria.

Number of domains that match the request (without pagination).

Single page of domains matching the requested criteria.

Number of emails matching the requested criteria.

Single page of emails matching the requested criteria.

Number of offer-subscriptions matching the requested criteria.

Single page of offer-subscriptions matching the requested criteria.

Number of offers matching the requested criteria.

Single page of offers matching the requested criteria.

Number of pools matching the requested criteria.

Single page of pools matching the requested criteria.

Number of Webhook events matching the requested criteria.

Single page of Webhook events matching the requested criteria.

Number of Webhooks matching the requested criteria.

Single page of Webhooks matching the requested criteria.

Name of the offer.

Date and time of the offer creation. (RFC 3339 format)

Period of commitment. (in seconds)

Service Level Agreement percentage of the offer.

Max number of checked domains that can be associated with the offer.

Max number of dedicated IPs that can be associated with the offer.

Number of emails included in the offer per month.

Max number of webhooks that can be associated with the offer.

Max number of active custom blocklists that can be associated with the offer.

ID of the offer-subscription Organization.

ID of the offer-subscription Project.

Name of the offer associated with the Project.

Date and time of the subscription. (RFC 3339 format)

Date and time of the end of the offer-subscription commitment. (RFC 3339 format)

Service Level Agreement percentage of the offer-subscription.

Max number of domains that can be associated with the offer-subscription for a particular Project.

Max number of dedicated IPs that can be associated with the offer-subscription for a particular Project.

Max number of webhooks that can be associated with the offer-subscription for a particular Project.

Max number of custom blocklists that can be associated with the offer-subscription for a particular Project.

Number of emails included in the offer-subscription per month.

ID of the Project.

Status of the pool.

Details of the pool.

Zone of the pool.

IPs of the pool. (IP address)

Reverse hostname of all IPs of the pool.

ID of the project.

Number of domains in the project.

Number of dedicated IP in the project.

Number of emails sent during the current month in the project.

Number of webhooks in the project.

Number of custom blocklists in the project.

Information about your periodic report.

Total number of emails matching the requested criteria.

Number of emails still in the new transient state. This means emails received from the API but not yet processed.

Number of emails still in the sending transient state. This means emails received from the API but not yet in their final status.

Number of emails in the final sent state. This means emails that have been delivered to the target mail system.

Number of emails in the final failed state. This means emails that have been refused by the target mail system with a final error status.

Number of emails in the final canceled state. This means emails that have been canceled upon request.

ID of the Webhook.

ID of the Domain to watch for triggering events.

ID of the Webhook Organization.

ID of the Webhook Project.

Name of the Webhook.

List of event types that will trigger a Webhook Event.

Scaleway SNS ARN topic to push the events to.

Date and time of the Webhook creation. (RFC 3339 format)

Date and time of last Webhook updates. (RFC 3339 format)

ID of the Webhook Event.

ID of the Webhook that triggers the Event.

ID of the Webhook Event Organization.

ID of the Webhook Event Project.

ID of the webhook event domain.

Type of the Webhook Event.

Status of the Webhook Event.

Data sent to the Webhook destination.

Date and time of the Webhook Event creation. (RFC 3339 format)

Date and time of last Webhook Event updates. (RFC 3339 format)

Optional Email ID if the event is triggered by an Email resource.