Skip to main content
POST
Update audience
Use this endpoint to rename or describe an existing audience, or soft-delete it.

Endpoint

POST /audience/update Content-Type: application/json Authentication: Required (workspace auth)

Request Body

Rename / describe

Soft-delete

Audience Status Codes

Response

When status: 2 is passed:

Error Cases

Example cURL

Headers

token
string
required

API token for authentication

Body

application/json
audience_id
integer
required

ID of the audience to update

audience_name
string

New name. Must be unique within the workspace. Ignored when status is 2.

description
string

New description

status
enum<integer>

Set to 2 to soft-delete the audience. 0=Inactive, 1=Active, 2=Deleted.

Available options:
0,
1,
2

Response

Audience updated or deleted successfully

message
string
data
object