Reminders

Update Reminder

put/api/v1.0/reminders/{id}

Path parameters

idstring required

The ID for the reminder

addressstring

The address where the Reminder was generated at (this is automatically generated if latitude/longitude are specified)

cancelled_atnumber

The date/time the Reminder was marked cancelled represented as an integer

completed_atnumber

The date/time the Reminder was marked completed represented as an integer

created_atnumber

The date/time the Reminder was created at represented as an integer

created_by_idinteger

The ID of the User that created the Reminder

custom_typestring

The ID of the custom type of the Reminder, matching one from Campaign.reminder_types

descriptionstring

The text of the Reminder

external_idstring

An optional external identifier to uniquely identify the Reminder in integration systems

idstring

The ID of the Reminder

lead_idinteger

An associated Lead for the Reminder

latitudenumber

The latitude coordinate the Reminder was created at

longitudenumber

The longitude coordinate the Reminder was created at

starts_atstring date-time

The date/time that the Reminder is for

status'active' | 'completed' | 'cancelled' | 'overdue'

The current state of the Reminder

user_idinteger

DEPRECATED, The ID of the User that the Reminder is for

user_idsinteger[]

The IDs of the Users that the Reminder is for

Success