SmartMatchApp

Create Folder

Create a new folder within a specific client's directory.

This endpoint creates a new folder within a specific client's directory. You can set the folder's name and specify its parent folder.

Example Request:
curl "https://<your-agency>.smartmatchapp.com/api3/clients/<client_id>/folders/" \
    -u <token>: \
    -X POST \
    -F name="New Folder" \
    -F parent=1
Request Parameters:

name: The name of the new folder. This field cannot be empty.

parent: The ID of the parent folder under which the new folder will be created. This field is optional. If not provided, the folder will be created at the root level.

Example Success Response:
HTTP 204 No Content
Base Request:

Method: POST

Authentication: Basic Authentication. Requires a valid <token> passed.

Rate Limits:

10 requests within 10 seconds

Error Responses:
400 Bad Request

This error occurs if the form data provided is invalid. The name field cannot be empty, and the parent field must be a valid folder ID if provided.
Possible errors: "this field cannot be empty", "select a valid choice"
401 Unauthorized

This error occurs when the <token> is missing, invalid, or the API access is disabled.

Possible errors: "not authenticated" or "token is disabled" or "Agency API is disabled"
404 Not Found

This error occurs if the client or the specified parent folder does not exist.
Possible errors: "object does not exist"
405 Method Not Allowed

This error occurs if an HTTP method other than POST is used (e.g., GET or PUT).
Possible errors: "wrong method"
429 Too Many Requests

This error occurs when the client has sent too many requests in a given amount of time, leading to rate limiting by the server.

Possible errors: "too many requests"
500 Server Error

Possible errors: "Internal server error"