Updates the scheduled sending rules for a template's workflow definition
Updates the scheduled sending rules for a template's workflow definition.
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
The ID of the template.
Request Body
application/json
An object that describes the settings for scheduled sending.
An object that describes the settings for scheduled sending.
The ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation.
The timestamp of when the envelope is scheduled to be sent in ISO 8601 format.
This property is read-only.
User-specified rules indicating how and when the envelope should be scheduled for sending. Only one rule may be specified.
Status of the scheduled sending job. Valid values:
pending: The envelope has not yet been sent and the scheduled sending delay has not been initiated.started: The sender has initiated the sending process. The delay has not elapsed, so the envelope has not yet been sent to the first recipient.completed: The delay has elapsed and the envelope has been sent to the first recipient.
This property is read-only.
Response Body
application/json
application/json
curl -X PUT "https://example.com/v2.1/accounts/string/templates/string/workflow/scheduledSending" \ -H "Content-Type: application/json" \ -d '{}'{ "bulkListId": "string", "resumeDate": "string", "rules": [ { "delay": "string", "resumeDate": "string" } ], "status": "string"}