Event Management

Update Email Notification

Updates an Email Notification for a particular event.

  • fromLabel validations:
    • Only alphanumeric characters and a maximum of 50 characters are allowed.
    • International characters or email addresses are not allowed.
  • whentosend accepted values:
    • 2 Weeks Before Event
    • 1 Week Before Event
    • 5 Days Before Event
    • Days Before Event
    • 2 Days Before Event
    • 1 Day Before Event
    • 12 Hours Before Event
    • 6 Hours Before Event
    • 5 Hours Before Event
    • 4 Hours Before Event
    • 3 Hours Before Event
    • 2 Hours Before Event
    • 1 Hour Before Event
    • 30 Minutes Before Event
    • 15 Minutes Before Event
    • 1 Hour After Event
    • 2 Hours After Event
    • 3 Hours After Event
    • 4 Hours After Event
    • 5 Hours After Event
    • 6 Hours After Event
    • 12 Hours After Event
    • 1 Day After Event
    • 2 Days After Event
    • 3 Days After Event
    • 5 Days After Event
    • 1 Week After Event
    • 2 Weeks After Event
    • When Event Starts
    • Custom Date And Time

Conditions & Restrictions

In order to update an email notification, certain contitions must be met.

  • An email can't be updated if already sent.

  • 'When to send' Can't be updated if the email type is 'Registration Confirmation Email'.

  • If email type is Reminder (#1, #2, #3, #4) , 'When to send' can be set as 'Custom Date and Time' and also 'goodafter' date can be provided.

  • Email notification body supporting HTML and Tokens (#FIRSTNAME#, #LASTNAME#, #EMAIL#, #COMPANY#, #EVENTTITLE#, #EVENTDATE#, #EVENTTIME#, #EVENTDAY#, #EVENTTIMEZONESHORT#, #EVENTTIMEZONELONG#, #AUDIENCEURL#, #CALENDARREMINDER#, #EVENTHELPURL#, #DOWNLOADCERTIFICATE#, #EMAILSETTINGSURL#)

  • This endpoint provides support for ISO-8601 strings in goodafter parameter. If time information is not provided, it will default to 09:00:00. Following time values are accepted: 12:00:00 (12:00 AM), 12:15:00 (12:15 AM), 12:30:00 (12:30 AM), 12:45.00 (12:45 AM), 01:00:00 (01:00 AM), 01:15:00 (01:15 AM), 01:30:00 (01:30 AM), 01:45:00 (01:45 AM), 02:00:00 (02:00 AM), 02:15:00 (02:15 AM), 02:30:00 (02:30 AM), 02:45:00 (02:45 AM), 03:00:00 (03:00 AM), 03:15:00 (03:15 AM), 03:30:00 (03:30 AM), 03:45:00 (03:45 AM), 04:00:00 (04:00 AM), 04:15:00 (04:15 AM), 04:30:00 (04:30 AM), 04:45:00 (04:45 AM), 05:00:00 (05:00 AM), 05:15:00 (05:15 AM), 05:30:00 (05:30 AM), 05:45:00 (05:45 AM), 06:00:00 (06:00 AM), 06:15:00 (06:15 AM), 06:30:00 (06:30 AM), 06:45:00 (06:45 AM), 07:00:00 (07:00 AM), 07:15:00 (07:15 AM), 07:30:00 (07:30 AM), 07:45:00 (07:45 AM), 08:00:00 (08:00 AM), 08:15:00 (08:15 AM), 08:30:00 (08:30 AM), 08:45:00 (08:45 AM), 09:00:00 (09:00 AM), 09:15:00 (09:15 AM), 09:30:00 (09:30 AM), 09:45:00 (09:45 AM), 10:00:00 (10:00 AM), 10:15:00 (10:15 AM), 10:30:00 (10:30 AM), 10:45:00 (10:45 AM), 11:00:00 (11:00 AM), 11:15:00 (11:15 AM), 11:30:00 (11:30 AM), 11:45:00 (11:45 AM), 12:00:00 (12:00 PM), 12:15:00 (12:15 PM), 12:30:00 (12:30 PM), 12:45:00 (12:45 PM), 13:00:00 (01:00 PM), 13:15:00 (01:15 PM), 13:30:00 (13:30 PM), 13:45:00 (01:45 PM), 14:00:00 (02:00 PM), 14:15:00 (02:15 PM), 14:30:00 (02:30 PM), 14:45:00 (02:45 PM), 15:00:00 (03:00 PM), 15:15:00 (03:15 PM), 15:30:00 (03:30 PM), 15:45:00 (03:45 PM), 16:00:00 (04:00 PM), 16:15:00 (04:15 PM), 16:30:00 (04:30 PM), 16:45:00 (04:45 PM), 17:00:00 (05:00 PM), 17:15:00 (05:15 PM), 17:30:00 (05:30 PM), 17:45:00 (05:45 PM), 18:00:00 (06:00 PM), 18:15:00 (06:15 PM), 18:30:00 (06:30 PM), 18:45:00 (06:45 PM), 19:00:00 (07:00 PM), 19:15:00 (07:15 PM), 19:30:00 (07:30 PM), 19:45:00 (07:45 PM), 20:00:00 (08:00 PM), 20:15:00 (08:15 PM), 20:30:00 (08:30 PM), 20:45:00 (08:45 PM), 21:00:00 (09:00 PM), 21:15:00 (09:15 PM), 21:30:00 (09:30 PM), 21:45:00 (09:45 PM), 22:00:00 (10:00 PM), 22:15:00 (10:15 PM), 22:30:00 (10:30 PM), 22:45:00 (10:45 PM), 23:00:00 (11:00 PM), 23:15:00 (11:15 PM), 23:30:00 (11:30 PM), 23:45:00 (11:45 PM)

  • If email type is Reminder (#1, #2, #3, #4) email, following values are accepted for 'when to send':

    • 2 Weeks Before Webcast, 1 Week Before Webcast,
    • 5 Days Before Webcast, 3 Days Before Webcast, 2 Days Before Webcast, 1 Day Before Webcast,
    • 12 Hours Before Webcast, 6 Hours Before Webcast, 5 Hours Before Webcast,
    • 4 Hours Before Webcast, 3 Hours Before Webcast, 2 Hours Before Webcast, 1 Hour Before Webcast,
    • 30 Minutes Before Webcast, 15 Minutes Before Webcast,
    • When Webcast Starts,
    • Custom Date And Time
  • If email type is "Sorry We Missed You" or "Thank You for Attending" Email, following values are accepted for 'when to send':

    • 1 Hour After Webcast, 2 Hours After Webcast, 3 Hours After Webcast,
    • 4 Hours After Webcast, 5 Hours After Webcast, 6 Hours After Webcast, 12 Hours After Webcast,
    • 1 Day After Webcast, 2 Days After Webcast, 3 Days After Webcast, 5 Days After Webcast,
    • 1 Week After Webcast, 2 Weeks After Webcast
put/client/{clientId}/event/{eventId}/email/{emailId}

Request

  • Base URL: https://api.on24.com/wcc/api/v2
  • URL: https://api.on24.com/wcc/api/v2/client/{clientId}/event/{eventId}/email/{emailId}
  • Auth: one of:
    • API key in header AccessTokenKey
    • API key in header AccessTokenSecret

Path parameters

emailIdstring required

The email id

clientIdnumber required

The client id

eventIdnumber required

The event id

Headers

accessTokenKeystring required

Security Parameter

accessTokenSecretstring required

Security Parameter

Response

Email Notification Updated

Changes

No recorded changes to this operation across all 1 revision of this API.