Registered E-mail - Escrybe API

Registered e-mails are dispatched through a certified provider and tracked for delivery and open events.

Endpoints

Method	Path	Description
`POST`	`/api/email/v1/post`	Send a registered e-mail
`GET`	`/api/email/v1/get/{securityToken}/{job_id}`	Get status

Full request/response schemas live in the API Reference tab.

To bill a team owner (paymentMethod=team), team_member_id is the id of your membership in the team, not the team id. Get it from GET /api/v2/teams/{securityToken} or in the panel under Times — see Billing a team.

Sending

POST /api/email/v1/post requires at least name, email and subject, plus either msg (HTML body) or an attachment.

curl -X POST "https://app.escrybe.com.br/api/email/v1/post" \
  -F "userSecurityToken=YOUR_TOKEN" \
  -F "name=Maria Silva" \
  -F "email=maria@example.com" \
  -F "subject=Your contract" \
  -F "msg=<p>Hello Maria, please find your contract attached.</p>" \
  -F "attachment=@/path/to/contract.pdf"

Attachments are capped at 10 MB; common document and image types are accepted; password-protected PDFs are rejected.
Disposable e-mail domains are rejected.
reply_to falls back to your profile’s default reply-to address, then to your account e-mail.
A JSON body (application/json) is also accepted for sends without an attachment.

Tracking

GET /api/email/v1/get/{securityToken}/{job_id} returns delivery state (e-mail order ids start with E, e.g. E2607031):

Field	Meaning
`status`	0 Processing payment · 1 Production · 2 Insufficient credits · 3 Sent · 4 Cancelled · 5 Failed
`delivered`	1 once delivered
`opened`	1 once opened
`deferred`	1 when the recipient’s mail server deferred the message — the order is marked failed and credits are refunded
`date_sent` / `date_delivered` / `date_opened`	UTC timestamps