{ "data": [ { "Subject": "Meeting1", "Who_Id": { "name": "Patricia Boyle", "id": "3652397000000649013" }, "What_Id": { "name": "Zylker", "id": "3652397000000624046" }, "Status": "In Progress", "Due_Date": "2020-05-02", "Priority": "High", "$se_module": "Accounts", "Remind_At": { "ALARM": "FREQ=WEEKLY;UNTIL=2020-05-21T11:00:00+05:30ACTION=POPUP;TRIGGER=DATE-TIME:2020-05-01T11:00:00+05:30" }, "Recurring_Activity": { "RRULE": "FREQ=WEEKLY;INTERVAL=1;UNTIL=2020-05-16;BYDAY=SA;DTSTART=2020-05-02" } } ] } |
Key | Data Type | Description |
Subject | String | Subject of the task. This key is mandatory. |
Who_Id | JSON Object | ID of the contact or lead the task is related to. |
What_Id | JSON Object | ID of the account the contact is associated with. Specify this only when the Who_Id is a contact. |
Status | String | The status of the task. The possible values are "Not Started", "Deferred", "In Progress", "Completed", and "Waiting on someone else". |
Due_Date | Date in yyyy-mm-dd format | The date on which the task is due. |
Priority | String | The priority of the task. The possible values are "High", "Highest", "Low", "Lowest", and "Normal". |
$se_module | String | The API name of the parent module that the contact is associated with. This key is mandatory when you include Who_id and What_Id. |
Key | Data Type | Description |
FREQ | String | Defines the frequency of the reminder. The possible values are DAILY, WEEKLY, MONTHLY, YEARLY, NONE. If you specify, NONE, the system sets a one-time reminder and TRIGGER becomes mandatory. |
Action | String | Represents how you want to remind the task owner about the task. The possible values are EMAIL, POPUP, EMAILANDPOPUP. |
TRIGGER=DATE-TIME | DateTime (ISO8601) | Defines when you want to trigger the reminder. This key is mandatory. Example: 2020-05-01T12:28:00+05:30. |
TRIGGER=TIME | hh:mm | 24-hour time format at which the system must trigger the reminder. Example: 23:45 |
{ "data": [ { "Subject": "Meeting1", "Remind_At": { "ALARM": "FREQ=NONE;ACTION=POPUP;TRIGGER=-P1D;TRIGGER_TIME=11:00" } } ] } |
Error code | Reason | Handling |
INVALID_DATA | The ID you specified in what_id or who_id is invalid. | Specify the correct ID. |
MANDATORY_NOT_FOUND | You have not specified TRIGGER in "Remind_At" or UNTIL and DTSTART in RRULE keys. | Specify the mandatory keys. |
INVALID_RRULE | You have specified an incorrect value for FREQ, INTERVAL, or BYMONTHDAY, BYDAY, BYMONTH, BYSETPOS. | Specify the correct value for RRULE. |
Writer is a powerful online word processor, designed for collaborative work.