LOloops
Audience segments

Create an audience segment

Changed on

Create a new audience segment.

post/v1/audience-segments

Request

  • Base URL
    https://app.loops.so/api
  • Auth
    HTTP bearer

Request body

namestring required

The name of the audience segment. Must be unique within the team.

descriptionstring

An optional description of the audience segment.

Example request

{
  "name": "Active users",
  "description": "Contacts on the pro plan",
  "filter": {
    "match": "all",
    "conditions": [
      {
        "type": "property",
        "key": "plan",
        "operator": "equals",
        "value": "pro"
      }
    ]
  }
}

Response

Audience segment created.

idstring required

The ID of the audience segment.

namestring required

The name of the audience segment.

descriptionstring nullable required

An optional description of the audience segment.

createdAtstring required

ISO 8601 timestamp for when the audience segment was created.

updatedAtstring required

ISO 8601 timestamp for when the audience segment was last updated.

Example response

{
  "id": "cls6e8g0i2k4m6o8q0s2u4w6",
  "name": "Power users",
  "description": "Contacts on the pro plan",
  "createdAt": "2025-06-29T07:47:39.370Z",
  "updatedAt": "2025-06-29T07:47:39.370Z",
  "filter": {
    "match": "all",
    "conditions": [
      {
        "type": "property",
        "key": "plan",
        "operator": "equals",
        "value": "pro"
      }
    ]
  }
}

Changes

  • ac25499abd64Revision changes
    • breaking

      removed subschema #1 subschema #2 subschema #3 from the /////// request property oneOf list

    • info

      added subschema #1: String subschema #2: Number subschema #3: Date range to the /////// request property oneOf list

  • 74756bcb2e9eRevision changes
    • info

      api operation id createAudienceSegment was added