Skip to main content
POST
/
segments
/
{id}
/
copy
Create a copy of an existing segment
curl --request POST \
  --url https://api.pocketflows.com/segments/{id}/copy \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "id": "<string>",
  "name": "<string>",
  "filter": "<string>",
  "description": "<string>",
  "static_customers": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The ID of the segment

Body

application/json

The body is of type object.

Response

200 - application/json

The copied Segment object

id
string
required

The ID of the segment

name
string
required

The name of the segment

filter
string | null
required

The filter for this segment

description
string | null
required

A Markdown description of the filter

static_customers
string[]

The customers that are always included in this segment