변수 예문 사전

템플릿 미리보기에 쓰는 채널별 변수 예문을 갱신합니다. 채널마다 표시용 예문​​을 등록하면 #{user_name} 같은 자리표시자가 미리보기에서 홍길동처럼 표시됩니다.

발송값이 아닙니다

여기 등록한 값은 화면 표시 전용입니다. 카카오로 전송되지 않고 검수 상태에도 영향을 주지 않습니다. 실제로 나가는 값은 발송의 variables입니다.

PUThttps://message.bootapi.com/alimtalk/senders/{ksp_id}/variable_examplesBasic Auth

요청 파라미터

파라미터 타입 필수 설명
ksp_id String 필수 채널 id (경로 파라미터)
examples Object 선택 변수명 → 예문 매핑. 비우면 아무것도 바꾸지 않고 현재 사전을 돌려줍니다. 키에 . 이나 선행 $ 는 쓸 수 없습니다

보낸 키만 덮어쓰는 부분 갱신​​입니다. 기존에 있던 다른 변수의 예문은 그대로 남습니다. 한 채널 안에서는 같은 변수에 같은 예문이 적용됩니다. 값을 빈 문자열로 보내면 무시되므로, 이 API로 예문을 지울 수는 없습니다. . 이 들어가거나 $ 로 시작하는 키도 오류 없이 버려집니다.

코드 예제

curl -X PUT "https://message.bootapi.com/alimtalk/senders/6a718d6cdd5558fb1fff72af/variable_examples" \
  -H "Authorization: Basic {base64(client_key:secret_key)}" \
  -H "Content-Type: application/json" \
  -d '{
    "examples": {
      "user_name": "홍길동",
      "company_name": "부트페이몰"
    }
  }'bash

응답

갱신된 사전 전체를 돌려줍니다.

{
  "ksp_id": "6a718d6cdd5558fb1fff72af",
  "variable_examples": {
    "user_name": "홍길동",
    "company_name": "부트페이몰",
    "order_number": "20260827-0001"
  }
}json

에러 코드

코드 error_code 메시지 대처 방법
3024 SENDER_NOT_LINKED 발신프로필 미연결 이 프로젝트에 연동된 채널인지 채널 목록에서 확인합니다
템플릿 응답에도 함께 나옵니다

공식 템플릿과 자체 템플릿 응답의 variable_examples가 이 사전을 반영한 값입니다. 공식 템플릿은 조회할 때 ksp_id를 함께 넘기면 그 채널 기준으로 채워지고, 자체 템플릿은 소속 채널의 사전이 자동으로 적용됩니다.

함께 보기