Create a new segment

POST/segmentsCreate a new segment

Request body

application/json

objectCreateSegmentOptions

audience_idstring

The ID of the audience this segment belongs to.

filterobject

Filter conditions for the segment.

namestringrequired

The name of the segment.

Example request

{
  "audience_id": "string",
  "filter": {},
  "name": "string"
}

Responses

objectCreateSegmentResponseSuccess

idstring

The ID of the segment.

objectstring

The object type of the response.

Example response

{
  "id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
  "object": "segment"
}

Examples

curl -X POST 'https://api.resend.com/segments' \
  -H 'Content-Type: application/json' \
  -d '{"audience_id":"string","filter":{},"name":"string"}'

const response = await fetch('https://api.resend.com/segments', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"audience_id":"string","filter":{},"name":"string"}),
});
const data = await response.json();

const response = await fetch('https://api.resend.com/segments', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"audience_id\":\"string\",\"filter\":{},\"name\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.resend.com/segments",
    headers={"Content-Type": "application/json"},
    data='{"audience_id":"string","filter":{},"name":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"audience_id":"string","filter":{},"name":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.resend.com/segments", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.resend.com/segments");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"audience_id\":\"string\",\"filter\":{},\"name\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.resend.com/segments"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"audience_id\":\"string\",\"filter\":{},\"name\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.resend.com/segments")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"audience_id\":\"string\",\"filter\":{},\"name\":\"string\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.resend.com/segments");
request.Content = new StringContent("{\"audience_id\":\"string\",\"filter\":{},\"name\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
  "object": "segment"
}

Search documentation

Emails

Domains

Audiences

Contacts

Receiving Emails

Webhooks

Templates

Broadcasts

Segments

Topics

Contact Properties

Logs

Automations

Events

API keys