SYsynup
Organizing locations

Rename a folder

This API updates the name of an existing folder to a new name.

Important Notes:

  • The new folder name must be unique within your account.
  • Root folders cannot be renamed.
  • The folder being renamed must exist in your account.
  • Special characters in the new name will be converted to underscores (_).
post/locations/folders/rename

Request

Headers

Authorizationstring

API key for authentication

Request body

Example request

{
  "input": {
    "name": "Acme New",
    "oldName": "Acme"
  }
}

Response

Successfully renamed the folder

Example response

{
  "data": {
    "renameFolder": {
      "folder": {
        "accountId": 10072,
        "id": "0e4cc56e-45f8-4058-a713-ead264fa9318",
        "name": "Acme_New"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.