| id |
int |
The ID of the activity, generated when the activity was created |
[optional] |
| note |
string |
The note of the activity (HTML format) |
[optional] |
| done |
bool |
Whether the activity is done or not |
[optional] |
| subject |
string |
The subject of the activity |
[optional] |
| type |
string |
The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes. |
[optional] |
| user_id |
int |
The ID of the user whom the activity is assigned to |
[optional] |
| participants |
object[] |
List of multiple persons (participants) this activity is associated with |
[optional] |
| busy_flag |
bool |
Marks if the activity is set 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. 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. |
[optional] |
| company_id |
int |
The user's company ID |
[optional] |
| reference_type |
string |
If the activity references some other object, it is indicated here. For example, value `Salesphone` refers to activities created with Caller. |
[optional] |
| reference_id |
int |
Together with the `reference_type`, gives the ID of the other object |
[optional] |
| conference_meeting_client |
string |
The ID of the Marketplace app, which is connected to this activity |
[optional] |
| conference_meeting_url |
string |
The link to join the meeting which is associated with this activity |
[optional] |
| conference_meeting_id |
string |
The meeting ID of the meeting provider (Zoom, MS Teams etc.) that is associated with this activity |
[optional] |
| add_time |
string |
The creation date and time of the activity in UTC. Format: YYYY-MM-DD HH:MM:SS. |
[optional] |
| marked_as_done_time |
string |
The date and time this activity was marked as done. Format: YYYY-MM-DD HH:MM:SS. |
[optional] |
| last_notification_time |
string |
The date and time of latest notifications sent about this activity to the participants or the attendees of this activity |
[optional] |
| last_notification_user_id |
int |
The ID of the user who triggered the sending of the latest notifications about this activity to the participants or the attendees of this activity |
[optional] |
| notification_language_id |
int |
The ID of the language the notifications are sent in |
[optional] |
| active_flag |
bool |
Whether the activity is active or not |
[optional] |
| update_time |
string |
The last update date and time of the activity. Format: YYYY-MM-DD HH:MM:SS. |
[optional] |
| update_user_id |
int |
The ID of the user who was the last to update this activity |
[optional] |
| gcal_event_id |
string |
For the activity which syncs to Google calendar, this is the Google event ID. NB! This field is related to old Google calendar sync and will be deprecated soon. |
[optional] |
| google_calendar_id |
string |
The Google calendar ID that this activity syncs to. NB! This field is related to old Google calendar sync and will be deprecated soon. |
[optional] |
| google_calendar_etag |
string |
The Google calendar API etag (version) that is used for syncing this activity. NB! This field is related to old Google calendar sync and will be deprecated soon. |
[optional] |
| calendar_sync_include_context |
string |
For activities that sync to an external calendar, this setting indicates if the activity syncs with context (what are the deals, persons, organizations this activity is related to) |
[optional] |
| source_timezone |
string |
The timezone the activity was created in an external calendar |
[optional] |
| rec_rule |
string |
The rule for the recurrence of the activity. Is important for activities synced into Pipedrive from an external calendar. Example: "RRULE:FREQ=WEEKLY;BYDAY=WE" |
[optional] |
| rec_rule_extension |
string |
Additional rules for the recurrence of the activity, extend the `rec_rule`. Is important for activities synced into Pipedrive from an external calendar. |
[optional] |
| rec_master_activity_id |
int |
The ID of parent activity for a recurrent activity if the current activity is an exception to recurrence rules |
[optional] |
| series |
object[] |
The list of recurring activity instances. It is in a structure as follows: `[{due_date: "2020-06-24", due_time: "10:00:00"}]` |
[optional] |
| created_by_user_id |
int |
The ID of the user who created the activity |
[optional] |
| location_subpremise |
string |
A subfield of the location field. Indicates apartment/suite number. |
[optional] |
| location_street_number |
string |
A subfield of the location field. Indicates house number. |
[optional] |
| location_route |
string |
A subfield of the location field. Indicates street name. |
[optional] |
| location_sublocality |
string |
A subfield of the location field. Indicates district/sublocality. |
[optional] |
| location_locality |
string |
A subfield of the location field. Indicates city/town/village/locality. |
[optional] |
| location_admin_area_level_1 |
string |
A subfield of the location field. Indicates state/county. |
[optional] |
| location_admin_area_level_2 |
string |
A subfield of the location field. Indicates region. |
[optional] |
| location_country |
string |
A subfield of the location field. Indicates country. |
[optional] |
| location_postal_code |
string |
A subfield of the location field. Indicates ZIP/postal code. |
[optional] |
| location_formatted_address |
string |
A subfield of the location field. Indicates full/combined address. |
[optional] |
| org_name |
string |
The name of the organization this activity is associated with |
[optional] |
| person_name |
string |
The name of the person this activity is associated with |
[optional] |
| deal_title |
string |
The name of the deal this activity is associated with |
[optional] |
| owner_name |
string |
The name of the user this activity is owned by |
[optional] |
| person_dropbox_bcc |
string |
The BCC email address of the person |
[optional] |
| deal_dropbox_bcc |
string |
The BCC email address of the deal |
[optional] |
| assigned_to_user_id |
int |
The ID of the user to whom the activity is assigned to. Equal to `user_id`. |
[optional] |
| file |
object |
The file that is attached to this activity. For example, this can be a reference to an audio note file generated with Pipedrive mobile app. |
[optional] |