Emails
Emails live at /v2/emails. They support every request on the Records page: list, get, history, create, update, delete and search. An email record is a copy of an email, logged against the records it's about.
Logging an email
curl -X POST "https://api.tiny.plus/v2/emails" \
-H "Authorization: Bearer {{user_access_token}}" \
-H "Content-Type: application/json" \
-d '{
"subject": "Revised fee proposal",
"body_text_raw": "Hi Adam, please find the revised proposal attached...",
"body_html": "<p>Hi Adam, please find the revised proposal attached...</p>",
"sender_name": "Alex Example",
"sender_email": "alex@example.com",
"recipients_raw": "adam@adamson.com",
"cc_raw": "sam@example.com",
"email_id": "AAMkAGI2TG93AAA=",
"primary_related": "1241",
"related_selector": ["1343", "1231"]
}'{
"id": "161086"
}subjectbecomes the email'sname.body_text_rawis the plain-text body. The email'sdescriptionis set to its newest part: the reply, without the quoted thread below it.recipients_rawandcc_raware email addresses separated by commas. They're stored as sent, and not matched to contacts.primary_relatedis the record the email is mainly about, such as a contact. The people following that record are notified.related_selectorlinks the email to more records, and to team members. See Linking records.assigned_useris the token's user unless you send another.
Avoiding duplicates
email_id is your own unique id for the email, such as the id your mail system gives it. If an email with the same email_id has already been logged, a second one fails with 400:
To check first, filter on it:
tiny+ only checks for duplicates when the email_id is longer than five characters.
Fields
body_html
Text
The HTML body.
Yes
body_text_raw
Body Text
Text
The plain-text body. The email's description is set to its newest part.
Yes
cc_raw
CCed
Text
CC'd email addresses, separated by commas.
Yes
conversation_id
Conversation ID
Text
Your id for the email's thread. Stored as sent.
Yes
email_id
Email ID
Text
Your unique id for the email. A second email with the same one is refused: see Avoiding duplicates.
Yes
mail_to
To
Text
The To line, as text.
Yes
recipients_raw
Recipients
Text
Recipients' email addresses, separated by commas.
Yes
sender_email
Sender Email
Email address
The sender's email address.
Yes
sender_name
From
Text
The sender's name.
Yes
sender_raw
From
Text
The sender as one string, such as Alex Example <alex@example.com>. Used for sender_name and sender_email when those aren't sent.
Yes
subject
Subject
Text
The email's subject. It becomes the email's name.
Yes
Last updated
Was this helpful?