Request headers

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : 'Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION'

Request body example

{
  "media_file": {
    "name": "media_file",
    "s3_key": "s3_key",
    "format_type": "png",
    "media_type": "photo",
    "size": 109495405,
    "is_cutout": true,
    "origin_id": 14
  }
}

Success response body

{
  "id": 271,
  "name": "media_file",
  "common_media_file": false,
  "media_type": "photo",
  "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.png",
  "link_for_additional_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type" (NOTE: add 10/04/24),
  "file_size": "1.18 MB",
  "created_date": "06/20/22",
  "note": null,
  "is_cutout": true,
  "source": "my folder || shared || stock || content request || cutout",
  "s3_key": "S3_KEY" (NOTE: add 16/04/24),
  "additional_version": {
    "id": 272,
    "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type",
    "deleted": false
  } (NOTE: add 17/06/24)
}

Params

Param name Description
folder_id
required

ID of parrent folder

Validations:

  • Must be a Integer

media_file
required

Validations:

  • Must be a Hash

media_file[name]
required

Name of media file

Validations:

  • Must be a String

media_file[s3_key]
required

AWS s3 token

Validations:

  • Must be a String

media_file[format_type]
required

Media File extension

Validations:

  • Must be a String

media_file[media_type]
required

Media type of file

Validations:

  • Must be one of: photo, video.

media_file[size]
required

Media File size

Validations:

  • Must be a Integer

media_file[is_cutout]
optional

Is this file cotout

Validations:

  • Must be one of: true, false, 1, 0.

media_file[origin_id]
optional

ID of origin media_file FOR CUTOUT ONLY

Validations:

  • Must be a Integer