PATCH/v1/projects/{projectId}/audiences/{profileId}Try it
Session token
Update the name, description, or audience tags of an existing profile. The slug cannot be changed after creation.
Note
Org membership is required. Being signed in is not enough: you must be a
member of the organization that owns {projectId}. A project you cannot see
returns 404, one you are not a member of returns 403 with the forbidden
code — see Authentication.
accessToken is returned to workspace owners and admins only. It is the
code that unlocks this profile's gated pages, so for a member the field is
left out of the response entirely. Every other field is the same for every role.
Path Parameters
NameDescription
projectId:stringpathRequired
The project ID.
profileId:stringpathRequired
The audience profile ID.
Request Body
All fields are optional. Only provided fields will be updated. slug can't be changed — if you send it, it's ignored.
NameDescription
name:stringbody
Updated display name for the profile, 1–100 characters.
description:stringbody
Updated description, up to 500 characters. Set to null to clear.
audiences:string[]body
Updated array of audience tags, each 1–50 characters. Replaces the existing tags entirely; an empty list is accepted.
Warning
Changing audiences affects all existing tokens for this profile. Clients with old tokens will gain or lose access to pages based on the new tags.
Response
Returns the updated audience profile object.
Errors
Status
Code
When
400
validation_error
A field is out of range; each problem is in details.issues
401
unauthorized
No session token, or an API key
403
forbidden
You're not a member of the project's organization
404
not_found
No profile with this ID in the project (Audience profile not found)