Update an audience

PUT /v1/admin/email/audiences/{id}

• Operation ID: updateEmailAudience
• Tags: Email audiences
• Base URL: http://localhost:8787

Workflow: Integration guide.

Authentication: staff Bearer JWT with permission email.write.

Authentication

• Auth: staff Bearer JWT (Authorization: Bearer <access_token>) with the permissions below.
• Required permissions: email.write

Parameters

Name	In	Type	Required	Description
id	path	string<uuid>	yes	-

Request body

Required: yes.

Content type: application/json

Schema: object

Field	Type	Required	Description
name	string	yes	Min length: 1. Max length: 200
kind	string	yes	One of: "static", "dynamic"
filter	object | null	no	-
filter.q	string	no	Min length: 1. Max length: 200
filter.status	string	no	One of: "active", "banned", "deleted"
filter.tier	string	no	Min length: 1. Max length: 32
filter.role	string	no	Min length: 1. Max length: 48
filter.provider	string	no	Min length: 1. Max length: 32
filter.has_subscription	boolean	no	-
filter.created_from	string<date-time>	no	-
filter.created_to	string<date-time>	no	-
filter.last_seen_from	string<date-time>	no	-
filter.last_seen_to	string<date-time>	no	-

Responses

200

Audience updated.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (EmailAudienceId)

Field	Type	Required	Description
id	string<uuid>	yes	-

Errors

400

Request validation failed.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ValidationErrorBody)

Field	Type	Required	Description
success	boolean	yes	One of: false
error	object	yes	-
error.name	string	yes	One of: "ZodError"
error.issues	object[]	yes	-
error.issues[].code	string	yes	-
error.issues[].path	(string | number)[]	yes	-
error.issues[].message	string	yes	-

Request validation

{
  "success": false,
  "error": {
    "name": "ZodError",
    "issues": [
      {
        "code": "custom",
        "path": [
          "field"
        ],
        "message": "Invalid value"
      }
    ]
  }
}

401

Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody)

Field	Type	Required	Description
error	string	yes	Stable machine-readable error code, e.g. forbidden, not_found.
details	any	no	Optional structured context. For 403 it is { perm }.

Error response

{
  "error": "missing_token"
}

403

Authenticated but lacking the required permission. details.perm lists the accepted permission keys.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "forbidden",
  "details": {
    "perm": "email.write"
  }
}

404

audience: no such audience.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "audience"
}

422

invalid_state: rejected by the database function.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "invalid_state"
}

500

Unexpected server error (internal). No details are returned.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "internal"
}

Examples

curl

curl -X PUT 'http://localhost:8787/v1/admin/email/audiences/3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"name":"example","kind":"static","filter":{"q":"example","status":"active","tier":"example","role":"example","provider":"example","has_subscription":false,"created_from":"2026-01-15T12:00:00.000Z","created_to":"2026-01-15T12:00:00.000Z","last_seen_from":"2026-01-15T12:00:00.000Z","last_seen_to":"2026-01-15T12:00:00.000Z"}}'

TypeScript

const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/admin/email/audiences/3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90", {
  method: "PUT",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "example",
    "kind": "static",
    "filter": {
      "q": "example",
      "status": "active",
      "tier": "example",
      "role": "example",
      "provider": "example",
      "has_subscription": false,
      "created_from": "2026-01-15T12:00:00.000Z",
      "created_to": "2026-01-15T12:00:00.000Z",
      "last_seen_from": "2026-01-15T12:00:00.000Z",
      "last_seen_to": "2026-01-15T12:00:00.000Z"
    }
  }),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();