Skip to content

Commit

Permalink
docs: segment names don't need to be url-friendly.
Browse files Browse the repository at this point in the history
  • Loading branch information
@thomasheartman
thomasheartman committed Apr 4, 2022
1 parent 020e94e commit e4c2e88
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions website/docs/api/admin/segments.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,11 +73,11 @@ A segment with the provided name already exists.

Use a JSON object with the following properties to create a new segment.

| Property | Type | Required | Description | Example value |
|---------------|--------------------------------------------|----------|------------------------------------------------|--------------------------------------------------|
| `name` | string | Yes | The name of the segment. Must be URL friendly. | `"mobile-users"` |
| `description` | string | No | A description of the segment. | `"This segment is for users on mobile devices."` |
| `constraints` | list of [constraint objects](#iconstraint) | Yes | The constraints in this segment. | `[]` |
| Property | Type | Required | Description | Example value |
|---------------|--------------------------------------------|----------|----------------------------------|--------------------------------------------------|
| `name` | string | Yes | The name of the segment. | `"mobile-users"` |
| `description` | string | No | A description of the segment. | `"This segment is for users on mobile devices."` |
| `constraints` | list of [constraint objects](#iconstraint) | Yes | The constraints in this segment. | `[]` |

## Get segment by ID

Expand Down

0 comments on commit e4c2e88

Please sign in to comment.