Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

Update a topic

PATCH/topics/{id}
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Parámetros de ruta
idstring<uuid>obligatorio
Cuerpo de la solicitud
application/json
namestring
longitud mín. 1
descriptionstring
visibilitystring
Valores permitidos:privatepublic
domain_idstring<uuid> | null

BillionSend extension: id of one of your domains. The topic then appears only on that domain's unsubscribe page, and a send with this topic_id must come from that domain (422 otherwise). null or omitted: a topic of the whole team, shown for every domain. On update, null makes the topic a team-wide one again.

Respuestas
200

Topic updated

idstring<uuid>obligatorio
401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
403

A key held to one domain bound this to another domain, or unbound it

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
404

Not found

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
422

Validation error, or a domain_id that is not one of your domains

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Parámetros
Cuerpoapplication/json
Solicitud
curl -X PATCH 'https://api.billionsend.com/topics/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "description": "string",
  "visibility": "private",
  "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c"
}'
Respuesta
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

¿Te ha resultado útil esta página?