مرجع API
ایمیلها و رشتههای گفتگو
ارسال، دریافت، جستجو، پاسخ و بررسی رویدادهای تحویل.
هیچ عملیاتی با این فیلتر مطابقت ندارد.
/emailsارسال یک ایمیل
محتوای تراکنشی HTML، متنی یا مبتنی بر قالب میزبانیشده را از یک دامنه تأییدشده فضای کاری ارسال کنید. در ارسال مستقیم، اگر برای دامنه فرستنده تأییدشده فعال باشد، میتوان message_class را روی marketing تنظیم کرد. در حالت marketing هدرهای مدیریتشده لغو اشتراک اضافه میشوند، مگر اینکه یک یکپارچهسازی first-party پیکربندیشده URL لغو اشتراک یککلیکی HTTPS قابلمشاهده خودش را ارائه دهد.
curl https://sendhq.cc/api/v1/emails \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"from":"Acme <hello@example.com>","to":["customer@example.net"],"subject":"Welcome aboard","html":"<h1>Welcome</h1><p>Your workspace is ready.</p>","text":"Welcome. Your workspace is ready."}'{
"id": "em_…",
"providerMessageId": "provider-id",
"threadId": "em_…"
}/emails/batchارسال حداکثر 100 پیام شخصیسازیشده
ارسال حداکثر 100 پیام شخصیسازیشده
curl https://sendhq.cc/api/v1/emails/batch \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"emails":[{"from":"Acme <hello@example.com>","to":["customer@example.net"],"subject":"Welcome aboard","html":"<h1>Welcome</h1><p>Your workspace is ready.</p>","text":"Welcome. Your workspace is ready."}]}'{
"data": [
{
"index": 0,
"ok": true,
"id": "em_…"
}
],
"count": 1,
"successful": 1,
"failed": 0
}/emailsفهرست ایمیلهای ارسالی و دریافتی
Newest-first list with filters. `query` searches subjects, bodies, participants, and attachment filenames. `label`, `domain`, and `category` accept one value or a comma-separated list (matches any); labels may be IDs or names. `outcome` filters sent mail to `bounced`, `complained`, `failed`, or `rejected` (comma-separated, matches any). `archived=false` returns the Inbox view for received mail. Received mail is classified as `primary`, `updates` (newsletters, bulk, and automated mail), or `spam`, and flagged `important`; spam is excluded unless `category=spam` or `include_spam=true`.
curl https://sendhq.cc/api/v1/emails \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"data": [],
"count": 0
}/emails/:idدریافت یک ایمیل و پیوستهای آن
دریافت یک ایمیل و پیوستهای آن
curl https://sendhq.cc/api/v1/emails/id_value \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"id": "em_…",
"direction": "out",
"status": "sent",
"attachments": []
}/emails/:idبهروزرسانی وضعیت خواندهشدن، بایگانی، اسپم، دسته یا اهمیت
`read`، `archived`، `category` (`primary`، `updates` یا `spam` — فقط برای ایمیلهای دریافتی) و `important` را تنظیم کنید. تغییر `category` یا `important` به SendHQ درباره فرستنده آموزش میدهد: گزارش اسپم باعث میشود ایمیلهای بعدی آن فرستنده به اسپم بروند، `Not spam` بررسیهای خودکار اسپم را برای او نادیده میگیرد و اهمیت برای آن فرستنده حفظ میشود. برای تغییر فقط همین پیام، `learn: false` را ارسال کنید.
curl https://sendhq.cc/api/v1/emails/id_value \
-X PATCH \
-H "Authorization: Bearer $SENDHQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"category":"spam"}'{
"id": "em_…",
"readAt": "2026-08-23T12:00:00.000Z",
"archivedAt": null,
"category": "spam",
"important": false,
"classification": "you moved it here"
}/emails/:idحذف یک ایمیل نگهداریشده
حذف یک ایمیل نگهداریشده
curl https://sendhq.cc/api/v1/emails/id_value \
-X DELETE \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"ok": true
}/emails/:id/eventsفهرست رویدادهای تحویل یک ایمیل
فهرست رویدادهای تحویل یک ایمیل
curl https://sendhq.cc/api/v1/emails/id_value/events \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"data": [],
"count": 0
}/threads/:idدریافت یک مکالمه به ترتیب زمانی
دریافت یک مکالمه به ترتیب زمانی
curl https://sendhq.cc/api/v1/threads/id_value \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"id": "em_…",
"data": [],
"count": 0
}/emails/:id/deliveryDelivery timeline for one email, with bounce and complaint reasons
Delivery timeline for one email, with bounce and complaint reasons
curl https://sendhq.cc/api/v1/emails/id_value/delivery \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"emailId": "em_123",
"status": "bounced",
"timeline": [],
"count": 0,
"limit": 50,
"offset": 0
}/threads/:id/deliveryPer-thread delivery counts and per-message failure reasons
Per-thread delivery counts and per-message failure reasons
curl https://sendhq.cc/api/v1/threads/id_value/delivery \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"threadId": "thr_123",
"delivered": 0,
"bounced": 0,
"complained": 0,
"failed": 0,
"messages": []
}