YM REST Services

CustomPages

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin, admin, oauthadmin, admin, oauthadmin, admin, oauthadmin

The following routes are available for this service:
GET	/Ams/{ClientID}/CustomPages	Return a Custom Page.
PUT	/Ams/{ClientID}/CustomPages	Update a Custom Page.
POST	/Ams/{ClientID}/CustomPages	Create a Custom Page.
DELETE	/Ams/{ClientID}/CustomPages	Delete a Custom Page.

**CustomPages** Parameters:
Name	Parameter	Data Type	Required
PageID	body	int	No
VersionID	body	int?	No
PageType	body	CustomPageTypes	No
IsCollaborator	body	bool	No
QueueForDelete	body	bool	No
Searchable	body	bool	No
Publish	body	bool	No
Revert	body	bool	No
CustomPage	body	CustomPage	No

**MemberBaseSharedDto** Parameters:
Name	Parameter	Data Type	Required	Description
MemberID	form	int	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**CustomPage** Parameters:
Name	Parameter	Data Type	Required
PageID	form	int	No
ClientID	form	int	No
CategoryID	form	int?	No
Active	form	bool	No
Private	form	bool	No
Hidden	form	bool	No
AutoFormatted	form	bool	No
Redirect	form	bool	No
RedirectUrl	form	string	No
Identifier	form	string	No
Anchor	form	string	No
Title	form	string	No
EmailFormTo	form	string	No
GroupID	form	int?	No
FormLandingUrl	form	string	No
Index	form	int	No
XmlFeedUrl	form	string	No
XmlFeedType	form	string	No
FormID	form	int	No
CollaborationModeEnabled	form	bool	No
MobilePage	form	bool	No
DateToReview	form	DateTime?	No
Searchable	form	bool	No
HtmlMeta	form	string	No
ScoreContent	form	bool	No
EnableBookmarkWidget	form	bool	No
MicrositePage	form	bool	No
DocTypeID	form	string	No
CategoryName	form	string	No
GroupName	form	string	No
VersionID	form	int	No
ModifiedAt	form	DateTime	No
EditorName	form	string	No
VersionLabel	form	string	No
VersionNotes	form	string	No
Body	form	string	No
FormDisplayStyle	form	int	No
AutoApproveNewSubmissions	form	bool	No
TemplateID	form	int?	No
HideRightRail	form	bool	No
MetaTitle	form	string	No
RelatedPagesIDs	form	int[]	No
MemberTypesIDs	form	int[]	No
EditorCdbID	form	int?	No
CollectionIDs	form	int[]	No
PageStatus	form	int	No
Permalink	form	string	No
IsMemberTypeThankYou	form	bool	No
IsLock	form	bool	No

**CustomPagesResponse** Parameters:
Name	Parameter	Data Type	Required
CustomPages	form	CustomPage	No
PageIDUsedByAnotherPage	form	bool	No
PageIsUsedAsThankYouPage	form	bool	No

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.

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

{
	PageID: 0,
	VersionID: 0,
	PageType: Backend,
	IsCollaborator: False,
	QueueForDelete: False,
	Searchable: False,
	Publish: False,
	Revert: False,
	CustomPage: 
	{
		PageID: 0,
		ClientID: 0,
		CategoryID: 0,
		Active: False,
		Private: False,
		Hidden: False,
		AutoFormatted: False,
		Redirect: False,
		RedirectUrl: String,
		Identifier: String,
		Anchor: String,
		Title: String,
		EmailFormTo: String,
		GroupID: 0,
		FormLandingUrl: String,
		Index: 0,
		XmlFeedUrl: String,
		XmlFeedType: String,
		FormID: 0,
		CollaborationModeEnabled: False,
		MobilePage: False,
		DateToReview: 0001-01-01,
		Searchable: False,
		HtmlMeta: String,
		ScoreContent: False,
		EnableBookmarkWidget: False,
		MicrositePage: False,
		DocTypeID: String,
		CategoryName: String,
		GroupName: String,
		VersionID: 0,
		ModifiedAt: 0001-01-01,
		EditorName: String,
		VersionLabel: String,
		VersionNotes: String,
		Body: String,
		FormDisplayStyle: 0,
		AutoApproveNewSubmissions: False,
		TemplateID: 0,
		HideRightRail: False,
		MetaTitle: String,
		RelatedPagesIDs: 
		[
			0
		],
		MemberTypesIDs: 
		[
			0
		],
		EditorCdbID: 0,
		CollectionIDs: 
		[
			0
		],
		PageStatus: 0,
		Permalink: String,
		IsMemberTypeThankYou: False,
		IsLock: 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:33:58.1455728-05:00,
	Device: Desktop
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CustomPages: 
	{
		PageID: 0,
		ClientID: 0,
		CategoryID: 0,
		Active: False,
		Private: False,
		Hidden: False,
		AutoFormatted: False,
		Redirect: False,
		RedirectUrl: String,
		Identifier: String,
		Anchor: String,
		Title: String,
		EmailFormTo: String,
		GroupID: 0,
		FormLandingUrl: String,
		Index: 0,
		XmlFeedUrl: String,
		XmlFeedType: String,
		FormID: 0,
		CollaborationModeEnabled: False,
		MobilePage: False,
		DateToReview: 0001-01-01,
		Searchable: False,
		HtmlMeta: String,
		ScoreContent: False,
		EnableBookmarkWidget: False,
		MicrositePage: False,
		DocTypeID: String,
		CategoryName: String,
		GroupName: String,
		VersionID: 0,
		ModifiedAt: 0001-01-01,
		EditorName: String,
		VersionLabel: String,
		VersionNotes: String,
		Body: String,
		FormDisplayStyle: 0,
		AutoApproveNewSubmissions: False,
		TemplateID: 0,
		HideRightRail: False,
		MetaTitle: String,
		RelatedPagesIDs: 
		[
			0
		],
		MemberTypesIDs: 
		[
			0
		],
		EditorCdbID: 0,
		CollectionIDs: 
		[
			0
		],
		PageStatus: 0,
		Permalink: String,
		IsMemberTypeThankYou: False,
		IsLock: False
	},
	PageIDUsedByAnotherPage: False,
	PageIsUsedAsThankYouPage: False,
	PageID: 0,
	VersionID: 0,
	PageType: Backend,
	IsCollaborator: False,
	QueueForDelete: False,
	Searchable: False,
	Publish: False,
	Revert: False,
	CustomPage: 
	{
		PageID: 0,
		ClientID: 0,
		CategoryID: 0,
		Active: False,
		Private: False,
		Hidden: False,
		AutoFormatted: False,
		Redirect: False,
		RedirectUrl: String,
		Identifier: String,
		Anchor: String,
		Title: String,
		EmailFormTo: String,
		GroupID: 0,
		FormLandingUrl: String,
		Index: 0,
		XmlFeedUrl: String,
		XmlFeedType: String,
		FormID: 0,
		CollaborationModeEnabled: False,
		MobilePage: False,
		DateToReview: 0001-01-01,
		Searchable: False,
		HtmlMeta: String,
		ScoreContent: False,
		EnableBookmarkWidget: False,
		MicrositePage: False,
		DocTypeID: String,
		CategoryName: String,
		GroupName: String,
		VersionID: 0,
		ModifiedAt: 0001-01-01,
		EditorName: String,
		VersionLabel: String,
		VersionNotes: String,
		Body: String,
		FormDisplayStyle: 0,
		AutoApproveNewSubmissions: False,
		TemplateID: 0,
		HideRightRail: False,
		MetaTitle: String,
		RelatedPagesIDs: 
		[
			0
		],
		MemberTypesIDs: 
		[
			0
		],
		EditorCdbID: 0,
		CollectionIDs: 
		[
			0
		],
		PageStatus: 0,
		Permalink: String,
		IsMemberTypeThankYou: False,
		IsLock: 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:33:58.1612012-05:00,
	Device: Desktop
}