Skip to main content
POST
Send a registered e-mail

Body

userSecurityToken
string
required

Your account security token.

name
string
required

Recipient name.

email
string<email>
required
subject
string
required
msg
string

HTML body. Required if no attachment.

attachment
file

Max 10 MB. Common document/image types allowed (PDF, Office, images, text, ZIP). Password-protected PDFs are rejected. Requires multipart/form-data.

name_sender
string

Falls back to your profile.

reply_to
string<email>

Falls back to your profile's default reply-to address, then to your account e-mail. Invalid addresses are rejected with 400.

tag
string

Optional label to organize your orders. Stored normalized: lowercase, accents removed, anything other than a-z, 0-9 becomes a hyphen ("Cobrança Março" → "cobranca-marco"). Filter the order lists by this value.

test
string
default:0

Validation mode. Accepts 1/true/yes/on to validate without creating the order (the calculated price is returned) and 0/false/no/off to submit for real. ANY other value is rejected with 400 — it used to fall through to a real, billable order.

paymentMethod
enum<string>
default:escrybe_credits

invoice requires a plan that allows invoicing.

Available options:
escrybe_credits,
invoice,
team
team_member_id
integer

Required when paymentMethod=team. It is NOT the team id: it is the id of YOUR membership in that team (team_members.id), which differs for each member. Get it from GET /api/v2/teams or from the panel (Times → "ID para a API"). The team owner has one too. A value that is not one of your memberships answers 403.

Response

E-mail accepted

Same standard envelope as the letters endpoints.

status
integer
Example:

200

status_message
string
data
object