Update an audience

patch

https://api.jasper.ai/v1/audiences/{audienceId}

Update an audience in your workspace. Omitted fields, including fields nested inside coreMessaging, languagePatterns, and contentEngagementPatterns, are not changed. Any list you send replaces the entire existing list, not individual items. Include all items you want to keep, or send [] to clear the list.

Path Params

audienceId

string

required

Body Params

name

string

length ≤ 100

description

string

length ≤ 500

accessLevel

string

enum

Defaults to PRIVATE

Who can access the audience. Defaults to PRIVATE, which in Jasper is visible only to workspace admins (and to API keys). Send PUBLIC to share it with the whole workspace.

Allowed:

useCaseRequirements

array of strings

Replaces the whole list; send [] to clear it.

useCaseRequirements

successIndicators

array of strings

length ≤ 8

At most 8. Replaces the whole list; send [] to clear it.

successIndicators

buyingTriggers

array of strings

Replaces the whole list; send [] to clear it.

buyingTriggers

additionalCharacteristics

array of objects

Replaces the whole list; send [] to clear it.

additionalCharacteristics

coreMessaging

object

contentChecklist

array of objects

Replaces the whole list; send [] to clear it.

contentChecklist

languagePatterns

object

contentEngagementPatterns

object

Responses

400

Bad request. May be missing required inputs or may have badly formatted inputs.

401

Unauthorized access to the workspace.

403

Not allowed to update this audience.

404

Not found. The audience does not exist in your workspace.

409

An audience with this name already exists in the workspace.

500

Internal server error. Unable to update audience.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Audience updated