/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Update Audience Profile

Update Audience Profile

Update an existing audience profile

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

StatusCodeWhen
400validation_errorA field is out of range; each problem is in details.issues
401unauthorizedNo session token, or an API key
403forbiddenYou're not a member of the project's organization
404not_foundNo profile with this ID in the project (Audience profile not found)
Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl -X PATCH https://api.syntext.dev/v1/projects/proj_abc123/audiences/aud_xyz789 \
-H "Authorization: Bearer $SYNTEXT_JWT" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme Corp (Enterprise)",
"audiences": ["otc", "virtual-accounts", "transfers"]
}'
Responseapplication/json
json
{
"data": {
"id": "8d0c6a1e-2f4b-4c3d-9e7a-5b1f0a2c3d4e",
"projectId": "3f2b8c1e-6a4d-4e9b-9c7a-1d2e3f4a5b6c",
"name": "Acme Corp (Enterprise)",
"slug": "acme-corp",
"description": "Enterprise partner with OTC and VA access",
"audiences": ["otc", "virtual-accounts", "transfers"],
"lastUsedAt": "2026-03-19T08:12:00Z",
"createdAt": "2026-01-15T10:30:00Z",
"updatedAt": "2026-03-20T14:45:00Z"
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext