Preset_folders

>>>

GET /api/v3/preset_folders
List of preset_folders

Request headers ↑

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

Success response body ↑

[
  {
    "id": 1,
    "name": "Stock folder"
  },
  ...
]

Params

Param name Description
sort_by
optional

Validations:

  • Must be one of: created_at, name.
sort_to
optional

Validations:

  • Must be one of: asc, desc.
>>>

GET /api/v3/preset_folders/:id
Show preset_folder

Request headers ↑

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

Success response body ↑

{
  "id": 1,
  "name": "Stock folder",
  "ancestors": [],
  "folders": [
    {
      "id": 2,
      "name": "Folder in folder"
    },
    ...
  ]
}

Params

Param name Description
id
required

ID of media folder

Validations:

  • Must be a Integer
sort_by
optional

Validations:

  • Must be one of: created_at, name.
sort_to
optional

Validations:

  • Must be one of: asc, desc.
>>>

POST /api/v3/preset_folders
Create preset_folder

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 ↑

{
  "preset_folder": {
    "name": "Postman Folder",
    "ancestry": "23"
  }
}

Success response body ↑

{
  "id": 3,
  "name": "Postman folder"
}

Params

Param name Description
preset_folder
required

Validations:

  • Must be a Hash
preset_folder[name]
required

Name of preset folder

Validations:

  • Must be a String
preset_folder[ancestry]
optional

ID of parrent folder

Validations:

  • Must be a String
>>>

PUT /api/v3/preset_folders/:id
Update preset_folder

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 ↑

{
  "preset_folder": {
    "name": "Postman Folder"
  }
}

Success response body ↑

{
  "id": 3,
  "name": "Updated Postman folder"
}

Params

Param name Description
id
required

ID of preset folder

Validations:

  • Must be a Integer
preset_folder
required

Validations:

  • Must be a Hash
preset_folder[name]
required

Name of preset folder

Validations:

  • Must be a String
preset_folder[ancestry]
required , nil allowed

ID of parrent folder

Validations:

  • Must be a String
>>>

DELETE /api/v3/preset_folders/:id
Delete media_folder

Request headers ↑

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

Success response body ↑

{
  "success": true
}

Params

Param name Description
id
required

ID of preset folder

Validations:

  • Must be a Integer
>>>

POST /api/v3/preset_folders/:id/share_with_team
Share with team

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 ↑

{
  "team_ids": [2, 3, ...]
}

Success response body ↑

{
  "success": true
}

Params

Param name Description
id
required

ID of preset folder

Validations:

  • Must be a Integer
team_ids
required , nil allowed

Array of Team IDs

Validations:

  • Must be an array of Integer
>>>

POST /api/v3/preset_folder/bulk_share_with_team
Bulk share with team

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 ↑

{
  "preset_ids": [1, 2, ...],
  "preset_folder_ids": [3, 4, ...],
  "team_ids": [2, ...]
}

Success response body ↑

{
  "success": true
}

Params

Param name Description
preset_ids
optional

Validations:

  • Must be an array of Integer
preset_folder_ids
optional

Validations:

  • Must be an array of Integer
team_ids
required , nil allowed

Validations:

  • Must be an array of Integer
>>>

PUT /api/v3/preset_folders/move
Move folder to other folder

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 ↑

{
  "preset_folder_ids": [2, 3, ...],
  "preset_folder": {
    "ancestry": "34"
  }
}

Success response body ↑

{
  "success": true
}

Params

Param name Description
preset_folder_ids
required

Array of IDs of folders should be moved

Validations:

  • Must be an array of Integer
preset_folder
required

Validations:

  • Must be a Hash
preset_folder[ancestry]
required , nil allowed

Id of parant folder

Validations:

  • Must be a String
>>>

DELETE /api/v3/preset_folders/bulk_destroy
Delete folders

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 ↑

{
  "preset_folder_ids": [4, 5, ...],
  "preset_ids": [3, 4, ...]
}

Success response body ↑

{
  "success": true
}

Params

Param name Description
preset_folder_ids
required

Array of IDs of preset folders should be deleted

Validations:

  • Must be an array of Integer
preset_ids
required

Array of IDs of presets should be deleted

Validations:

  • Must be an array of Integer