CLclose
activities.emails

Update an Email activity

Changed on

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

When changing a draft's status to scheduled or outbox, the sender field is required if not already set on the email.

put/activity/email/{id}/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/activity/email/{id}/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Path parameters

idstring required

Request body

activity_atstring date-time nullable
bccstring[] nullable
body_htmlstring nullable
body_textstring nullable
ccstring[] nullable
contact_idstring nullable
email_account_idstring nullable
followup_datestring date-time nullable
followup_sequence_add_cc_bccboolean nullable
followup_sequence_delayinteger nullable
followup_sequence_idstring nullable
in_reply_to_idstring nullable
senderstring email nullable
status'inbox' | 'draft' | 'scheduled' | 'outbox' | 'sent' | 'error'
subjectstring nullable
template_idstring nullable
tostring[] nullable
user_idstring nullable

Response

Successful response

_typestring required
activity_atstring date-time nullable required
agent_action_reasonstring nullable
agent_config_idstring nullable

Deprecated. Use created_by_agent_id instead.

bccstring[] required
body_htmlstring nullable required
body_previewstring nullable
body_textstring nullable required
bulk_email_action_idstring nullable required
ccstring[] required
contact_idstring nullable required
created_bystring nullable required
created_by_agent_idstring nullable
created_by_namestring nullable
date_createdstring date-time required
date_scheduledstring date-time nullable required
date_sentstring date-time nullable required
date_updatedstring date-time required
direction'incoming' | 'outgoing' required

Direction of communication. Outgoing means the communication flowing from the user to the lead/contact. Inbound means the opposite.

email_account_idstring nullable
envelopeobject nullable
followup_sequence_add_cc_bccboolean required
followup_sequence_delayinteger nullable required
followup_sequence_idstring nullable
has_replyboolean required
idstring required
in_reply_to_idstring nullable required
lead_idstring nullable required
message_idsstring[] required
need_smtp_credentialsboolean required
opens_summarystring nullable required
organization_idstring required
referencesstring[] required
send_as_idstring nullable required
senderstring nullable required
sequence_idstring nullable
sequence_namestring nullable
sequence_subscription_idstring nullable
status'inbox' | 'draft' | 'scheduled' | 'outbox' | 'sent' | 'error' required

Status of a message, such as Email or SMS.

subjectstring nullable required
template_idstring nullable required
template_namestring nullable
thread_idstring nullable required
tostring[] required
updated_bystring nullable required
updated_by_namestring nullable
user_idstring nullable required
user_namestring nullable
usersstring[] required

Changes

  • 784846be4a00Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • 2ff98656cc2aRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status