Skip to main content
PATCH
Update a folder
PATCH /v1/folder/{folder_id} requires Folders: Write (link_groups.update). Send only fields that should change; omitted fields and rules are preserved.
The endpoint accepts the same optional configuration fields as Create a folder. Send password: null to remove protection, an empty targeting-rule array to clear that rule category, exp_clicks_rule: null to clear click expiration, and empty tag_ids or pixel_ids arrays to detach all of that resource. A successful update returns the complete folder in 200 OK. A duplicate name returns 409 folder_name_taken, an occupied alias returns 409 alias_taken, and an empty or unknown-field payload returns 422 validation_error.

Shared API behavior

Authentication is workspace-scoped; see Authentication. Errors use the standard envelope and request IDs described in Errors, and requests are subject to Rate limits.

Authorizations

Authorization
string
header
required

A workspace API key beginning with biqli_.

Path Parameters

folder
string
required
Pattern: ^biq_fld_[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json
name
string
Required string length: 3 - 250
description
string | null
Maximum string length: 250
alias
string | null
domain_id
string | null
Pattern: ^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$
active
boolean
rotator
boolean
password
string | null
Maximum string length: 250
activates_at
string<date-time> | null
expires_at
string<date-time> | null
utm
string | null
Maximum string length: 2000
allow_search_engine_indexing
boolean
geo_rules
object[]
Maximum array length: 100
device_rules
object[]
Maximum array length: 100
platform_rules
object[]
Maximum array length: 100
exp_clicks_rule
null | object
tag_ids
string[]
Maximum array length: 100
pixel_ids
string[]
Maximum array length: 100

Response

Updated folder.

folder
object
required
status
string
required
Allowed value: "success"