CommunityThreads
Update CommunityThread
Update an existing CommunityThread record.
PUT
Update CommunityThread
Updates an existing CommunityThread 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 CommunityThread-Edit role.Request Body
Required Fields
integer
required
The Id of the CommunityThread record to update.
integer
required
ID of the location this conversation belongs to.
integer
required
ID of the user account that posted this conversation.
string
required
Title or topic of the conversation.
string
required
Body text of the opening message in this conversation.
Optional Fields
integer
ID of the group this conversation is assigned to; the group’s access level (Public, Restricted, or Private) determines who can see and contribute to it.
integer
ID of the customer profile that posted this conversation.
boolean
When true, sends notifications to followers immediately after posting instead of waiting for the daily digest.
string
Comma-separated tags to help customers find this conversation.
boolean
When true, the conversation is visible only to customers explicitly mentioned in the message.
integer[]
IDs of users mentioned or invited as guests in this conversation.
integer[]
User IDs to add as guests (used in partial updates).
integer[]
User IDs to remove as guests (used in partial updates).
boolean
When true, attaches a Zoom meeting invite to this conversation.
string
JSON payload containing Zoom meeting details attached to this conversation.
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 communitythread 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 CommunityThread