topics
Edit a subscription topic
PUT /v1/topics/{name}
Auth required
api.topics.manage
Edits a topic's display name, description, and default subscription
status, writing the change through to SES. The topic is addressed by
its immutable name (a name in the body is ignored). Git-backed
topics are read-only here (409 conflict) — edit them in the connected
repository. An unknown name is 404 not_found.
Path parameters
name string required The topic's org-unique name (the same identifier GET /v1/topics exposes). An unknown name is 404 not_found.
Request body
Content type: application/json
{
"name": "string",
"display_name": "string",
"description": "string",
"default_subscription_status": "OPT_IN"
}Responses
200 The updated topic application/json
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
404 Resource not found application/problem+json
409 The mutation is rejected by a state rule rather than a bad request — e.g.
editing a git-backed (read-only) definition. The
code is conflict.
application/problem+json 422 Query parameter or path value failed validation application/problem+json
429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The
code is internal_error. The
request_id field can be quoted to SendOps support to investigate.
application/problem+json