YM REST Services

<back to all web 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}/CustomPagesReturn a Custom Page.
PUT/Ams/{ClientID}/CustomPagesUpdate a Custom Page.
POST/Ams/{ClientID}/CustomPagesCreate a Custom Page.
DELETE/Ams/{ClientID}/CustomPagesDelete a Custom Page.
CustomPages Parameters:
NameParameterData TypeRequiredDescription
PageIDbodyintNo
VersionIDbodyint?No
PageTypebodyCustomPageTypesNo
IsCollaboratorbodyboolNo
QueueForDeletebodyboolNo
SearchablebodyboolNo
PublishbodyboolNo
RevertbodyboolNo
CustomPagebodyCustomPageNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
CustomPage Parameters:
NameParameterData TypeRequiredDescription
PageIDformintNo
ClientIDformintNo
CategoryIDformint?No
ActiveformboolNo
PrivateformboolNo
HiddenformboolNo
AutoFormattedformboolNo
RedirectformboolNo
RedirectUrlformstringNo
IdentifierformstringNo
AnchorformstringNo
TitleformstringNo
EmailFormToformstringNo
GroupIDformint?No
FormLandingUrlformstringNo
IndexformintNo
XmlFeedUrlformstringNo
XmlFeedTypeformstringNo
FormIDformintNo
CollaborationModeEnabledformboolNo
MobilePageformboolNo
DateToReviewformDateTime?No
SearchableformboolNo
HtmlMetaformstringNo
ScoreContentformboolNo
EnableBookmarkWidgetformboolNo
MicrositePageformboolNo
DocTypeIDformstringNo
CategoryNameformstringNo
GroupNameformstringNo
VersionIDformintNo
ModifiedAtformDateTimeNo
EditorNameformstringNo
VersionLabelformstringNo
VersionNotesformstringNo
BodyformstringNo
FormDisplayStyleformintNo
AutoApproveNewSubmissionsformboolNo
TemplateIDformint?No
HideRightRailformboolNo
MetaTitleformstringNo
RelatedPagesIDsformint[]No
MemberTypesIDsformint[]No
EditorCdbIDformint?No
CollectionIDsformint[]No
PageStatusformintNo
PermalinkformstringNo
IsMemberTypeThankYouformboolNo
IsLockformboolNo
CustomPagesResponse Parameters:
NameParameterData TypeRequiredDescription
CustomPagesformCustomPageNo
PageIDUsedByAnotherPageformboolNo
PageIsUsedAsThankYouPageformboolNo

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

HTTP + CSV

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/csv
Content-Type: text/csv
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-01T00:00:00.0000000","Searchable":false,"HtmlMeta":"String","ScoreContent":false,"EnableBookmarkWidget":false,"MicrositePage":false,"DocTypeID":"String","CategoryName":"String","GroupName":"String","VersionID":0,"ModifiedAt":"0001-01-01T00:00:00.0000000","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:40:13.3303510-05:00","Device":"Desktop"}

HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","Searchable":false,"HtmlMeta":"String","ScoreContent":false,"EnableBookmarkWidget":false,"MicrositePage":false,"DocTypeID":"String","CategoryName":"String","GroupName":"String","VersionID":0,"ModifiedAt":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","Searchable":false,"HtmlMeta":"String","ScoreContent":false,"EnableBookmarkWidget":false,"MicrositePage":false,"DocTypeID":"String","CategoryName":"String","GroupName":"String","VersionID":0,"ModifiedAt":"0001-01-01T00:00:00.0000000","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:40:13.3303510-05:00","Device":"Desktop"}