Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

Update a contact in an audience

PATCH/audiences/{audienceId}/contacts/{id}
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Pfadparameter
audienceIdstring<uuid>erforderlich
idstringerforderlich
min. Länge 1
Request-Body
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

Antworten
200

Contact updated

objectstringerforderlich
Erlaubt:contact
idstring<uuid>erforderlich
401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
403

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
404

Not found

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
422

Validation error

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Parameter
Bodyapplication/json
Anfrage
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
  }
}'
Antwort
{
  "object": "contact",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

War diese Seite hilfreich?