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

Update a contact in an audience

PATCH/audiences/{audienceId}/contacts/{id}
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Parámetros de ruta
audienceIdstring<uuid>obligatorio
idstringobligatorio
longitud mín. 1
Cuerpo de la solicitud
application/json
first_namestring | null

First name; null clears it

last_namestring | null

Last name; null clears it

unsubscribedboolean

Global opt-out from all marketing sends

propertiesobject

Custom properties to set (merged); null removes a key

Respuestas
200

Contact updated

objectstringobligatorio
Valores permitidos:contact
idstring<uuid>obligatorio
401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
403

An agent acting for a role below owner and admin tried to lift the recipient's own whole-team opt-out

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/audiences/497f6eca-6276-4993-bfeb-53cbbbba6f08/contacts/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "first_name": "string",
  "last_name": "string",
  "unsubscribed": true,
  "properties": {
    "property1": null,
    "property2": null
  }
}'
Respuesta
{
  "object": "contact",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

¿Te ha resultado útil esta página?