이메일 템플릿 생성
post
/templates/email/create
이 엔드포인트를 사용하여 Braze 대시보드에서 이메일 템플릿을 만들 수 있습니다.
이러한 템플릿은 템플릿 및 미디어 페이지에서 사용할 수 있습니다. 이 엔드포인트의 응답에는 후속 API 호출에서 템플릿을 업데이트하는 데 사용할 수 있는 필드에 대한 email_template_id
필드가 포함됩니다.
사용자의 이메일 구독 상태는 RESTful API를 사용하여 Braze를 통해 업데이트하고 검색할 수 있습니다. API를 사용하여 Braze와 다른 이메일 시스템 또는 자체 데이터베이스 간의 양방향 동기화를 설정할 수 있습니다. 모든 API 요청은 HTTPS를 통해 이루어집니다.
필수 구성 요소
이 엔드포인트를 사용하려면 templates.email.create
권한이 있는 API 키가 필요합니다.
사용량 제한
요청 본문
1
2
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
1
2
3
4
5
6
7
8
9
{
"template_name": (required, string) The name of your email template,
"subject": (required, string) The email template subject line,
"body": (required, string) The email template body that may include HTML,
"plaintext_body": (optional, string) A plaintext version of the email template body,
"preheader": (optional, string) The email preheader used to generate previews in some clients,
"tags": (optional, Array of Strings) Tags must already exist,
"should_inline_css": (optional, Boolean) If `true`, the `inline_css` feature is used on this template.
}
요청 매개변수
매개변수 | 필수 | 데이터 유형 | 설명 |
---|---|---|---|
template_name |
필수 | 문자열 | 이메일 템플릿의 이름입니다. |
subject |
필수 | 문자열 | 이메일 템플릿 제목. |
body |
필수 | 문자열 | HTML을 포함할 수 있는 이메일 템플릿 본문입니다. |
plaintext_body |
선택 사항 | 문자열 | 이메일 템플릿 본문의 일반 텍스트 버전입니다. |
preheader |
선택 사항 | 문자열 | 일부 클라이언트에서 미리보기를 생성하는 데 사용되는 이메일 프리헤더입니다. |
tags |
선택 사항 | 문자열 | 태그가 이미 존재해야 합니다. |
should_inline_css |
선택 사항 | 부울 | 템플릿별로 inline_css 기능을 사용하거나 사용하지 않도록 설정합니다. 제공하지 않으면 Braze는 앱 그룹에 대한 기본 설정을 사용합니다. true 또는 false 중 하나가 예상됩니다. |
요청 예시
1
2
3
4
5
6
7
8
9
10
11
curl --location --request POST 'https://rest.iad-01.braze.com/templates/email/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
"template_name": "email_template_name",
"subject": "Welcome to my email template!",
"body": "This is the text within my email body and https://www.braze.com/ here is a link to Braze.com.",
"plaintext_body": "This is the text within my email body and here is a link to https://www.braze.com/.",
"preheader": "My preheader is pretty cool.",
"tags": ["Tag1", "Tag2"]
}'
발생 가능한 오류
다음 표에는 해당하는 경우 반환될 수 있는 오류 및 관련 문제 해결 단계가 나와 있습니다.
오류 | 문제 해결 |
---|---|
템플릿 이름은 필수 항목입니다. | 템플릿 이름을 입력합니다. |
태그는 배열이어야 합니다. | 태그의 형식은 문자열 배열로 지정해야 합니다(예: ["marketing", "promotional", "transactional"] ). |
모든 태그는 문자열이어야 합니다. | 태그가 따옴표로 묶여 있는지 확인합니다("" ). |
일부 태그를 찾을 수 없습니다. | 이메일 템플릿을 만들 때 태그를 추가하려면 해당 태그가 이미 Braze에 존재해야 합니다. |
이메일에는 유효한 콘텐츠 블록 이름이 있어야 합니다. | 이메일에 이 환경에 존재하지 않는 콘텐츠 블록이 포함되어 있을 수 있습니다. |
should_inline_css 에 대한 잘못된 값입니다. true 또는 false 중 하나가 예상되었습니다. |
이 매개변수는 부울 값(참 또는 거짓)만 허용합니다. should_inline_css 값이 따옴표("" )로 묶이지 않았는지 확인하여 값이 문자열로 대신 전송되도록 합니다. |
New Stuff!