FaqArticles
Create FaqArticle
Create a new FaqArticle record.
POST
Create FaqArticle
A FaqArticle represents a frequently asked question and its answer, displayed on the members portal to help customers find information without contacting support.
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 FaqArticle-Create role.Request Body
Required Fields
ID of the business linked to this record.
The title value for this faq article.
The display order value for this faq article.
Optional Fields
The summary text value for this faq article.
The full text value for this faq 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.
Whether this faq article is currently active.
The group name value for this faq article.
Whether show in home page is enabled.
Whether only for contacts is enabled.
Whether only for members is enabled.
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 faqarticle 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 FaqArticle