This endpoint allows the client to retrieve details for a single Page object, specified by ID.
643 matches
40 actions
Forem API V1
40 actions
- A UserGETv1.0.0
- A Users or organizations profile imageGETv1.0.0
- An organizationGETv1.0.0
- Articles with a videoGETv1.0.0
- Comment by idGETv1.0.0
- CommentsGETv1.0.0
- create reactionPOSTv1.0.0
- display adGETv1.0.0
- display adsGETv1.0.0
- display adsPOSTv1.0.0
- display adsPUTv1.0.0
- Followed TagsGETv1.0.0
- FollowersGETv1.0.0
- Invite a UserPOSTv1.0.0
- Organization's ArticlesGETv1.0.0
- Organization's usersGETv1.0.0
- pagesPOSTv1.0.0
- Podcast EpisodesGETv1.0.0
- Publish articlePOSTv1.0.0
- Published article by idGETv1.0.0
- Published article by pathGETv1.0.0
- Published articlesGETv1.0.0
- Published articles sorted by published dateGETv1.0.0
- ReadinglistGETv1.0.0
- remove a pageDELETEv1.0.0
- show details for a pageGETv1.0.0
- show details for all pagesGETv1.0.0
- Suspend a UserPUTv1.0.0
- TagsGETv1.0.0
- The authenticated userGETv1.0.0
- toggle reactionPOSTv1.0.0
- unpublishPUTv1.0.0
- Unpublish a User's Articles and CommentsPUTv1.0.0
- Unpublish an articlePUTv1.0.0
- Update an article by idPUTv1.0.0
- update details for a pagePUTv1.0.0
- User's all articlesGETv1.0.0
- User's articlesGETv1.0.0
- User's published articlesGETv1.0.0
- User's unpublished articlesGETv1.0.0
Social/Forem API V1
update details for a page
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
{
"type": "object",
"properties": {
"body_json": {
"type": "string",
"description": "For JSON pages, the JSON body"
},
"body_markdown": {
"type": "string",
"description": "The text (in markdown) of the ad (required)"
},
"description": {
"type": "string",
"description": "For internal use, helps similar pages from one another"
},
"id": {
"type": "integer",
"format": "int32"
},
"is_top_level_path": {
"type": "boolean",
"description": "If true, the page is available at '/{slug}' instead of '/page/{slug}', use with caution"
},
"slug": {
"type": "string",
"description": "Used to link to this page in URLs, must be unique and URL-safe"
},
"social_image": {
"type": "object"
},
"template": {
"type": "string",
"description": "Controls what kind of layout the page is rendered in",
"enum": [
"contained",
"full_within_layout",
"nav_bar_included",
"json"
]
},
"title": {
"type": "string",
"description": "Title of the page"
}
},
"required": [
"description",
"id",
"slug",
"template",
"title"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
{
"type": "object",
"description": "Representation of a page object",
"required": [
"description",
"slug",
"template",
"title"
],
"properties": {
"body_json": {
"type": "string",
"description": "For JSON pages, the JSON body"
},
"body_markdown": {
"type": "string",
"description": "The text (in markdown) of the ad (required)"
},
"description": {
"type": "string",
"description": "For internal use, helps similar pages from one another"
},
"is_top_level_path": {
"type": "boolean",
"description": "If true, the page is available at '/{slug}' instead of '/page/{slug}', use with caution"
},
"slug": {
"type": "string",
"description": "Used to link to this page in URLs, must be unique and URL-safe"
},
"social_image": {
"type": "object"
},
"template": {
"type": "string",
"description": "Controls what kind of layout the page is rendered in",
"enum": [
"contained",
"full_within_layout",
"nav_bar_included",
"json"
]
},
"title": {
"type": "string",
"description": "Title of the page"
}
}
}