Skip to main content
POST
/
imports
/
{importId}
/
segments
Creates a segment for an import.
curl --request POST \
  --url https://api.permutive.app/audience-api/v1/imports/{importId}/segments \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "segment",
  "code": "1234",
  "description": "segment description",
  "cpm": 2,
  "categories": [
    "category1"
  ]
}
'
import requests

url = "https://api.permutive.app/audience-api/v1/imports/{importId}/segments"

payload = {
"name": "segment",
"code": "1234",
"description": "segment description",
"cpm": 2,
"categories": ["category1"]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'segment',
code: '1234',
description: 'segment description',
cpm: 2,
categories: ['category1']
})
};

fetch('https://api.permutive.app/audience-api/v1/imports/{importId}/segments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.permutive.app/audience-api/v1/imports/{importId}/segments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'segment',
'code' => '1234',
'description' => 'segment description',
'cpm' => 2,
'categories' => [
'category1'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.permutive.app/audience-api/v1/imports/{importId}/segments"

payload := strings.NewReader("{\n \"name\": \"segment\",\n \"code\": \"1234\",\n \"description\": \"segment description\",\n \"cpm\": 2,\n \"categories\": [\n \"category1\"\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.permutive.app/audience-api/v1/imports/{importId}/segments")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"segment\",\n \"code\": \"1234\",\n \"description\": \"segment description\",\n \"cpm\": 2,\n \"categories\": [\n \"category1\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.permutive.app/audience-api/v1/imports/{importId}/segments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"segment\",\n \"code\": \"1234\",\n \"description\": \"segment description\",\n \"cpm\": 2,\n \"categories\": [\n \"category1\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "<string>",
  "name": "<string>",
  "importId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "cpm": 123,
  "categories": [
    "<string>"
  ]
}
"<string>"
{
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"error": {
"c": "<string>",
"d": {}
}
}

Path Parameters

importId
string<uuid>
required

Import ID

Body

application/json
name
string
required
code
string
required
description
string
cpm
number<double>
categories
string[]

Response

id
string<uuid>
required
code
string
required
name
string
required
importId
string<uuid>
required
updatedAt
string<date-time>
required
description
string
cpm
number<double>
categories
string[]