Articles
Create BlogPost
Create a new BlogPost record.
POST
Create BlogPost
A BlogPost represents an article published on the Members Portal. Articles can be used to share news, updates, or useful content with customers.
Articles support scheduled publishing via
PublishDate and automatic unpublishing via UnpublishDate. Setting a PublishDate in the past publishes the article immediately; setting a future date schedules it. Leaving UnpublishDate blank keeps the article published until it is manually unpublished or deleted.
Each article has a SummaryText (short overview displayed at the top) and a FullText (the main body content). Articles can be organised into categories using the BlogCategory entity and can optionally allow customer comments.
Visibility can be controlled with OnlyForMembers (customers with an active contract) and OnlyForContacts (customers without an active contract). Articles can also be featured on the Members Portal home page before login (ShowInHomeBanner) or after login (ShowInHomePage).
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
ID of the business linked to this record.
Article title.
Number of comments on this article.
Optional Fields
ID of the language linked to this record.
ID of the posted by linked to this record.
Short overview displayed at the top of the article.
Main body content of the article.
URL of a new file to upload as the image.
Set to true to remove the current image file.
URL of a new file to upload as the large image.
Set to true to remove the current large image file.
Date and time when the article is published. Past dates publish immediately; future dates schedule publication.
Feature this article on the Members Portal home page before users log in.
Feature this article on the Members Portal home page after users log in.
Date and time when the article is automatically unpublished. Leave blank to keep published indefinitely.
Whether customers can post comments on this article.
List of blog categories linked to this record.
Restrict visibility to contacts (customers without an active contract).
Restrict visibility to members (customers with an active contract).
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the creation.
Contains the
Id of the newly created record.true if the blogpost was created successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response
Create BlogPost