Jump to content

Community

REST API Documentation

/cms/records/{database_id}/{record_id}


Edit a record

For requests using an OAuth Access Token for a particular member, any parameters the user doesn't have permission to use are ignored (for example, locked will only be honoured if the authenticated user has permission to lock topics).


Parameters

Name Type Description
Required fields object Field values. Keys should be the field ID, and the value should be the value. For requests using an OAuth Access Token for a particular member, values will be sanatised where necessary. For requests made using an API Key or the Client Credentials Grant Type values will be saved unchanged.
category int The ID number of the category the record should be created in. If the database does not use categories, this is not required
author int The ID number of the member creating the record (0 for guest). Ignored for requests using an OAuth Access Token for a particular member.
prefix string Prefix tag
tags string Comma-separated list of tags (do not include prefix)
ip_address string The IP address that should be stored for the record. If not provided, will use the IP address from the API request. Ignored for requests using an OAuth Access Token for a particular member.
locked int 1/0 indicating if the record should be locked
hidden int 0 = unhidden; 1 = hidden, pending moderator approval; -1 = hidden (as if hidden by a moderator)
pinned int 1/0 indicating if the record should be pinned
featured int 1/0 indicating if the record should be featured

Exceptions

Code Message Description
2T306/9 INVALID_DATABASE The database ID does not exist
2T306/6 INVALID_ID The record ID is invalid or the authorized user does not have permission to view it
1T306/7 NO_CATEGORY The category ID does not exist or the authorized user does not have permission to post in it
1T306/8 NO_AUTHOR The author ID does not exist
2T306/H NO_PERMISSION The authorized user does not have permission to edit the record

Response

Name Type Description
id int ID number
title string Title
category categories object Category
fields object Field values
author member object The member that created the event
date datetime When the record was created
description string Event description
comments int Number of comments
reviews int Number of reviews
views int Number of posts
prefix string The prefix tag, if there is one
tags array of strings The tags
locked bool Event is locked
hidden bool Event is hidden
pinned bool Event is pinned
featured bool Event is featured
url string URL
rating float Average Rating

categories object

Name Type Description
id int ID number
name string Name
url string URL
class string Node class
permissions bject|null object Node permissions

member object

Name Type Description
id int ID number
name string Username
title string Member title
timezone string Member timezone
formattedName string Username with group formatting
ipAddress string IP address used during registration
primaryGroup group object Primary group
secondaryGroups array of group objects Secondary groups
email string Email address
joined datetime Registration date
registrationIpAddress string IP address when registered
warningPoints int Number of active warning points
reputationPoints int Number of reputation points
photoUrl string URL to photo (which will be the site's default if they haven't set one)
photoUrlIsDefault bool Indicates if the value of photoUrl is the site's default
coverPhotoUrl string URL to profile cover photo (will be blank if there isn't one)
profileUrl tring|null object URL to profile
validating bool Whether or not the validating flag is set on the member account
posts int Number of content item submissions member has made
lastActivity atetime|null object Last activity date on the site
lastVisit atetime|null object Last distinct visit date on the site
lastPost atetime|null object Latest content submission date
profileViews int Number of times member's profile has been viewed
birthday string Member birthday in MM/DD/YYYY format (or MM/DD format if no year has been supplied)
customFields array of fieldgroup objects Custom profile fields. For requests using an OAuth Access Token for a particular member, only fields the authorized user can view will be included

group object

Name Type Description
id int ID number
name string Name
formattedName string Name with formatting

fieldgroup object

Name Type Description
name string Group name
fields array of field objects Fields

field object

Name Type Description
name string Field name
value string Value
×
×
  • Create New...