YM REST Services

<back to all web services

MembershipRenewalReminderPutRequest

Update the Membership Renewal Reminder details

Requires Authentication
Requires any of the roles:admin, oauthadminRequires the permission:CanAdminMembers
The following routes are available for this service:
PUT/Ams/{ClientID}/MembershipRenewalReminderUpdate Membership Renewal Reminders Details for given Membership Id.
MembershipRenewalReminderPutRequest Parameters:
NameParameterData TypeRequiredDescription
membershipRenewalReminderbodyMembershipRenewalReminderNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
MembershipRenewalReminder Parameters:
NameParameterData TypeRequiredDescription
IdformintNoMembership Id
AdvanceRenewalReminderformList<AdvanceRenewalReminder>NoAdvance Renewal Reminder configuration for Reminder 1 , 2 and 3
AdvanceMembershipRenewalDaysformint?NoHow many days in advance can memberships be renewed?
UseCustomLastDayExpireNotificationformbool?NoUse custom reminder email content for last day renewal reminder
UseCustomPostExpireNoticationformbool?NoUse custom reminder email content for post expiration renewal reminder
CustomLastDaySubjectformstringNoCustom subject for last day renewal reminder
CustomLastDayNotificationBodyformstringNoCustom message for last day renewal reminder
CustomPostExpireSubjectformstringNoCustom subject for post expiration renewal reminder
CustomPostExpireNotificationBodyformstringNoCustom message for post expiration renewal reminder
MembershipNameformstringNoMembership name
PostExpireMembershipRenewalDaysformint?NoHow many days after should a reminder be sent?
SendPostExpireMembershipReminderformbool?NoSend a reminder via email for post expiration renewal reminder
SendLastDayExpireMembershipReminderformbool?NoSend a reminder via email for last day renewal reminder
AdvanceRenewalReminder Parameters:
NameParameterData TypeRequiredDescription
ReminderTypeformintNoType of advance renewal reminder
SendMembershipReminderformbool?NoSend a reminder via email for advanced renewal reminder
AdvanceMembershipRenewalReminderDaysformint?NoHow many days in advance should a reminder be sent?
UseCustomPreExpireNotificationformbool?NoUse custom reminder email content for advanced renewal reminder
CustomPreExpireSubjectformstringNoCustom subject for advanced renewal reminder
CustomPreExpireNotificationBodyformstringNoCustom message for advanced renewal reminder
MembershipRenewalReminderPutResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNoFlag used to represent if membership renewal details updated successfully
MessageformstringNoMessage used to represent if membership renewal details updated successfully

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /Ams/{ClientID}/MembershipRenewalReminder HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	membershipRenewalReminder: 
	{
		Id: 0,
		AdvanceRenewalReminder: 
		[
			{
				ReminderType: 0,
				SendMembershipReminder: False,
				AdvanceMembershipRenewalReminderDays: 0,
				UseCustomPreExpireNotification: False,
				CustomPreExpireSubject: String,
				CustomPreExpireNotificationBody: String
			}
		],
		AdvanceMembershipRenewalDays: 0,
		UseCustomLastDayExpireNotification: False,
		UseCustomPostExpireNotication: False,
		CustomLastDaySubject: String,
		CustomLastDayNotificationBody: String,
		CustomPostExpireSubject: String,
		CustomPostExpireNotificationBody: String,
		MembershipName: String,
		PostExpireMembershipRenewalDays: 0,
		SendPostExpireMembershipReminder: False,
		SendLastDayExpireMembershipReminder: False
	},
	MemberID: 0,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2025-01-15T08:43:45.0572461-05:00,
	Device: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	Message: String,
	membershipRenewalReminder: 
	{
		Id: 0,
		AdvanceRenewalReminder: 
		[
			{
				ReminderType: 0,
				SendMembershipReminder: False,
				AdvanceMembershipRenewalReminderDays: 0,
				UseCustomPreExpireNotification: False,
				CustomPreExpireSubject: String,
				CustomPreExpireNotificationBody: String
			}
		],
		AdvanceMembershipRenewalDays: 0,
		UseCustomLastDayExpireNotification: False,
		UseCustomPostExpireNotication: False,
		CustomLastDaySubject: String,
		CustomLastDayNotificationBody: String,
		CustomPostExpireSubject: String,
		CustomPostExpireNotificationBody: String,
		MembershipName: String,
		PostExpireMembershipRenewalDays: 0,
		SendPostExpireMembershipReminder: False,
		SendLastDayExpireMembershipReminder: False
	},
	MemberID: 0,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2025-01-15T08:43:45.0737008-05:00,
	Device: Desktop
}