Skip to main content
PUT
Update CommunityThreadFile
Updates an existing CommunityThreadFile 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 CommunityThreadFile-Edit role.

Request Body

Required Fields

integer
required
The Id of the CommunityThreadFile record to update.
integer
required
ID of the conversation this file is attached to.

Optional Fields

string
Display name of the attached file.
string
Optional description of the attached file.
string
URL of a new file to upload and attach to this record.
boolean
When true, removes the currently attached file.

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 communitythreadfile 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