Skip to content

Atualizar objeto personalizado

patch

/custom_objects/objects/{type_name}/{external_id}

Use este endpoint para mesclar atributos em um objeto personalizado existente.

Pré-requisitos

Para usar este endpoint, você precisa de uma chave de API com a permissão custom_objects.update.

Limite de frequência

Este endpoint está no bucket de escrita de Custom Objects, com um limite padrão de 50 requisições por minuto.

Parâmetros de caminho

A tabela a seguir lista e descreve os parâmetros de caminho para o endpoint /custom_objects/objects/{type_name}/{external_id}.

Parâmetro Obrigatório Tipo de dados Descrição
type_name Obrigatório String Nome de máquina do tipo de objeto personalizado
external_id Obrigatório String Identificador do objeto

Parâmetros de requisição

A tabela a seguir lista e descreve os parâmetros do corpo da requisição JSON para o endpoint /custom_objects/objects/{type_name}/{external_id}.

Parâmetro Obrigatório Tipo de dados Descrição
attributes Obrigatório Objeto Campos de nível superior para mesclar
display_name Opcional String Rótulo de exibição do objeto. Quando o tipo possui um campo de origem para o nome de exibição, o valor desse campo tem prioridade. Quando omitido, o nome de exibição existente é preservado

Exemplo de requisição

Esta seção inclui um exemplo de carga útil JSON e um exemplo de requisição cURL.

Exemplo de carga útil da requisição

1
2
3
4
5

{
  "attributes": {
    "credits": 750
  }
}

Exemplo de requisição cURL

Este exemplo atualiza o atributo credits em acct-123 e deixa os demais atributos do registro inalterados.

1
2
3
4

curl --location --request PATCH 'https://rest.iad-01.braze.com/custom_objects/objects/account/acct-123' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{ "attributes": { "credits": 750 } }'

Resposta

Esta seção inclui um exemplo de resposta bem-sucedida e os campos da resposta.

Exemplo de resposta bem-sucedida

O código de status 200 pode retornar o seguinte corpo de resposta. O objeto attributes reflete o resultado da mesclagem.

1
2
3
4
5
6
7

{
  "custom_object": {
    "type_name": "account",
    "external_id": "acct-123",
    "attributes": { "name": "Acme", "credits": 750 }
  }
}

Parâmetros de resposta

A tabela a seguir lista e descreve os campos em uma resposta bem-sucedida.

Parâmetro Obrigatório Tipo de dados Descrição
custom_object Obrigatório Objeto Registro do objeto personalizado atualizado
custom_object.type_name Obrigatório String Nome de máquina do tipo de objeto personalizado
custom_object.external_id Obrigatório String Identificador do objeto personalizado
custom_object.attributes Obrigatório Objeto Atributos do objeto após a mesclagem

Erros

A tabela a seguir lista os erros comuns para este endpoint e como resolvê-los.

Status Causa Orientação
400 Erro de validação Confirme se todos os campos em attributes existem no esquema do tipo e usam o tipo de dados correto.
404 Tipo não encontrado ou objeto não encontrado Confirme se type_name e external_id existem no espaço de trabalho.
401 Chave da API REST ausente ou inválida Verifique se o cabeçalho Authorization usa Bearer YOUR_REST_API_KEY e se a chave está ativa.
403 A chave de API não tem permissão ou a requisição está bloqueada pela lista de permissões Confirme se a chave possui custom_objects.update e se o IP de origem está na lista de permissões da chave, se configurado.
429 Limite de frequência excedido Tente novamente após X-RateLimit-Reset e reduza a frequência das requisições.
New Stuff!