Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 11 additions & 11 deletions specs/sandbox-sending.openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ tags:
x-page-description: Send emails to sandbox
description: Test Emails
paths:
'/api/send/{inbox_id}':
'/api/send/{sandbox_id}':
post:
description: Send email message to the specified inbox.
description: Send email message to the specified sandbox.
operationId: sendEmail
summary: Send email (including templates)
tags:
Expand All @@ -33,7 +33,7 @@ paths:
- lang: shell
label: 'cURL'
source: |
curl -X POST https://sandbox.api.mailtrap.io/api/send/{inbox_id} \
curl -X POST https://sandbox.api.mailtrap.io/api/send/{sandbox_id} \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
Expand Down Expand Up @@ -212,7 +212,7 @@ paths:
schema:
$ref: '#/components/schemas/SendEmailErrorResponse'
'429':
description: Billing plan limit exhausted or inbox rate limit exceeded (see the response for details).
description: Billing plan limit exhausted or sandbox rate limit exceeded (see the response for details).
content:
application/json:
schema:
Expand All @@ -224,8 +224,8 @@ paths:
schema:
$ref: '#/components/schemas/SendEmailErrorResponse'
parameters:
- $ref: '#/components/parameters/inbox_id'
'/api/batch/{inbox_id}':
- $ref: '#/components/parameters/sandbox_id'
'/api/batch/{sandbox_id}':
post:
description: |
Batch send email (text, html, text&html, templates). Please note that the endpoint will return a 200-level http status, even when sending for individual messages may fail. Users of this endpoint should check the success and errors for each message in the response (the results are ordered the same as the original messages - `requests`). Please note that the endpoint accepts up to 500 messages per API call, and up to 50 MB payload size, including attachments.
Expand All @@ -237,7 +237,7 @@ paths:
- lang: shell
label: 'cURL'
source: |
curl -X POST https://sandbox.api.mailtrap.io/api/batch/{inbox_id} \
curl -X POST https://sandbox.api.mailtrap.io/api/batch/{sandbox_id} \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
Expand Down Expand Up @@ -469,7 +469,7 @@ paths:
schema:
$ref: '#/components/schemas/SendEmailErrorResponse'
parameters:
- $ref: '#/components/parameters/inbox_id'
- $ref: '#/components/parameters/sandbox_id'
components:
schemas:
EmailWithText:
Expand Down Expand Up @@ -963,9 +963,9 @@ components:
scheme: bearer
bearerFormat: JWT
parameters:
inbox_id:
description: Unique inbox ID
name: inbox_id
sandbox_id:
description: Sandbox ID
name: sandbox_id
in: path
required: true
schema:
Expand Down
Loading
Loading