Skip to main content
POST
/
api
/
audience
Create a new audience
curl --request POST \
  --url http://localhost:3000/api/audience \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "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"
}

Body

application/json
​
name
string
required

Audience name

Required string length: 3 - 64
​
description
string

Audience description

Maximum string length: 256

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"