This endpoint allows the client to create a new display ad.
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
display ads
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
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
{
"type": "object",
"required": [
"body_markdown",
"name",
"placement_area"
],
"properties": {
"approved": {
"type": "boolean",
"description": "Ad must be both published and approved to be in rotation"
},
"body_markdown": {
"type": "string",
"description": "The text (in markdown) of the ad (required)"
},
"creator_id": {
"type": "integer",
"description": "Identifies the user who created the ad."
},
"display_to": {
"type": "string",
"description": "Potentially limits visitors to whom the ad is visible",
"enum": [
"all",
"logged_in",
"logged_out"
]
},
"name": {
"type": "string",
"description": "For internal use, helps distinguish ads from one another"
},
"organization_id": {
"type": "integer",
"description": "Identifies the organization to which the ad belongs"
},
"placement_area": {
"type": "string",
"description": "Identifies which area of site layout the ad can appear in",
"enum": [
"sidebar_left",
"sidebar_left_2",
"sidebar_right",
"post_sidebar",
"post_comments"
]
},
"published": {
"type": "boolean",
"description": "Ad must be both published and approved to be in rotation"
},
"tag_list": {
"type": "string",
"description": "Tags on which this ad can be displayed (blank is all/any tags)"
},
"type_of": {
"type": "string",
"description": "Types of the billboards:\nin_house (created by admins),\ncommunity (created by an entity, appears on entity's content),\nexternal ( created by an entity, or a non-entity, can appear everywhere)\n",
"enum": [
"in_house",
"community",
"external"
]
}
}
}Output
- 1
- 2
- 3
- 4
{
"type": "object",
"additionalProperties": true
}