API ReferenceFolder Actions

Create a Background Folder

GA
Create a new background image folder. This folder will appear in your organization's library.

Headers

x-api-keystringRequired
Your organization's active API Key.

Request

This endpoint expects an object.
namestringRequired
A descriptive title for the background image folder you'd like to create.
organization_idstringRequiredformat: "uuid"
Your organization's unique identifier.
typestringRequired
For the creation of background folders, this value should always be 'BACKGROUND'.
created_bystringOptional
The email of the user creating the folder. If this parameter is left empty, the value will default to 'API'.

Response

201 - Folder creation successful

namestring
The descriptive title of the background image folder you've successfully created.
display_namestring
The title of the background image folder you've successfully created as it appears within your organization's library.
organization_idstringformat: "uuid"
Your organization's unique identifier.
created_bystring
The email of the user creating the folder. If this parameter is left empty, the value will default to 'API'.
typestring
The type of folder created within your organization's library. For background folders, this value will always be 'BACKGROUND.'
idstringformat: "uuid"
The folder id of the folder created within your organization's library.
created_atdatetime
The date and time at which this folder was originally created within your organization's library.
updated_atdatetime
The date and time at which this folder was last updated within your organization's library.
deleted_atdatetime
The date and time at which this folder was deleted within your organization's library. This value will always be null for newly created folders.

Errors

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error