due_date |
Date |
The due date of the activity. Format: YYYY-MM-DD |
[optional] |
due_time |
String |
The due time of the activity in UTC. Format: HH:MM |
[optional] |
duration |
String |
The duration of the activity. Format: HH:MM |
[optional] |
deal_id |
Number |
The ID of the deal this activity is associated with |
[optional] |
lead_id |
String |
The ID of the lead in the UUID format this activity is associated with |
[optional] |
person_id |
Number |
The ID of the person this activity is associated with |
[optional] |
project_id |
Number |
The ID of the project this activity is associated with |
[optional] |
org_id |
Number |
The ID of the organization this activity is associated with |
[optional] |
location |
String |
The address of the activity. |
[optional] |
public_description |
String |
Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity. |
[optional] |
note |
String |
The note of the activity (HTML format) |
[optional] |
subject |
String |
The subject of the activity. When value for subject is not set, it will be given a default value `Call`. |
[optional] |
type |
String |
The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes. When value for type is not set, it will be given a default value `Call`. |
[optional] |
user_id |
Number |
The ID of the user whom the activity is assigned to. If omitted, the activity is assigned to the authorized user. |
[optional] |
participants |
[Object] |
List of multiple persons (participants) this activity is associated with. If omitted, single participant from `person_id` field is used. It requires a structure as follows: `[{"person_id":1,"primary_flag":true}]` |
[optional] |
busy_flag |
Boolean |
Set the activity as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset by never setting it or overriding it with `null`. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time. |
[optional] |
attendees |
[Object] |
The attendees of the activity. This can be either your existing Pipedrive contacts or an external email address. It requires a structure as follows: `[{"email_address":"mail@example.org"}]` or `[{"person_id":1, "email_address":"mail@example.org"}]` |
[optional] |
done |
NumberBoolean |
Whether the activity is done or not. 0 = Not done, 1 = Done |
[optional] |