Skip to content

Atualizar mensagens agendadas

post

/messages/schedule/update

Use esse endpoint para atualizar mensagens agendadas.

Esse endpoint aceita atualizações do parâmetro schedule ou messages ou de ambos. Sua solicitação deve conter pelo menos uma dessas duas chaves.

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão messages.schedule.update.

Limite de frequência

Aplicamos o limite de frequência padrão da Braze de 250.000 solicitações por hora a esse endpoint, conforme documentado em Limites de frequência da API.

Corpo da solicitação

1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
1
2
3
4
5
6
7
8
9
{
  "schedule_id": (required, string) the `schedule_id` to update (obtained from the response to create schedule),
  "schedule": {
    // optional, see create schedule documentation
  },
  "messages": {
    // optional, see available messaging objects documentation
  }
}

Parâmetros de solicitação

Parâmetro Obrigatório Tipo de dados Descrição
schedule_id Obrigatório String O schedule_id a ser atualizado (obtido da resposta para criar agendamento).
schedule Opcional Objeto Consulte objeto de agendamento.
messages Opcional Objeto Consulte os objetos de envio de mensagens disponíveis.

Exemplo de solicitação

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
curl --location --request POST 'https://rest.iad-01.braze.com/messages/schedule/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "schedule_id": "schedule_identifier",
  "schedule": {
    "time": "2017-05-24T20:30:36Z"
   },
  "messages": {
    "apple_push": {
      "alert": "Updated Message!",
      "badge": 1
    },
    "android_push": {
      "title": "Updated title!",
      "alert": "Updated message!"
    },
    "sms": {
      "subscription_group_id": "subscription_group_identifier",
      "message_variation_id": "message_variation_identifier",
      "body": "This is my SMS body.",
      "app_id": "app_identifier"
    }
  }
}'
New Stuff!