مرجع 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": []
}