Create Audience

Create a new audience for campaigns.

POST/audiences

Request Body

namestringRequired

The name of the audience.

POST /audiences

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

const audience = await emailit.audiences.create({
  name: 'Newsletter',
});

from emailit import EmailitClient
client = EmailitClient("your_api_key")

audience = client.audiences.create({
  "name": "Newsletter"
})

$emailit = Emailit::client('your_api_key');

$audience = $emailit->audiences()->create([
  'name' => 'Newsletter',
]);

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

audience = client.audiences.create(name: "Newsletter")

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

audience, err := client.Audiences.Create(&emailit.CreateAudienceRequest{
  Name: "Newsletter",
})

use emailit::Emailit;
use emailit::types::CreateAudienceParams;

let emailit = Emailit::new("your_api_key");

let audience = emailit.audiences.create(
  CreateAudienceParams::new("Newsletter")
).await?;

import com.emailit.*;
import com.emailit.params.*;

EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject audience = emailit.audiences().create(
  AudienceCreateParams.builder()
    .setName("Newsletter")
    .build()
);

using Emailit;

var emailit = new EmailitClient("your_api_key");

var audience = emailit.Audiences.Create(new AudienceCreateOptions {
  Name = "Newsletter",
});

use Emailit\Laravel\Facades\Emailit;

$audience = Emailit::audiences()->create([
  'name' => 'Newsletter',
]);

curl -X POST https://api.emailit.com/v2/audiences \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Newsletter"
  }'

{
  "object": "audience",
  "id": 1234567890,
  "name": "My Newsletter Audience",
  "token": "aud_abc123def456",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z"
}

{
  "error": {
    "code": 409,
    "message": "Audience already exists"
  },
  "existing": {
    "object": "audience",
    "id": 1234567890,
    "name": "My Newsletter Audience",
    "token": "aud_abc123def456",
    "created_at": "2021-01-01T00:00:00Z",
    "updated_at": "2021-01-01T00:00:00Z"
  }
}

Get Audience

Retrieve details of a specific audience.

GET/audiences/{id}

Path Parameters

idstringRequired

The ID of the audience to retrieve.

GET /audiences/{id}

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

const audience = await emailit.audiences.get('aud_123');

from emailit import EmailitClient
client = EmailitClient("your_api_key")

audience = client.audiences.get("aud_123")

$emailit = Emailit::client('your_api_key');

$audience = $emailit->audiences()->get('aud_123');

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

audience = client.audiences.get("aud_123")

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

audience, err := client.Audiences.Get("aud_123")

use emailit::Emailit;

let emailit = Emailit::new("your_api_key");

let audience = emailit.audiences.get("aud_123").await?;

import com.emailit.*;

EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject audience = emailit.audiences().get("aud_123");

using Emailit;

var emailit = new EmailitClient("your_api_key");

var audience = emailit.Audiences.Get("aud_123");

use Emailit\Laravel\Facades\Emailit;

$audience = Emailit::audiences()->get('aud_123');

curl -X GET https://api.emailit.com/v2/audiences/aud_123 \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json"

{
  "object": "audience",
  "id": 1234567890,
  "name": "My Newsletter Audience",
  "token": "aud_abc123def456",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z"
}

{
  "error": {
    "code": 404,
    "message": "Audience not found"
  }
}

Delete Audience

Delete an audience and all its subscribers.

DELETE/audiences/{id}

Path Parameters

idstringRequired

The ID of the audience to delete.

DELETE /audiences/{id}

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

const audience = await emailit.audiences.delete('aud_123');

from emailit import EmailitClient
client = EmailitClient("your_api_key")

audience = client.audiences.delete("aud_123")

$emailit = Emailit::client('your_api_key');

$audience = $emailit->audiences()->delete('aud_123');

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

audience = client.audiences.delete("aud_123")

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

audience, err := client.Audiences.Delete("aud_123")

use emailit::Emailit;

let emailit = Emailit::new("your_api_key");

let audience = emailit.audiences.delete("aud_123").await?;

import com.emailit.*;

EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject audience = emailit.audiences().delete("aud_123");

using Emailit;

var emailit = new EmailitClient("your_api_key");

var audience = emailit.Audiences.Delete("aud_123");

use Emailit\Laravel\Facades\Emailit;

$audience = Emailit::audiences()->delete('aud_123');

curl -X DELETE https://api.emailit.com/v2/audiences/aud_123 \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json"

{
  "object": "audience",
  "id": 1234567890,
  "name": "My Newsletter Audience",
  "deleted": true
}

{
  "error": {
    "code": 404,
    "message": "Audience not found"
  }
}

Update Audience

Update audience settings and metadata.

POST/audiences/{id}

Path Parameters

idstringRequired

The ID of the audience to update.

Request Body

namestring

The new name for the audience.

PATCH /audiences/{id}

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

const audience = await emailit.audiences.update('aud_123', {
  name: 'Updated',
});

from emailit import EmailitClient
client = EmailitClient("your_api_key")

audience = client.audiences.update("aud_123", {
  "name": "Updated"
})

$emailit = Emailit::client('your_api_key');

$audience = $emailit->audiences()->update('aud_123', [
  'name' => 'Updated',
]);

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

audience = client.audiences.update("aud_123", name: "Updated")

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

audience, err := client.Audiences.Update("aud_123", &emailit.UpdateAudienceRequest{
  Name: "Updated",
})

use emailit::Emailit;
use emailit::types::UpdateAudienceParams;

let emailit = Emailit::new("your_api_key");

let audience = emailit.audiences.update("aud_123", UpdateAudienceParams {
  name: Some("Updated".into()),
  ..Default::default()
}).await?;

import com.emailit.*;
import com.emailit.params.*;

EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject audience = emailit.audiences().update("aud_123",
  AudienceUpdateParams.builder()
    .setName("Updated")
    .build()
);

using Emailit;

var emailit = new EmailitClient("your_api_key");

var audience = emailit.Audiences.Update("aud_123", new AudienceUpdateOptions {
  Name = "Updated",
});

use Emailit\Laravel\Facades\Emailit;

$audience = Emailit::audiences()->update('aud_123', [
  'name' => 'Updated',
]);

curl -X PATCH https://api.emailit.com/v2/audiences/aud_123 \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated"
  }'

{
  "object": "audience",
  "id": 1234567890,
  "name": "Updated Newsletter Audience",
  "token": "aud_abc123def456",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T12:00:00Z"
}

{
  "error": {
    "code": 404,
    "message": "Audience not found"
  }
}

{
  "error": {
    "code": 409,
    "message": "Audience name already exists"
  }
}

List Audiences

Get all audiences in your account.

GET/audiences

Query Parameters

pageinteger

Page number for pagination (minimum: 1).

limitinteger

Number of audiences to return (minimum: 1, maximum: 100).

GET /audiences

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

const audiences = await emailit.audiences.list();

from emailit import EmailitClient
client = EmailitClient("your_api_key")

audiences = client.audiences.list()

$emailit = Emailit::client('your_api_key');

$audiences = $emailit->audiences()->list();

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

audiences = client.audiences.list

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

audiences, err := client.Audiences.List(nil)

use emailit::Emailit;

let emailit = Emailit::new("your_api_key");

let audiences = emailit.audiences.list(None).await?;

import com.emailit.*;

EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject audiences = emailit.audiences().list();

using Emailit;

var emailit = new EmailitClient("your_api_key");

var audiences = emailit.Audiences.List();

use Emailit\Laravel\Facades\Emailit;

$audiences = Emailit::audiences()->list();

curl -X GET https://api.emailit.com/v2/audiences \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json"

{
  "data": [
    {
      "id": 1234567890,
      "name": "My Newsletter Audience",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z"
    },
    {
      "id": 1234567891,
      "name": "Product Updates",
      "created_at": "2021-01-02T00:00:00Z",
      "updated_at": "2021-01-02T00:00:00Z"
    }
  ],
  "next_page_url": "https://api.emailit.com/v2/audiences?page=2&limit=10",
  "previous_page_url": null
}