Update an Email activity

PUT

https://api.close.com/api/v1/activity/email/:id/

PUT

/api/v1/activity/email/:id/

$ curl -X PUT https://api.close.com/api/v1/activity/email/id/ \
>      -H "Content-Type: application/json" \
>      -u "<CLOSE_API_KEY>:" \
>      -d '{
>   "subject": "Updated subject!"
> }'

1 {
2   "_type": "Email",
3   "activity_at": "2015-06-26T02:01:43.059265",
4   "bcc": [],
5   "body_html": "Hi! My name is Karan and I'm your Account Manager. I'm here to get your team set up and help with anything you may need as you evaluate our platform. Please don't hesitate to reach out to me with any questions!",
6   "body_text": "Hi! My name is Karan and I'm your Account Manager. I'm here to get your team set up and help with anything you may need as you evaluate our platform. Please don't hesitate to reach out to me with any questions!",
7   "bulk_email_action_id": null,
8   "cc": [],
9   "contact_id": "cont_8NNOJnVwmHQEYuVOgJ4B4zU7g9RUxYH4JnPjza5Vr6t",
10   "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
11   "date_created": "2015-06-26T02:01:43.059265",
12   "date_scheduled": null,
13   "date_sent": null,
14   "date_updated": "2015-06-26T02:01:43.101910",
15   "direction": "outgoing",
16   "followup_sequence_add_cc_bcc": false,
17   "followup_sequence_delay": null,
18   "has_reply": false,
19   "id": "acti_EdpqkmtlQHIDWE2CixJo606BapX34SpYV3fzHryGPc3",
20   "in_reply_to_id": null,
21   "lead_id": "lead_KwD00BYbXCHiPWj68LxFkxaeWuULpZ7awzm6LqeFs0h",
22   "message_ids": [],
23   "need_smtp_credentials": false,
24   "opens_summary": null,
25   "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
26   "references": [],
27   "send_as_id": null,
28   "sender": "karan@close.com",
29   "status": "draft",
30   "subject": "Updated subject!",
31   "template_id": null,
32   "thread_id": "acti_3VFfJMUKvwvQPXAbXAbs9b01usbFC5acL8MrmFcsmK5",
33   "to": [
34     "phil+sample@gclose.com"
35   ],
36   "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
37   "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
38   "users": [],
39   "attachments": [],
40   "body_preview": "Hi! My name is Karan and I'm your Account Manager. I'm here to get your team set up and help with anything you may need as you evaluate our platform. Please don't hesitate to reach out to me with any ",
41   "created_by_name": "Steve Wiseman",
42   "email_account_id": null,
43   "envelope": {},
44   "opens": [],
45   "send_attempts": [],
46   "sequence_id": null,
47   "sequence_name": null,
48   "sequence_subscription_id": null,
49   "template_name": null,
50   "updated_by_name": "Steve Wiseman",
51   "user_name": "Steve Wiseman",
52   "body_html_quoted": {
53     "expand": true,
54     "html": "Hi! My name is Karan and I'm your Account Manager. I'm here to get your team set up and help with anything you may need as you evaluate our platform. Please don't hesitate to reach out to me with any questions!"
55   },
56   "body_text_quoted": null
57 }

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.

Update an Email activity

PUT

https://api.close.com/api/v1/activity/email/:id/

PUT

/api/v1/activity/email/:id/

$ curl -X PUT https://api.close.com/api/v1/activity/email/id/ \
>      -H "Content-Type: application/json" \
>      -u "<CLOSE_API_KEY>:" \
>      -d '{
>   "subject": "Updated subject!"
> }'

1 {
2   "_type": "Email",
3   "activity_at": "2015-06-26T02:01:43.059265",
4   "bcc": [],
5   "body_html": "Hi! My name is Karan and I'm your Account Manager. I'm here to get your team set up and help with anything you may need as you evaluate our platform. Please don't hesitate to reach out to me with any questions!",
6   "body_text": "Hi! My name is Karan and I'm your Account Manager. I'm here to get your team set up and help with anything you may need as you evaluate our platform. Please don't hesitate to reach out to me with any questions!",
7   "bulk_email_action_id": null,
8   "cc": [],
9   "contact_id": "cont_8NNOJnVwmHQEYuVOgJ4B4zU7g9RUxYH4JnPjza5Vr6t",
10   "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
11   "date_created": "2015-06-26T02:01:43.059265",
12   "date_scheduled": null,
13   "date_sent": null,
14   "date_updated": "2015-06-26T02:01:43.101910",
15   "direction": "outgoing",
16   "followup_sequence_add_cc_bcc": false,
17   "followup_sequence_delay": null,
18   "has_reply": false,
19   "id": "acti_EdpqkmtlQHIDWE2CixJo606BapX34SpYV3fzHryGPc3",
20   "in_reply_to_id": null,
21   "lead_id": "lead_KwD00BYbXCHiPWj68LxFkxaeWuULpZ7awzm6LqeFs0h",
22   "message_ids": [],
23   "need_smtp_credentials": false,
24   "opens_summary": null,
25   "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
26   "references": [],
27   "send_as_id": null,
28   "sender": "karan@close.com",
29   "status": "draft",
30   "subject": "Updated subject!",
31   "template_id": null,
32   "thread_id": "acti_3VFfJMUKvwvQPXAbXAbs9b01usbFC5acL8MrmFcsmK5",
33   "to": [
34     "phil+sample@gclose.com"
35   ],
36   "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
37   "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
38   "users": [],
39   "attachments": [],
40   "body_preview": "Hi! My name is Karan and I'm your Account Manager. I'm here to get your team set up and help with anything you may need as you evaluate our platform. Please don't hesitate to reach out to me with any ",
41   "created_by_name": "Steve Wiseman",
42   "email_account_id": null,
43   "envelope": {},
44   "opens": [],
45   "send_attempts": [],
46   "sequence_id": null,
47   "sequence_name": null,
48   "sequence_subscription_id": null,
49   "template_name": null,
50   "updated_by_name": "Steve Wiseman",
51   "user_name": "Steve Wiseman",
52   "body_html_quoted": {
53     "expand": true,
54     "html": "Hi! My name is Karan and I'm your Account Manager. I'm here to get your team set up and help with anything you may need as you evaluate our platform. Please don't hesitate to reach out to me with any questions!"
55   },
56   "body_text_quoted": null
57 }

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.

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Request

This endpoint expects an object.

activity_atdatetime or nullOptional

attachmentslist of objects or nullOptional

bcclist of strings or nullOptional

body_htmlstring or nullOptional<=1048576 characters

body_textstring or nullOptional<=1048576 characters

cclist of strings or nullOptional

contact_idstring or nullOptional

email_account_idstring or nullOptional

followup_datedatetime or nullOptional

followup_sequence_add_cc_bccboolean or nullOptional

followup_sequence_delayinteger or nullOptional>=86400

followup_sequence_idstring or nullOptional

in_reply_to_idstring or nullOptional

openslist of objects or nullOptional

senderstring or nullOptionalformat: "email"

statusenumOptional

subjectstring or nullOptional<=1000 characters

template_idstring or nullOptional

tolist of strings or nullOptional

user_idstring or nullOptional

Response

Successful response

_typestring

activity_atdatetime or null

bcclist of strings

body_htmlstring or null

body_textstring or null

bulk_email_action_idstring or null

cclist of strings

contact_idstring or null

created_bystring or null

date_createddatetime

date_scheduleddatetime or null

date_sentdatetime or null

date_updateddatetime

directionenum or null

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

Allowed values:

followup_sequence_add_cc_bccboolean

followup_sequence_delayinteger or null

has_replyboolean

idstring

in_reply_to_idstring or null

lead_idstring or null

message_idslist of strings

need_smtp_credentialsboolean

opens_summarystring or null

organization_idstring

referenceslist of strings

send_as_idstring or null

senderstring or null

statusenum

Status of a message, such as Email or SMS.

subjectstring or null

template_idstring or null

thread_idstring or null

tolist of strings

updated_bystring or null

user_idstring or null

userslist of strings

agent_action_reasonstring or null

agent_config_idstring or null

attachmentslist of objects or null

body_previewstring or null

created_by_namestring or null

email_account_idstring or null

envelopemap from strings to any or null

followup_sequence_idstring or null

openslist of maps from strings to strings or null

send_attemptslist of maps from strings to strings or null

sequence_idstring or null

sequence_namestring or null

sequence_subscription_idstring or null

template_namestring or null

updated_by_namestring or null

user_namestring or null

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error