Articles
Update BlogPost
Update an existing BlogPost record.
PUT
Update BlogPost
Updates an existing BlogPost record. You must include the
Id of the record to update along with all required fields.
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-Edit role.Request Body
Required Fields
integer
required
The Id of the BlogPost record to update.
integer
required
ID of the business linked to this record.
string
required
Article title.
integer
required
Number of comments on this article.
Optional Fields
integer
ID of the language linked to this record.
integer
ID of the posted by linked to this record.
string
Short overview displayed at the top of the article.
string
Main 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
Date and time when the article is published. Past dates publish immediately; future dates schedule publication.
boolean
Feature this article on the Members Portal home page before users log in.
boolean
Feature this article on the Members Portal home page after users log in.
string
Date and time when the article is automatically unpublished. Leave blank to keep published indefinitely.
boolean
Whether customers can post comments on this article.
integer[]
List of blog categories linked to this record.
integer[]
The added blog categories value for this blog post.
integer[]
The removed blog categories value for this blog post.
boolean
Restrict visibility to contacts (customers without an active contract).
boolean
Restrict visibility to members (customers with an active contract).
Code Examples
Response
200
integer
HTTP status code.
200 on success.string
A human-readable message confirming the update.
object
Contains the
Id of the updated record.boolean
true if the blogpost was updated 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
Update BlogPost