BlogPosts
Create BlogPost
Create a new BlogPost record.
POST
Create BlogPost
A BlogPost is a location-specific article for the Members Portal, with HTML content, optional images and categories, scheduled publication, audience restrictions, home-page placement, and optional customer comments.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the BlogPost-Create role.Request Body
Required Fields
integer
required
ID of the location that owns this article..
string
required
Required title of the article..
Optional Fields
integer
ID of the optional location-specific language used for this article..
integer
ID of the user attributed as the author; creation assigns the currently authenticated user..
string
Optional short overview displayed with the article..
string
Optional HTML body content of the article..
string
URL of a new file to upload as the image.
boolean
Set to true to remove the current image file.
string
URL of a new file to upload as the large image.
boolean
Set to true to remove the current large image file.
string
UTC date and time when the public article becomes available; it must be set, and a future value schedules publication..
boolean
Whether to feature the article in the Members Portal home banner before sign-in..
boolean
Whether to feature the article on the Members Portal home page after sign-in..
string
Optional UTC date and time recorded as the article’s unpublish date; leave blank when no unpublish date is required..
boolean
Whether customers can submit comments on this article..
integer[]
List of location-specific blog category IDs assigned to this article; an empty list leaves it uncategorized..
boolean
Whether the article is restricted to contacts, meaning customers without an active contract..
boolean
Whether the article is restricted to members, meaning customers with an active contract..
Code Examples
Response
200
integer
HTTP status code.
200 on success.string
A human-readable message confirming the creation.
object
Contains the
Id of the newly created record.boolean
true if the blogpost was created successfully.array
null on success.Example Response
400
string
A summary of the validation error(s), in the format
PropertyName: error message.any
null on validation failure.object[]
Array of validation errors.
boolean
false when the request fails validation.Example Response