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
The Id of the BlogPost record to update.
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.
The added blog categories value for this blog post.
The removed blog categories value for this blog post.
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 update.
Contains the
Id of the updated record.true if the blogpost was updated 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
Update BlogPost