Skip to content

Regenerate for the list object on domains, webhooks and API keys #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bobbyonmagic merged 1 commit into from
Oct 9, 2026
Merged

Regenerate for the list object on domains, webhooks and API keys #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
187 changes: 158 additions & 29 deletions spec/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,7 @@
"post": {
"operationId": "sendEmailBatch",
"summary": "Send a batch of emails",
"description": "Queue up to 100 emails in a single request. The body is a JSON array of email objects, each using the same shape as the single-send endpoint. Validation runs on every item before any are queued \u2014 a malformed item rejects the whole batch with 400. Suppressed recipients (to, cc and bcc) are dropped per row; a row left with no deliverable To recipient is recorded with status \"failed\". The batch is accepted whole or not at all: every email is recorded and queued, or none is, so there is no partial success to reconcile. A 4xx means nothing was queued. After a 5xx or a lost response, retry with the same Idempotency-Key: you get the first answer if the batch was accepted, or a fresh attempt if it was not.",
"description": "Queue up to 100 emails in a single request. The body is a JSON array of email objects, each using the same shape as the single-send endpoint. Validation runs on every item before any are queued — a malformed item rejects the whole batch with 400. Suppressed recipients (to, cc and bcc) are dropped per row; a row left with no deliverable To recipient is recorded with status \"failed\". The batch is accepted whole or not at all: every email is recorded and queued, or none is, so there is no partial success to reconcile. A 4xx means nothing was queued. After a 5xx or a lost response, retry with the same Idempotency-Key: you get the first answer if the batch was accepted, or a fresh attempt if it was not.",
"tags": [
"Emails"
],
Expand Down Expand Up @@ -2022,7 +2022,7 @@
}
},
"402": {
"description": "Error",
"description": "Plan limit reached - upgrade the plan to add more",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -4095,6 +4095,10 @@
"type": "string",
"example": "list"
},
"has_more": {
"type": "boolean",
"example": false
},
"data": {
"type": "array",
"items": {
Expand Down Expand Up @@ -5570,9 +5574,19 @@
"schema": {
"type": "object",
"required": [
"object",
"has_more",
"data"
],
"properties": {
"object": {
"type": "string",
"example": "list"
},
"has_more": {
"type": "boolean",
"example": false
},
"data": {
"type": "array",
"items": {
Expand Down Expand Up @@ -5992,6 +6006,16 @@
}
}
},
"402": {
"description": "Plan limit reached - upgrade the plan to add more",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Forbidden - domain not verified or insufficient permissions",
"content": {
Expand Down Expand Up @@ -6376,6 +6400,16 @@
}
}
},
"402": {
"description": "Plan limit reached - upgrade the plan to add more",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Forbidden - domain not verified or insufficient permissions",
"content": {
Expand Down Expand Up @@ -10813,7 +10847,7 @@
}
},
"402": {
"description": "Error",
"description": "Plan limit reached - upgrade the plan to add more",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -10881,9 +10915,27 @@
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DomainListItem"
"type": "object",
"required": [
"object",
"has_more",
"data"
],
"properties": {
"object": {
"type": "string",
"example": "list"
},
"has_more": {
"type": "boolean",
"example": false
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DomainListItem"
}
}
}
}
}
Expand Down Expand Up @@ -11175,7 +11227,7 @@
}
},
"402": {
"description": "Error",
"description": "Plan limit reached - upgrade the plan to add more",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -11446,7 +11498,7 @@
}
},
"402": {
"description": "Error",
"description": "Plan limit reached - upgrade the plan to add more",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -11743,9 +11795,27 @@
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiKey"
"type": "object",
"required": [
"object",
"has_more",
"data"
],
"properties": {
"object": {
"type": "string",
"example": "list"
},
"has_more": {
"type": "boolean",
"example": false
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiKey"
}
}
}
}
}
Expand Down Expand Up @@ -12055,6 +12125,26 @@
}
}
},
"402": {
"description": "Plan limit reached - upgrade the plan to add more",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Forbidden - domain not verified or insufficient permissions",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limit exceeded - retry after the period indicated in the Retry-After header",
"content": {
Expand Down Expand Up @@ -12094,9 +12184,27 @@
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
"type": "object",
"required": [
"object",
"has_more",
"data"
],
"properties": {
"object": {
"type": "string",
"example": "list"
},
"has_more": {
"type": "boolean",
"example": false
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
}
}
}
}
}
Expand Down Expand Up @@ -16145,12 +16253,17 @@
"EmailList": {
"type": "object",
"required": [
"object",
"data",
"limit",
"total",
"has_more"
],
"properties": {
"object": {
"type": "string",
"example": "list"
},
"data": {
"type": "array",
"items": {
Expand Down Expand Up @@ -16665,6 +16778,7 @@
"type": "object",
"required": [
"object",
"has_more",
"data",
"total",
"segment_limit"
Expand All @@ -16674,6 +16788,11 @@
"type": "string",
"example": "list"
},
"has_more": {
"type": "boolean",
"example": false,
"description": "Always false: every segment is in one page"
},
"data": {
"type": "array",
"items": {
Expand Down Expand Up @@ -18101,6 +18220,8 @@
"PendingSignupList": {
"type": "object",
"required": [
"object",
"has_more",
"data",
"total",
"undeliverable_total",
Expand All @@ -18110,6 +18231,14 @@
"per_page"
],
"properties": {
"object": {
"type": "string",
"example": "list"
},
"has_more": {
"type": "boolean",
"example": false
},
"data": {
"type": "array",
"items": {
Expand Down Expand Up @@ -18492,18 +18621,18 @@
},
"DomainListItem": {
"type": "object",
"description": "A domain as the list returns it. The field names are camelCase here, unlike the rest of the API.",
"description": "A domain as the list returns it. GET /v1/domains/{id} has the DNS records and verification detail.",
"required": [
"id",
"domain",
"status",
"dkimStatus",
"spfStatus",
"dmarcStatus",
"verifiedAt",
"createdAt",
"receivingEnabled",
"receivingStatus"
"dkim_status",
"spf_status",
"dmarc_status",
"verified_at",
"created_at",
"receiving_enabled",
"receiving_status"
],
"properties": {
"id": {
Expand All @@ -18519,33 +18648,33 @@
"example": "verified",
"description": "pending, verifying, verified or failed"
},
"dkimStatus": {
"dkim_status": {
"type": "string",
"example": "verified"
},
"spfStatus": {
"spf_status": {
"type": "string",
"example": "verified"
},
"dmarcStatus": {
"dmarc_status": {
"type": "string",
"example": "pending"
},
"verifiedAt": {
"verified_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"created_at": {
"type": "string",
"format": "date-time"
},
"receivingEnabled": {
"receiving_enabled": {
"type": "boolean"
},
"receivingStatus": {
"receiving_status": {
"type": "string",
"example": "disabled",
"description": "disabled, pending, active or failed"
Expand Down
Loading
Loading