예약된 API 트리거 캔버스 업데이트
이 엔드포인트를 사용하여 대시보드에서 생성된 예약된 API 트리거 캔버스를 업데이트할 수 있습니다.
이를 통해 어떤 작업을 트리거하여 메시지를 전송할지 결정할 수 있습니다. 메시지 자체에 템플릿이 지정된 trigger_properties
를 전달할 수 있습니다.
이 엔드포인트로 메시지를 보내려면 캔버스를 만들 때 생성한 캔버스 ID가 있어야 합니다.
모든 일정은 일정 만들기 요청 또는 이전 업데이트 일정 요청에서 제공한 일정을 완전히 덮어씁니다.
- 예를 들어, 원래
"schedule" : {"time" : "2015-02-20T13:14:47", "in_local_time" : true}
를 제공한 다음 업데이트에서"schedule" : {"time" : "2015-02-20T14:14:47"}
를 제공하는 경우 이제 사용자의 현지 시간이 아닌 UTC로 제공된 시간에 메시지가 전송됩니다. - 전송 예정 시간에 매우 인접하거나 전송되어야 하는 시간 동안 업데이트되된 예약된 트리거는 최선의 노력으로 업데이트되므로 마지막 순간에 변경 사항이 대상 사용자 전체, 일부 또는 전혀 적용되지 않을 수 있습니다.
필수 구성 요소
이 엔드포인트를 사용하려면 canvas.trigger.schedule.update
권한이 있는 API 키가 필요합니다.
사용량 제한
요청 본문
1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
1
2
3
4
5
6
7
{
"canvas_id": (required, string) see Canvas identifier,
"schedule_id": (required, string) the `schedule_id` to update (obtained from the response to create schedule),
"schedule": {
// required, see create schedule documentation
}
}
요청 매개변수
매개변수 | 필수 | 데이터 유형 | 설명 |
---|---|---|---|
canvas_id |
필수 | 문자열 | 캔버스 식별자를 참조하세요. |
schedule_id |
선택 사항 | 문자열 | 업데이트할 schedule_id (일정 만들기 응답에서 얻은 값)입니다. |
schedule |
필수 | 객체 | 일정 개체를 참조하세요. |
요청 예시
1
2
3
4
5
6
7
8
9
10
11
curl --location --request POST 'https://rest.iad-01.braze.com/canvas/trigger/schedule/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
"canvas_id": "canvas_identifier",
"schedule_id": "schedule_identifier",
"schedule": {
"time": "2017-05-24T21:30:00Z",
"in_local_time": true
}
}'
New Stuff!