SmartMatchApp

Update Folder

Update the details of a specific folder associated with a client.

This endpoint updates the details of a specific folder associated with a client.

You can change the folder's name and/or move it to a different parent folder.

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

parent: The ID of the new parent folder. If provided as an empty value, the folder will be removed from its current parent.

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

Example Success Response:
HTTP 204 No Content
Base Request:

Method: PUT

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 parent field must be a valid folder ID or empty, and the name field cannot be empty.
Possible errors: "select a valid choice", "this field cannot be empty"
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 folder with the specified ID does not exist.
Possible errors: "object does not exist"
405 Method Not Allowed

This error occurs if an HTTP method other than PUT is used (e.g., POST or GET).
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"