Folders

Rename a folder

Renames a folder. List folders (contactList/companyList) resolve by id alone; pass ?type=campaign or ?type=agent to rename a campaign or agent folder, which live in their own services. The new name must be unused among folders of the same kind (409 FOLDER_NAME_TAKEN). The response is the rename echo — the folder's id and its new name.

Errors:

  • 404 FOLDER_NOT_FOUND — No folder with that id (of the routed kind) belongs to the token owner.
  • 409 FOLDER_NAME_TAKEN — Another folder of the same kind already has that name.
  • 400 INVALID_REQUEST — campaign/agent kinds only: the owning service rejected the request.
  • 422 VALIDATION_FAILED — folderId not a 24-hex id, name missing/blank/over 120 characters, or type outside the enum.
  • 429 RATE_LIMITED — The lists rate bucket (120 requests/minute, 10,000/day per token owner) is exhausted, or the owning service (campaign/agent folders) refused the call.

Requires one of the following token scopes: lists.

patch/business/folders/{folderId}

Request

  • Base URL: https://api.tryfuse.ai/api/v1
  • URL: https://api.tryfuse.ai/api/v1/business/folders/{folderId}
  • Auth: HTTP basic

Path parameters

folderIdstring required

24-character hex id of the folder (from GET /business/folders).

Query parameters

type'contactList' | 'companyList' | 'campaign' | 'agent'

Kind of the folder being changed: required as campaign or agent for those folder kinds; omit (or pass contactList/companyList) for a list folder, which resolves by id alone.

Request body

namestring required

New folder name (1-120 characters); a name already used by another folder of the same kind answers 409 FOLDER_NAME_TAKEN.

Response

Success

Changes

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