Skip to main content
POST
/
api
/
email
/
send
curl --request POST \
  --url https://core-api.getaptly.com/api/email/send \
  --header 'Content-Type: application/json' \
  --header 'x-token: <api-key>' \
  --data '
{
  "discussionId": "stream_abc",
  "uuid": "draft_xyz"
}
'
{}

Authorizations

​
x-token
string
header
required

Body

application/json
​
discussionId
string

Stream ID from POST /api/email/create-draft. Required if uuid is set.

​
uuid
string

Draft UUID from POST /api/email/create-draft. Required if discussionId is set.

​
failOnCreateNewThread
boolean
default:true

If true (default), the send fails when the email would create a new discussion thread rather than reply to an existing one.

​
userId
string

Required when sending on-the-fly (no discussionId/uuid).

​
channelId
string

Required when sending on-the-fly.

​
to
object[]
​
cc
object[]
​
bcc
object[]
​
subject
string
​
body
string
​
aptletInstanceId
string

Card to link the outbound to. Logs the email as an activity on the card and tags the discussion. Works whether the draft was pre-created or is created on-the-fly.

Response

Email sent successfully.

The response is of type object.