| Name | Type | Description | Notes |
|---|---|---|---|
| firstReminderDelay | Integer | Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours | [optional] |
| frequency | FrequencyEnum | The frequency at which reminder will be sent until the agreement is signed.<br>If frequency is not provided, the reminder will be sent once (if the agreement is available at the specified time) with the delay based on the firstReminderDelay field and will never repeat again. If the agreement is not available at that time, reminder will not be sent | [optional] |
| lastSentDate | Date | The date when the reminder was last sent. Only provided in GET. Cannot be provided in POST request. If provided in POST, it will be ignored. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] |
| nextSentDate | Date | The date when the reminder is scheduled to be sent next. Only provided in GET. Cannot be provided in POST request. If provided in POST, it will be ignored. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] |
| note | String | An optional message sent to the recipients, describing why their signatures are required | [optional] |
| recipientParticipantIds | List<String> | A list of one or more participant IDs to create the reminder on. The reminder will be sent to all the participants specified by the list of participant IDs. | [optional] |
| reminderId | String | An identifier of the reminder resource created on the server. Only provided in GET. Cannot be provided in POST request. If provided in POST, it will be ignored | [optional] |
| startReminderCounterFrom | StartReminderCounterFromEnum | Reminder can be sent based on when the agreement becomes available or when the reminder is created<br><b>AGREEMENT_AVAILABILITY :</b><br>If the agreement is not available to the participantSet at the time of reminder creation, the reminder will be sent for the first time, only when the agreement becomes available to the participantSet taking the firstReminderDelay into account. Subsequent reminders will be sent based on the frequency specified.<br>If the agreement is already available to the participantSet at the time of reminder creation, the first reminder will be sent after the delay specified by firstReminderDelay from the reminder creation time.<br><br><b>REMINDER_CREATION :</b><br>The first reminder will be sent after the delay specified by firstReminderDelay from the reminder creation time only if the agreement is available at that time. Subsequent reminders will be triggered based on the frequency specified and will be sent only if the agreement is available at that time.<br>For agreements in authoring state, creating reminder with startReminderCounterFrom as REMINDER_CREATION is not allowed.<br>Note : If firstReminderDelay, frequency and startReminderCounterFrom fields are not specified, reminder will be sent right now if the agreement is available. If agreement is not available, an error will be thrown. | [optional] |
| status | StatusEnum | Current status of the reminder | [optional] |
| Name | Value |
|---|---|
| DAILY_UNTIL_SIGNED | "DAILY_UNTIL_SIGNED" |
| WEEKLY_UNTIL_SIGNED | "WEEKLY_UNTIL_SIGNED" |
| ONCE | "ONCE" |
| Name | Value |
|---|---|
| AGREEMENT_AVAILABILITY | "AGREEMENT_AVAILABILITY" |
| REMINDER_CREATION | "REMINDER_CREATION" |
| Name | Value |
|---|---|
| ACTIVE | "ACTIVE" |