Pular para o conteúdo
Esc
↑↓navegar↵abrir⌘Jpré-visualizar

Update a contact

PATCH/contacts/{id}
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Parâmetros de caminho
idstringobrigatório
comprimento mín. 1
Corpo da requisição
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

Respostas
200

Contact updated

objectstringobrigatório
Valores permitidos:contact
idstring<uuid>obrigatório
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
403

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

Not found

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
422

Validation error

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Autorização
Parâmetros
Corpoapplication/json
Requisição
curl -X PATCH 'https://api.billionsend.com/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
  }
}'
Resposta
{
  "object": "contact",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Esta página foi útil?