Skip to main content
PUT
/
api
/
audience
/
{id}
Update audience
curl --request PUT \
  --url http://localhost:3000/api/audience/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Audience Name",
  "description": "Updated description"
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "VIP Customers",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "description": "High-value customers for priority campaigns"
}

Path Parameters

id
string
required

Audience UUID

Body

application/json
name
string
Example:

"Updated Audience Name"

description
string
Example:

"Updated description"

Response

id
string
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

organizationId
string
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

name
string
required
Example:

"VIP Customers"

createdAt
string<date-time>
required
Example:

"2024-01-01T00:00:00.000Z"

updatedAt
string<date-time>
required
Example:

"2024-01-01T00:00:00.000Z"

description
string | null
Example:

"High-value customers for priority campaigns"