API v1 ReferenceImages

Sets a profile image from a previously uploaded file.

After an image has been uploaded to an upload URL generated by the /files/generateuploadurl endpoint, this endpoint sets the uploaded image as the profile image of the entity by providing the upload id. <Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

entityNamestringRequiredformat: "^[A-Za-z]*$"
entityIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.
uploadIdstringRequired>=1 character
The id of the temporary container that the file will be uploaded to.
fileNamestringRequired>=1 character
The name of the file that will be uploaded.
descriptionstring or nullOptional
The description of the file.

Response

OK
namestring or nullOptional

The user-specified name of the file.

descriptionstring or nullOptional
The description of the file.
idstringOptionalformat: "uuid"
The id of the file info.
projectIdstring or nullOptionalformat: "uuid"
projectTemplateIdstring or nullOptionalformat: "uuid"
companyIdstring or nullOptionalformat: "uuid"
taskIdstring or nullOptionalformat: "uuid"
taskTemplateIdstring or nullOptionalformat: "uuid"
userIdstring or nullOptionalformat: "uuid"
documentIdstring or nullOptionalformat: "uuid"
fileNamestring or nullOptional
The name of the file.
entityTypestring or nullOptional
The name of the linked entity type.
mimeTypestring or nullOptional
The MIME type of the file.
createdOnstringOptionalformat: "date-time"
The date this file was created.
createdBystringOptionalformat: "uuid"
The id of the user who created this file.
updatedOnstringOptionalformat: "date-time"
The date this file was last modified.
updatedBystringOptionalformat: "uuid"
The id of the user who last modified this file.
fileVersionslist of objects or nullOptional
List of all versions.
isCommentFilebooleanOptional
Whether the file is related to a comment.
externalProviderstring or nullOptional
The external provider for the file. Like 'google' or 'onedrive'.
externalFileUrlstring or nullOptional
The file url of the external provider.
isHiddenForConnectUsersbooleanOptional
Whether the file is hidden for connect users.
entityIdstring or nullOptionalformat: "uuid"Deprecated
Deprecated. The id of the linked entity derived from entity specific owner ids.

Errors

400
Bad Request Error
401
Unauthorized Error