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

Update a webhook

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

A BillionSend API key (bs_…).

Parámetros de ruta
idstring<uuid>obligatorio
Cuerpo de la solicitud
application/json
endpointstring<uri>
longitud máx. 2048
eventsstring[]
mín. 1 elementos
statusstring
Valores permitidos:enableddisabled
inbox_idsstring<uuid>[] | null

BillionSend extension: inbox events and email.received reach this endpoint only for these inboxes of the team (at most 100). null means every inbox. Omitted: unchanged.

máx. 100 elementos
Respuestas
200

Webhook updated

objectstringobligatorio
Valores permitidos:webhook
idstring<uuid>obligatorio
401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
404

Not found

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
422

Validation error

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/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "endpoint": "http://example.com",
  "events": [
    "email.scheduled"
  ],
  "status": "enabled",
  "inbox_ids": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}'
Respuesta
{
  "object": "webhook",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

¿Te ha resultado útil esta página?