مرجع API

پیش‌نویس‌ها و پیوست‌ها

جریان‌های نوشتن ایمیل را با ذخیره‌سازی خصوصی پیوست‌ها بسازید.

POST/drafts
کلید API

ایجاد پیش‌نویس ایمیل

ایجاد پیش‌نویس ایمیل

درخواست
curl https://sendhq.cc/api/v1/drafts \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"hello@example.com","to":["customer@example.net"],"subject":"Hello"}'
پاسخ 201
{
  "id": "dr_…",
  "attachments": []
}
GET/drafts
کلید API

فهرست پیش‌نویس‌های ایمیل

فهرست پیش‌نویس‌های ایمیل

درخواست
curl https://sendhq.cc/api/v1/drafts \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
پاسخ 200
{
  "data": [],
  "count": 0
}
GET/drafts/:id
کلید API

بازیابی یک پیش‌نویس و پیوست‌های آن

بازیابی یک پیش‌نویس و پیوست‌های آن

درخواست
curl https://sendhq.cc/api/v1/drafts/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
پاسخ 200
{
  "id": "dr_…",
  "attachments": []
}
PUT/drafts/:id
کلید API

جایگزینی محتوای پیش‌نویس

جایگزینی محتوای پیش‌نویس

درخواست
curl https://sendhq.cc/api/v1/drafts/id_value \
  -X PUT \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"hello@example.com","to":["customer@example.net"],"subject":"Updated subject","text":"Updated body"}'
پاسخ 200
{
  "id": "dr_…"
}
DELETE/drafts/:id
کلید API

حذف پیش‌نویس

حذف پیش‌نویس

درخواست
curl https://sendhq.cc/api/v1/drafts/id_value \
  -X DELETE \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
پاسخ 200
{
  "ok": true
}
POST/drafts/:id/attachments
کلید API

بارگذاری پیوست روی پیش‌نویس

بایت‌های خام فایل را بارگذاری کنید. Content-Type و X-Filename را تنظیم کنید. هر پیام حداکثر می‌تواند 10 فایل و در مجموع 10 MB داشته باشد.

هدرهای اختیاریX-Filename
درخواست
curl https://sendhq.cc/api/v1/drafts/id_value/attachments \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/pdf" \
  -H "X-Filename: invoice.pdf" \
  --data-binary @invoice.pdf
پاسخ 201
{
  "id": "att_…",
  "filename": "invoice.pdf",
  "sizeBytes": 48231,
  "available": true
}
GET/attachments/:id
کلید API

دانلود پیوست خصوصی

دانلود پیوست خصوصی

درخواست
curl https://sendhq.cc/api/v1/attachments/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
DELETE/attachments/:id
کلید API

حذف پیوست خصوصی

حذف پیوست خصوصی

درخواست
curl https://sendhq.cc/api/v1/attachments/id_value \
  -X DELETE \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
پاسخ 200
{
  "ok": true
}
GET/sending-identities
کلید API

فهرست هویت‌های فرستنده تأییدشده

فهرست هویت‌های فرستنده تأییدشده

درخواست
curl https://sendhq.cc/api/v1/sending-identities \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
پاسخ 200
{
  "domains": [],
  "addresses": [],
  "localParts": []
}