Skip to main content
PATCH
Rename a folder

Authorizations

Authorization
string
header
required

Your API token (af_…) as the Basic-auth username, with an empty password.

Path Parameters

folderId
string
required

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

Query Parameters

type
enum<string>

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.

Available options:
contactList,
companyList,
campaign,
agent

Body

application/json
name
string
required

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

Required string length: 1 - 120

Response

Success

folder
object
required