---
title: "segmentCreate"
description: "Create segment"
doc_type: graphql
doc_category: adminGraphQL
doc_version: v20270301
source_url:
  html: 'https://developer.shopline.com/docs/admin-graph-ql-api/customers/mutations/segment-create'
  md: 'https://developer.shopline.com/docs/admin-graph-ql-api/customers/mutations/segment-create.md'
---
# segmentCreate

Create segment

- **Required Scopes:** `write_customers`
- **API Version:** v20270301
- **API Type:** Admin
- **API Protocol:** GraphQL
- **Operation Type:** Mutation

## Type Signature

`SegmentCreatePayload`

## Required Permissions

* `write_customers`

An access token is required to call this API. Refer to [Authorization](https://developer.shopline.com/docs/apps/api-instructions-for-use/graph-ql-admin-api/overview.md) for more information about how to obtain the token.

## Arguments

* `query`

  [String!](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  segment conditions , json string

* `name`

  [String!](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  segment name

## Returns

* `segment`

  [Segment](https://developer.shopline.com/docs/admin-graph-ql-api/customers/objects/segment.md)

  Segments created

* `userErrors`

  [[BusinessCustomerUserError]](https://developer.shopline.com/docs/admin-graph-ql-api/customers/objects/business-customer-user-error.md)

  Error message

## Code Example

```graphql
mutation segmentCreate($query: String! $name: String! ) {
	segmentCreate(query: $query, name: $name ) 
		 {
			# SegmentCreatePayload fields
		}
		
	}

```

## Variables

```json
{
  "name": {},
  "query": {}
}
```

## Error Handling

For detailed information about common codes, see [Status and error codes](https://developer.shopline.com/docs/apps/api-instructions-for-use/graph-ql-admin-api/overview.md#status-and-error-codes).