CIcitrusad

Upload a file

This endpoint allows you to upload logos for user profiles and teams.

post/file-upload

Request

Query parameters

teamIdstring required

Specifies the unique identifier of the team to which the user belongs to.

managerTeamIdstring

The unique identifier for a retailer-managed team. As a retailer, you can upload logos for user profiles and teams for the supplier team by specifying the managerTeamId. Ensure that API requests are authenticated with the retailer's bearer token.

fileType'FILE_TYPE_USER_LOGO' | 'FILE_TYPE_TEAM_LOGO' required

Specifies the type of file to be uploaded. The file must be in one of the following formats: jpeg, jpg, or png. Valid upload file types include:

  • FILE_TYPE_USER_LOGO: Logo for user profile.
  • FILE_TYPE_TEAM_LOGO: Logo for team profile.

Request body multipart/form-data

fileUploadstring binary required

The file to upload, which must be in jpeg, jpg, or png format.

Response

The logo file has been uploaded successfully.

fileIdstring

The unique identifier of the uploaded file.

fileUrlstring

The URL to access the file uploaded.

Example response

{
  "fileId": "1ceee624-7c87-4e98-9995-042da2a32525",
  "fileUrl": "https://storage.googleapis.com/user_logo/.../path-to-image"
}

Changes

No recorded changes to this operation across all 1 revision of this API.