PATCH/v1/subscribers/{id}

Atualizar assinante

Altera tags e atributos do assinante pelo servidor, sem esperar a próxima visita dele ao site. O assinante pode ter até 50 tags e 50 atributos; uma alteração que passe disso é recusada inteira com 422.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokenchaveSecretaoptional

Stored only in this browser for the chaveSecreta security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

idpath · string · uuidrequired

UUID do assinante, o campo id de Listar assinantes.

Request body

application/jsonrequired

tagsarray<string>optional

Substitui todas as tags. [] limpa. Não pode vir junto com add_tags ou remove_tags.

add_tagsarray<string>optional

Tags a acrescentar, até 50.

remove_tagsarray<string>optional

Tags a tirar, até 50.

attributesobjectoptional

Até 50 pares. Mescla chave a chave; valor null apaga a chave. Valores simples (texto até 255 caracteres, número, booleano).

Responses

200application/json

O assinante atualizado.

{
  "id": "0199b2d4-6f1e-7c3a-9b1e-2f4a8c6d0e11",
  "external_id": "user-42",
  "tags": [
    "vip",
    "newsletter",
    "comprou-2026"
  ],
  "attributes": {
    "plano": "anual",
    "pedidos": 7
  },
  "active_devices": 2,
  "created_at": "2026-09-28T14:03:11+00:00"
}

idstring · uuidoptional

UUID do assinante.

external_idstringoptional

ID do usuário no seu sistema, quando informado no login. Pode ser null.

tagsarray<string>optional

active_devicesintegeroptional

Dispositivos com inscrição ativa.

created_atstring · date-timeoptional

attributesobjectoptional

Atributos do assinante, com o tipo original (texto, número ou booleano).

401application/json

Chave ausente, inválida ou revogada.

{
  "message": "Credencial ausente ou inválida."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.

404application/json

Não existe com esse ID neste site.

{
  "message": "Recurso não encontrado."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.

422application/json

Algum campo não passou na validação. errors traz a mensagem de cada campo.

{
  "message": "O campo content.title é obrigatório.",
  "errors": {
    "content.title": [
      "O campo content.title é obrigatório."
    ]
  }
}

messagestringoptional

Primeira mensagem de erro.

errorsobjectoptional

Mensagens por campo. A chave é o caminho do campo com pontos, como content.title ou definition.groups.0.rules.1.op.

429application/json

Limite de requisições excedido. Espere os segundos indicados em Retry-After.

{
  "message": "Muitas requisições. Tente novamente em instantes."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.