Skip to main content
POST
/
audiences
/
segments
Create an audience segment
curl --request POST \
  --url https://your_a2_service/audiences/segments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "management_type": "selfmanaged",
  "name": "<string>",
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "approximated_size": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "deprecated_properties": {},
  "description": "<string>",
  "properties": {},
  "updated_at": "2023-11-07T05:31:56Z"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "management_type": "selfmanaged",
  "name": "<string>",
  "no": 123,
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "approximated_size": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "deprecated_properties": {},
  "description": "<string>",
  "properties": {},
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Represents a audience segment entity.

​
management_type
enum<string>
required

The management type of the audience segment

Available options:
selfmanaged,
systemmanaged
​
name
string
required

Name of the audience segment

​
owner_id
string<uuid>
required

Owner ID of the audience segment

​
approximated_size
integer | null

Approximated size of the audience segment.

​
created_at
string<date-time> | null

The date and time the entity was created.

​
deprecated_properties
Deprecated Properties · object

Deprecated properties for the audience segment.

​
description
string | null

Description of the audience segment

​
properties
Properties · object

Properties for the audience segment.

The key is AudienceAttribute.code, and the value can be a list of AudienceAttributeValue.value
​
updated_at
string<date-time> | null

The date and time the entity was last updated.

Response

Successful Response

Represents a audience segment entity.

​
id
string<uuid>
required
​
management_type
enum<string>
required

The management type of the audience segment

Available options:
selfmanaged,
systemmanaged
​
name
string
required

Name of the audience segment

​
no
integer
required
​
owner_id
string<uuid>
required

Owner ID of the audience segment

​
approximated_size
integer | null

Approximated size of the audience segment.

​
created_at
string<date-time> | null

The date and time the entity was created.

​
deprecated_properties
Deprecated Properties · object

Deprecated properties for the audience segment.

​
description
string | null

Description of the audience segment

​
properties
Properties · object

Properties for the audience segment.

The key is AudienceAttribute.code, and the value can be a list of AudienceAttributeValue.value
​
updated_at
string<date-time> | null

The date and time the entity was last updated.