Skip to main content
POST
/
client
/
send
Send transactional email now
curl --request POST \
  --url http://localhost:8080/api/v1/client/send \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_first_name": "<string>",
  "contact_last_name": "<string>",
  "from": {
    "email": "<string>",
    "name": "<string>"
  },
  "template_id": 123,
  "template_name": "<string>",
  "to": {
    "email": "<string>",
    "name": "<string>"
  },
  "vars": {}
}
'
{
  "data": {
    "browser_url": "<string>",
    "sent_email_id": "<string>",
    "status_text": "<string>",
    "status_updated_at": "<string>"
  },
  "errors": [
    {
      "condition": "format",
      "error": "Invalid email format",
      "key": "email"
    }
  ],
  "message": "Operation successful",
  "meta": {},
  "success": true
}

Authorizations

Authorization
string
header
required

JWT Bearer token or raw API key via Authorization header

Body

application/json

Send email payload

contact_first_name
string
contact_last_name
string
from
object
template_id
integer
template_name
string
to
object
vars
object

Response

OK

data
object
errors
object[]
message
string
Example:

"Operation successful"

meta
object
success
boolean
Example:

true