topics

Rename a topic or change its default.

Changing the default never rewrites an answer a contact already gave.

patch/topics/{id}

Request

  • Base URL: https://api.agentisend.com
  • URL: https://api.agentisend.com/topics/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Headers

Idempotency-Keystring

Makes this call safe to retry. Send the same key with the same body and the original response is replayed instead of the work happening twice. Keys are 1-256 characters and are remembered for 7 days. While the first attempt is still running, a second call with that key returns 409 idempotency_in_flight (Resend calls this concurrent_idempotent_requests); the same key with a different body returns 409 idempotency_payload_mismatch (Resend: invalid_idempotent_request). Resend-Idempotency-Key is accepted as the same header.

Resend-Idempotency-Keystring

Alias of Idempotency-Key. Idempotency-Key wins if both are sent.

Request body

idstring

The topic id, as the Resend SDK sends it. Must match the id in the path.

namestring

A new name. Omit it to keep the current one.

descriptionstring nullable

A new description. Null clears it.

default_subscribedboolean

Whether a contact who has never answered receives this topic.

visibility'public' | 'private'

public lists the topic on every preference page. private lists it only for contacts subscribed to it.

Response

Success

object'topic' required
idstring uuid required
namestring required
descriptionstring nullable required
default_subscribedboolean required
default_subscription'opt_in' | 'opt_out' required
visibility'public' | 'private' required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.