Email SupportCall Us Go to Close

Email


List or filter all Email activities.

GET /activity/email/{?lead_id, user_id, date_created__gt, date_created__lt}

You'll get one object per email message.

Create an Email activity.

POST /activity/email/

status must be one of the following:

  • inbox to log an already received email.
  • draft to create a draft email.
  • scheduled to send an email at a scheduled date and time, which must be specified in the date_scheduled field.
  • outbox to actually send an email. To delay email sending by a few seconds (to allow undo), specify send_in in seconds (must be less than 60).
  • sent to log an already sent email.

Only drafts can be modified, and their status can be changed to scheduled (to send later) or outbox (to send immediately). Scheduled emails, or emails in outbox that weren't sent yet can be canceled by setting the status back to draft.

For scheduled, outbox, or sent emails, a followup_date may be posted, which will have Close create an email followup task if no response was received.

We'll render an Email Template server-side if you include a template_id without including body_text or body_html in your POST.

To specify both a sender name and a sender email address when posting an email, you can use the sender field with the format "sender": "\"John Smith\" <emailaddress@example.com>"

If you don't provide a sender when posting an email with status sent, it will default to the email address of the user associated with the email or the email address of the owner of the API key you use.

Fetch a single Email activity.

GET /activity/email/{id}/

Update an Email activity.

PUT /activity/email/{id}/

This can be used to modify a draft or send it once the draft is complete.

Delete an Email activity.

DELETE /activity/email/{id}/