Referensi API

REST API email transaksional

API menerima permintaan yang terautentikasi, memverifikasi scope proyek dan status domain, memeriksa suppression, lalu mengantrekan pesan yang diterima.

Diperbarui 24 Juli 2026Unduh OpenAPI 3.1

Autentikasi

POST /v1/emails

Permintaan / Respons

curl --request POST 'https://api.srs-postline.com/v1/emails' \
  --header 'Authorization: Bearer srs_live_...' \
  --header 'Idempotency-Key: order_4821' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "from": "Postline <info@example.com>",
    "to": ["user@example.net"],
    "subject": "Your order is ready",
    "html": "<p>Order #4821 is ready.</p>",
    "text": "Order #4821 is ready."
  }'

HTTP/1.1 202 Accepted
Content-Type: application/json

{
  "id": "msg_01JPOSTLINEEXAMPLE",
  "status": "queued",
  "created_at": "2026-08-22T12:00:00Z"
}

Parameter input

Parameter	Tipe	Wajib	Deskripsi	Contoh
`Authorization`	`header · string`	Ya	Kunci API scoped yang diterbitkan dasbor sebagai token Bearer.	`Bearer srs_live_…`
`Idempotency-Key`	`header · string`	Tidak	Pengenal stabil untuk satu pengiriman logis; sangat disarankan.	`order_4821`
`from`	`string`	Ya	Nama dan alamat pengirim pada domain terverifikasi.	`Postline <info@example.com>`
`to`	`string[]`	Ya	Satu hingga 100 alamat email penerima.	`["user@example.net"]`
`subject`	`string`	Ya	Subjek pesan.	`Pesanan Anda siap`
`html`	`string`	Tidak	Isi HTML. Salah satu dari html atau text wajib diisi.	`<p>…</p>`
`text`	`string`	Tidak	Isi teks biasa. Salah satu dari text atau html wajib diisi.	`Pesanan #4821…`

Kode respons

Status	HTTP	Deskripsi
`202`	Accepted	Pesan masuk antrean; ini belum berarti pesan terkirim ke kotak masuk.
`400`	Bad Request	JSON tidak valid atau bidang tidak didukung.
`401`	Unauthorized	Kunci API tidak valid, kedaluwarsa, atau dicabut.
`403`	Forbidden	Scope tidak ada atau domain pengirim belum diverifikasi.
`422`	Unprocessable Entity	Penerima berada dalam daftar suppression.
`429`	Too Many Requests	Batas permintaan proyek terlampaui.

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
  "error": "recipient suppressed"
}

Kirim email

POST /v1/emails
Authorization: Bearer srs_live_…
Idempotency-Key: reset-4821
Content-Type: application/json

Resource inti

POST/v1/emailsmengantrekan pesan

GET/v1/emails/{id}memeriksa status pesan

POST/v1/domainsmenambahkan domain pengirim

POST/v1/domains/{id}/verifymenjalankan pemeriksaan DNS

GET/POST/DELETE/v1/suppressionsmengelola penerima yang di-suppress

GET/POST/DELETE/v1/webhooksmengelola endpoint event

Model respons

202 berarti diantrekan, bukan masuk inbox. 403 dapat mengindikasikan scope yang hilang atau domain yang belum terverifikasi. 422 memblokir penerima yang di-suppress. 429 mengindikasikan rate limiting.

Model akses saat ini

Kunci saat ini memakai srs_live_. Sebelum domain From diverifikasi, pengirim sandbox bersama hanya dapat mengirim ke anggota proyek. Setelah itu kuota, suppression, batas penerima, dan kontrol abuse tetap berlaku. 202 berarti masuk antrean, bukan terkirim.

Sumber daya integrasi

Gunakan panduan langkah demi langkah untuk manusia dan agen AI; OpenAPI adalah sumber kebenaran field.