API referenceAudiences

Rename or redescribe an audience

PATCH
/v1/audiences/{id}

Fields omitted from the body keep their current value.

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key sent as Authorization: Bearer <key>. Looked up by SHA-256 hash (email_core::sha256_hex) against api_keys.hash; revoked keys and keys belonging to a suspended tenant are rejected. See the top-level Authentication section for permission levels.

Path Parameters

id*string

Request Body

application/json
  1. body
name?string
description?string

Response Body

Updated.

application/json
  1. response

The response shape from create/patch — omits timestamps (unlike the GET representation).

id?string
name?string
description?string|null
curl -X PATCH "https://example.com/v1/audiences/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "name": "string",  "description": "string"}