Kakao Moment

Ad creation: Personalized message creative

This document describes how to use the Personalized message creative APIs.

Before you begin

Caution

You cannot create the below creatives with Open APIs:

Creatives in PREMIUM_VIDEO_MESSAGE type.
Creatives including CouponBookAssetGroup.

You cannot use images and texts that do not fit the message guideline.

Common guide

Promotion image

Name	Description
Format	JPG, JPEG, PNG
Size	Recommended: 800x400, 800x800, 800x600 pixels Images less than 80 pixels wide cannot be used.
File size	Less than 10MB
Ratio	Recommended: 2:1, 1:1, 4:3 Images with an aspect ratio greater than 1:2.5 are not allowed.

Promotion text

A maximum of 1,000 characters including variables can be entered. However, after variable substitution, the guide for each message type and area must be followed when requesting delivery.

Button

A maximum of 1,000 characters including variables can be entered. However, after variable substitution, the button name must be within 8 characters when requesting delivery.

Component guide

Required component

Component	Default text	Wide image	Wide list
Promotion image	Not required	Either one required	One of list 1 to 3 is required
Promotion text	Required	Required	-
Button 1	Not required	Not required	Not required
Button 2	Not required	Not required	Not required
List 1 Promotion title	-	-	Not required
List 2,3 Promotion title	-	-	Required

* The 4th and 5th list for Wide list type is optional. If used, a promotion image, promotion text, and promotion title are required.

Component specification

Component	Default text	Wide image	Wide list
Promotion image	Fixed URL or variable value	Fixed URL or variable value	Fixed URL or variable value
Promotion text	After converting the variable value, Maximum 400 characters without an image Maximum 300 characters with an image Link input not allowed, newlines allowed (Maximum: 29 newlines)	After converting the variable value, Maximum 76 characters Link input not allowed, only 1 newline allowed	-
Button 1, 2	After converting the variable value, Maximum 8 characters including spaces	After converting the variable value, Maximum 8 characters including spaces	After converting the variable value, Maximum 8 characters including spaces
List title	-	-	After converting the variable value, Maximum 20 characters No newline
Promotion text for list 1	-	-	After converting the variable value, Maximum 25 characters No newline
Promotion text for list 2,3	-	-	After converting the variable value, Maximum 30 characters No newline

* The 4th and 5th list for Wide list type is optional, the specification is the same as list 2 or 3 when used.

Landing

Component	Default text	Wide image	Wide list
Promotion image	Landing not possible	Same as the landing set for button 1	Same as the landing set for button 1
Promotion text	Landing not possible	Landing not possible	-
Button 1	URL, post, coupon	URL, post, coupon	URL, post, coupon
Button 2	URL, post, coupon, Ad view, Business form	URL, post, coupon, Ad view, Business form	URL, post, coupon, Ad view, Business form
List title	-	-	Landing not possible
Promotion text for list 1,2,3	-	-	Same as the landing set for the Promotion image on each text

Variable field name

You can use the variables below when to request creating or sending creatives. You must use each field name with a specific number. (Example: ${brand_name1})

Caution

You cannot create or send a personalized message including not valid variables.
You cannot request send messages with values do not meet the guideline.
Note that your advertisement operations, such as the ad account, may be penalized when you try to send personalized messages, including illegal private information, or use variables that may cause inconvenience to the recipient.

No.	Data	Field name	Pattern
1	Date	`date`	`${date1}` ~ `${date4}`
2	Site name	`site_name`	`${site_name1}`
3	Brand name	`brand_name`	`${brand_name1}`
4	User name	`user_name`	`${user_name1}`
5	User ID	`user_id`	`${user_id1}`
6	User rating	`user_rating`	`${user_rating1}`
7	Available point	`available_point`	`${available_point1}`
8	Number of coupons	`available_coupon`	`${available_coupon1}`
9	Product ID	`product_id`	`${product_id1}` ~ `${product_id7}`
10	Product name	`product_name`	`${product_name1}` ~ `${product_name7}`
11	Price - regular	`price`	`${price1}` ~ `${price7}`
12	Price - discount	`sale_price`	`${sale_price1}` ~ `${sale_price7}`
13	Discount amount	`discount_amount`	`${discount_amount1}` ~ `${discount_amount7}`
14	Discount rate	`discount_percent`	`${discount_percent1}` ~ `${discount_percent7}`
15	Promotion image	`image_url`	`${image_url1}` ~ `${image_url7}`
17	Mobile URL	`mobile_url`	`${mobile_url1}` ~ `${mobile_url13}`
18	PC URL	`pc_url`	`${pc_url1}` ~ `${pc_url13}`

Variable specification

No.	Data	Type	Singular/Plural	Number available	Length	Data type
1	Date	Text	Plural	4	20	String
2	Site name	Text	Singular	1	30	String
3	Brand name	Text	Singular	1	30	String
4	User name	Text	Singular	1	20	String
5	User ID	Text	Singular	1	20	String
6	User rating	Text	Singular	1	20	String
7	Available point	Text	Singular	1	10	Number
8	Number of coupons	Text	Singular	1	10	Number
9	Product ID	Text	Plural	7	50	String
10	Product name	Text	Plural	7	25	String
11	Price - regular	Price	Plural	7	8	Number
12	Price - discount	Price	Plural	7	8	Number
13	Discount amount	Price	Plural	7	8	Number
14	Discount rate	Text	Plural	7	2	Number
15	Promotion image¹⁾	Image	Plural	7	1000	String
17	Mobile URL	Landing	Plural	13	1000	String
18	PC URL	Landing	Plural	13	1000	String

¹⁾ Only URLs through the Upload image for personalized message API are allowed.

Available variables for each creative type

You can use the following values of the variables for each creative type. The conversion result cannot include line breaks.

Default text

Component	Available variable
Promotion image	Variables for images. One of fixed or variable image.
Promotion text	Text or price type variable
Button 1 and 2	Landing type: Variable value support for URL only Mobile URL(`mobile_url1`) PC URL(`pc_url1`) Text or price type variable

Wide image

Component	Available variable
Promotion image	Variables for images. One of fixed or variable images
Landing	Supports landing setting only when registering images Landing type: Variable value support for URL only Mobile URL(`mobile_url1`) PC URL(`pc_url1`)
Promotion text	Text or price type variable
Button 1 and 2	Landing type: Variable value support for URL only Mobile URL(`mobile_url1`) PC URL(`pc_url1`) Text or price type variable

Wide list

Component	Available variable
Title	Text or price type variable
Promotion image for each list	Variables for images One of fixed or variable images
Landing	Landing type: Variable value support for URL only Mobile URL(`mobile_url1`) PC URL(`pc_url1`)
Promotion text	Text or price type variable
Button 1 and 2	Landing type: Variable value support for URL only Mobile URL(`mobile_url1`) PC URL(`pc_url1`) Text or price type variable

Create Personalized message creative template

Basic information

Method	URL	Authorization
`POST`	`https://apis.moment.kakao.com/openapi/v4/creatives`	Business token

Requirements		See also
Obtain usage permission Switch to a Biz app	Register business redirect URI Set business consent items	Error code Glossary

Creates a creative template of the Personal message X Reach type campaign.

Rate limit

This API limits the number of calls you can make every second per user account and ad account.

Request

Header

Name	Description	Required
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` Business token as a type of user authentication.	O
adAccountId	`adAccountId: ${AD_ACCOUNT_ID}` Ad account's ID.	O

Body

Name	Type	Description	Required
adGroupId	`Long`	Ad group ID	O
format	`Enum`	Creative type `BASIC_TEXT_MESSAGE`: Basic text `WIDE_MESSAGE`: Wide image `WIDE_LIST_MESSAGE`: Wide list `CAROUSEL_COMMERCE_MESSAGE`: Carousel commerce `CAROUSEL_FEED_MESSAGE`: Carousel feed	O
name	`String`	Creative's name (Maximum: 50 characters) Automatically generated in the `{CAMPAIGN_TYPE}_{CAMPAIGN_TARGET}_{CURRENT_TIME}` format if omitted.	X
messageElement	`MessageElement`	The content of the message. Use `MULTIPART/FORM-DATA` and pass each content as `messageElement.{}`.	O

MessageElement

Name	Type	Description	Required
creativeFormat	`Enum`	Message creative type `BASIC_TEXT_MESSAGE`: Basic text `WIDE_MESSAGE`: Wide image `WIDE_LIST_MESSAGE`: Wide list `CAROUSEL_COMMERCE_MESSAGE`: Carousel commerce `CAROUSEL_FEED_MESSAGE`: Carousel feed Important: Must be the same as `format`.	O
profileId	`String`	Kakao Talk channel profile ID	O
title	`String`	Promotional text or title. Displayed on different locations by the creative format. `BASIC_TEXT_MESSAGE`: Promotional text of Basic text (Maximum: 400 characters, 300 characters with an image) `WIDE_MESSAGE`: Promotional text of Wide image (Maximum: 76 characters) `WIDE_LIST_MESSAGE`: Title of Wide list (Maximum: 20 characters) `CAROUSEL_COMMERCE_MESSAGE`: Promotional title of the intro card of Carousel commerce (Maximum: 20 characters) Note: When variables are used, a maximum of 1,000 characters can be entered, and the text after variable substitution must meet the guideline above.	X
description	`String`	Promotional text for the intro card of `CAROUSEL_COMMERCE_MESSAGE` (Maximum: 50 characters). Note: When variables are used, a maximum of 1,000 characters can be entered, and the text after variable substitution must meet the guideline above.	X
buttonAssetGroups	`ButtonAssetGroup[]`	Button items You can use maximum 2 button asset groups. Not essential for `BASIC_TEXT_MESSAGE`, `WIDE_MESSAGE`, and `WIDE_LIST_MESSAGE` types Button 1 is required for `CAROUSEL_COMMERCE_MESSAGE` and `CAROUSEL_FEED_MESSAGE` types. For the button 1, URL, posts, coupons are available for the landing. For the button 2, Adview and Business form are available for the landing. However, the Carousel types can only use URL for the landing.	X
itemAssetGroups	`ItemAssetGroup[]`	List items	O
shareFlag	`Boolean`	Sharing option Fixed to `false` (sharing not allowed).	O
adFlag	`Boolean`	Advertising message. `true`: Set `false`: Not set	O
imageFile	`Multipart File`	Image file to upload (Available when using a fixed image for the personalized message) Only available when the message type is Default text (BASIC_TEXT_MESSAGE) or for the intro card of `CAROUSEL_COMMERCE_MESSAGE`. For other types can be set with the `ItemAssetGroup` object.	X
image	`Image`	Variable for the image of Personalized message (Available when using a variable) Only available when the message type is Default text (BASIC_TEXT_MESSAGE). For other types can be set with the `ItemAssetGroup` object.	X
csInfo	`String`	Customer center phone number	O
hasIntro	`Boolean`	Whether the `CAROUSEL_COMMERCE_MESSAGE` creative has the intro card	X
introLandingType	`String`	Landing type of the `CAROUSEL_COMMERCE_MESSAGE` intro card	X
introMobileLandingUrl	`String`	Landing URL of the `CAROUSEL_COMMERCE_MESSAGE` intro card for mobile	X
introPcLandingUrl	`String`	Landing URL of the `CAROUSEL_COMMERCE_MESSAGE` intro card for PC	X

ButtonAssetGroup

Name	Type	Description	Required
ordering	`Integer`	Button order 0, 1 are available	O
pcLandingUrl	`String`	PC landing URL Available when the `landingType` is `LANDING_URL` PC landing URL is used to land the user to a URL from the PC Kakao Talk. A valid URL with `http://` or `https://` format.	X
mobileLandingUrl	`String`	Mobile landing URL A valid URL with `http://` or `https://` format.	X
title	`String`	Button name (Maximum: 8 characters). For the Business Form, button names below are available: "톡에서 설문하기"(Survey in the Kakao Talk) "톡에서 시승신청"(Apply for the ride in the Kakao Talk) "톡에서 예약하기"(Reserve in the Kakao Talk) "톡에서 응모하기"(Apply in the Kakao Talk) "톡에서 참여하기"(Join in the Kakao Talk) For button 1 of `CAROUSEL_COMMERCE_MESSAGE` type, only "구매하기" is available. Note: When variables are used, a maximum of 1,000 characters can be entered, and the text after variable substitution must meet the guideline above.	O
landingType	`Enum`	Landing type `LANDING_URL`: URL landing `CHANNEL_COUPON`: Coupon landing `CHANNEL_POST`: Post landing `BIZ_FORM`: Business form landing `AD_VIEW`: Ad view landing Important: For carousel types, only `LANDING_URL` is available.	O
channelCouponId	`Long`	Coupon ID Available when the `landingType` is Coupon landing (CHANNEL_COUPON). A coupon ID of the response of the View list of coupons API.	X
channelPostId	`Long`	Post ID Available when the `landingType` is Post landing (CHANNEL_POST). A post ID of the response of the View list of posts API.	X
bizFormId	`Long`	Business form ID Available when the `landingType` is Business form landing (BIZ_FORM). A business form ID of the response of the View list of Business Forms API.	X
adViewId	`Long`	Ad view ID Available when the `landingType` is Ad view landing (AD_VIEW). An Ad view ID of the response of the View list of Ad Views API.	X

ItemAssetGroup

Name	Type	Description	Required
landingType	`Enum`	Landing type `LANDING_URL`: URL landing `CHANNEL_COUPON`: Coupon landing `CHANNEL_POST`: Post landing Important: For carousel types, only `LANDING_URL` is available.	O
title	`String`	Promotional text. Displayed on different locations by the creative type. `WIDE_LIST_MESSAGE`: Title of Wide list (Maximum: 25 characters for the first list, 30 characters for the second to fifth lists), the first, fourth, and fifth lists are optional `CAROUSEL_COMMERCE_MESSAGE`: Title of Carousel commerce (Maximum: 25 characters) `CAROUSEL_FEED_MESSAGE`: Title of Carousel feed (Maximum: 20 characters) Note: When variables are used, a maximum of 1,000 characters can be entered, and the text after variable substitution must meet the guideline above.	O
description	`String`	Promotional text for `CAROUSEL_FEED_MESSAGE` (Maximum: 180 characters). Note: When variables are used, a maximum of 1,000 characters can be entered, and the text after variable substitution must meet the guideline above.	O
priceAmount	`String`	Price for `CAROUSEL_COMMERCE_MESSAGE` (Minimum: 0, Maximum: 99999999). Integers only. Important: Required for `CAROUSEL_COMMERCE_MESSAGE` Note: When variables are used, a maximum of 1,000 characters can be entered, and the text after variable substitution must meet the guideline above.	X
priceCurrencyCode	`Enum: CurrencyCode`	Currency Important: Required for `CAROUSEL_COMMERCE_MESSAGE`	X
discountedPriceAmount	`String`	Discounted price for `CAROUSEL_COMMERCE_MESSAGE` (Minimum: 0, Maximum: 99999999). Integers only. Must differ from `priceAmount` by 1% or more. Note: When variables are used, a maximum of 1,000 characters can be entered, and the text after variable substitution must meet the guideline above.	X
mobileLandingUrl	`String`	Mobile landing URL A valid URL with `http://` or `https://` format. Only the same landing as button 1 is allowed for the types of Carousel commerce or Carousel feed.	X
pcLandingUrl	`String`	PC landing URL Available when the `landingType` is `LANDING_URL` PC landing URL is used to land the user to a URL from the PC Kakao Talk. A valid URL with `http://` or `https://` format.	X
channelPostId	`Long`	Post ID Available when the `landingType` is Post landing (CHANNEL_POST). A post ID of the response of the View list of posts API.	X
channelCouponId	`Long`	Coupon ID Available when the `landingType` is Coupon landing (CHANNEL_COUPON). A coupon ID of the response of the View list of coupons API.	X
imageFile	`Multipart File`	Image file to upload Allowed only if the message type is one of `WIDE_MESSAGE`, `WIDE_LIST_MESSAGE`, `CAROUSEL_COMMERCE_MESSAGE`, or `CAROUSEL_FEED_MESSAGE`.	X
image	`Image`	A variable for the image in the personalized message Use to attach an image in the personalized message with a variable. Available for the types of `WIDE_MESSAGE`, `WIDE_LIST_MESSAGE`, `CAROUSEL_COMMERCE_MESSAGE` (Except for the intro card), `CAROUSEL_FEED_MESSAGE`.	X

ImageFile

Name	Type	Description	Required
imageFile	`Multipart File`	Image file to upload.	O

Image

Name	Type	Description	Required
valueWithVariable	`String`	Variable information (Example: `${image_url1}`)	O

Response

Body

Name	Type	Description
id	`Long`	Original creative ID for execution.
creativeId	`Long`	Creative's ID. Message creatives have no review status and are always the same as the original creative ID (`id`).
name	`String`	Creative name
adGroupId	`Long`	Ad group ID
format	`Enum`	Message type `BASIC_TEXT_MESSAGE`: Basic text `WIDE_MESSAGE`: Wide image `WIDE_LIST_MESSAGE`: Wide list `CAROUSEL_COMMERCE_MESSAGE`: Carousel commerce `CAROUSEL_FEED_MESSAGE`: Carousel feed
config	`Enum: Config`	Creative status
creativeStatus	`Enum`	Status of the creative `OPERATING`: Possible to operate `INVALID_DATE`: Invalid date `OFF`: User OFF `DELETED`: Deleted `ADGROUP_UNAVAILABLE`: Impossible to operate ad group
creativeDate	`String`	Date and time when the creative is created.
lastModifiedDate	`String`	Date and time when the creative is lastly modified.
messageElement	`MessageElement`	Message contents

MessageElement

Name	Type	Description
id	`Long`	Message creative ID
adAccountId	`Long`	Ad account ID
profileId	`String`	Kakao Talk channel profile ID
profileName	`String`	Kakao Talk channel profile name
name	`String`	Message creative name
shareFlag	`Boolean`	Sharing option
adFlag	`Boolean`	Advertising message
creativeFormat	`Enum`	Message creative type `BASIC_TEXT_MESSAGE`: Basic text `WIDE_MESSAGE`: Wide image `WIDE_LIST_MESSAGE`: Wide list `CAROUSEL_COMMERCE_MESSAGE`: Carousel commerce `CAROUSEL_FEED_MESSAGE`: Carousel feed
title	`String`	Promotional text or title Displayed on the different locations by the creative format. `BASIC_TEXT_MESSAGE`: Promotional text `WIDE_MESSAGE`: Promotional text `WIDE_LIST_MESSAGE`: Title `CAROUSEL_COMMERCE_MESSAGE`: Title of the intro card
description	`String`	Promotional text for the intro card of `CAROUSEL_COMMERCE_MESSAGE`
image	`Image`	Image Responded only for Default text (BASIC_TEXT_MESSAGE) type.
buttonAssetGroups	`ButtonAssetGroup`	Button items
itemAssetGroups	`ItemAssetGroup`	List items Responded only for the `WIDE_MESSAGE` (Wide image), `WIDE_LIST_MESSAGE` (Wide list), `CAROUSEL_COMMERCE_MESSAGE` (Carousel commerce), `CAROUSEL_FEED_MESSAGE` (Carousel feed) types.
thumbnailUrl	`String`	Thumbnail URL
csInfo	`String`	Customer center phone number
createdDate	`String`	Date and time when the message creative is created, in `yyyy-MM-dd'T'HH:mm:ss` format.
lastModifiedDate	`String`	Date and time when the message creative is lastly modified, in `yyyy-MM-dd'T'HH:mm:ss` format.
hasIntro	`Boolean`	Whether the `CAROUSEL_COMMERCE_MESSAGE` creative has the intro card
introLandingType	`String`	Landing type of the `CAROUSEL_COMMERCE_MESSAGE` intro card
introMobileLandingUrl	`String`	Landing URL of the `CAROUSEL_COMMERCE_MESSAGE` intro card for mobile
introPcLandingUrl	`String`	Landing URL of the `CAROUSEL_COMMERCE_MESSAGE` intro card for PC

Image

Name	Type	Description
size	`Long`	File size
url	`String`	Image URL
fileName	`String`	Image file name
width	`Integer`	Width
height	`Integer`	Height
mimeType	`String`	Mime type
valueWithVariable	`String`	Variable information (Example: `${image_url1}`)

ButtonAssetGroup

Name	Type	Description
ordering	`Long`	Button order
title	`String`	Button title
rspvLandingUrl	`String`	Responsive Landing URL
mobileLandingUrl	`String`	Mobile landing URL
pcLandingUrl	`String`	PC landing URL
adViewId	`Long`	Ad view ID
bizFormId	`Long`	Business form ID
channelPostId	`Long`	Channel post ID
channelCouponId	`Long`	Channel coupon ID
thumbnail	`String`	Thumbnail
highlighted	`Boolean`	Whether to use the highlight button.
landingType	`Enum`	Landing type `LANDING_URL`: URL landing `CHANNEL_COUPON`: Coupon landing `CHANNEL_POST`: Post landing `AD_VIEW`: Ad view landing `BIZ_FORM`: Business form landing

ItemAssetGroup

Name	Type	Description
thumbnail	`String`	Thumbnail URL
landingType	`Enum`	Landing type `LANDING_URL`: URL landing `CHANNEL_COUPON`: Coupon landing `CHANNEL_POST`: Post landing
ordering	`Integer`	Ordering
title	`String`	Promotional text or title Promotional text in the item asset group is passed only for `WIDE_LIST_MESSAGE`, `CAROUSEL_COMMERCE_MESSAGE`, `CAROUSEL_FEED_MESSAGE` types.
description	`String`	Promotional text for `CAROUSEL_FEED_MESSAGE`
priceAmount	`Integer`	Price for `CAROUSEL_COMMERCE_MESSAGE`, can pass up to 2 decimal places for dollars and euros
priceCurrencyCode	`Enum: CurrencyCode`	Currency
discountedPriceAmount	`Integer`	Discounted price for `CAROUSEL_COMMERCE_MESSAGE`
mobileLandingUrl	`String`	Mobile landing URL Responded only for LANDING_URL landing type.
pcLandingUrl	`String`	PC landing URL Responded only for LANDING_URL landing type.
image	`Image`	Image creative Image in the item asset group is returned for `WIDE_MESSAGE`, `WIDE_LIST_MESSAGE`, `CAROUSEL_COMMERCE_MESSAGE`, `CAROUSEL_FEED_MESSAGE` types.
thumbnail	`Thumbnail`	Representative thumbnail.

Thumbnail

Name	Type	Description
fileSize	`Long`	File size
url	`String`	Representative thumbnail URL
fileName	`String`	Representative thumbnail file name
imageWidth	`Integer`	Width
imageHeight	`Integer`	Height
mimeType	`String`	Mime type

Sample

Request

curl -X POST "https://apis.moment.kakao.com/openapi/v4/creatives" \
  -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
  -H "adAccountId: ${AD_ACCOUNT_ID}"
-F "messageElement.creativeFormat=BASIC_TEXT_MESSAGE" \
  -F "messageElement.profileId=_Xxo" \
  -F "messageElement.title=홍보문구" \
  -F "messageElement.buttonAssetGroups[0].ordering=0" \
  -F "messageElement.buttonAssetGroups[0].landingType=LANDING_URL" \
  -F "messageElement.buttonAssetGroups[0].title=버튼1" \
  -F "messageElement.buttonAssetGroups[0].pcLandingUrl=${pc_url1}" \
  -F "messageElement.buttonAssetGroups[0].mobileLandingUrl=${mobile_url1}" \
  -F "messageElement.buttonAssetGroups[1].ordering=1" \
  -F "messageElement.buttonAssetGroups[1].landingType=BIZ_FORM" \
  -F "messageElement.buttonAssetGroups[1].bizFormId=1" \
  -F "messageElement.buttonAssetGroups[1].title=톡에서 시승신청" \
  -F "messageElement.name=기본텍스트" \
  -F "messageElement.shareFlag=true" \
  -F "messageElement.adFlag=true" \
  -F "messageElement.csInfo=02-1234-5678" \
  -F "messageElement.image.valueWithVariable=${image_url1}" \
  -F "adGroupId=12345" \
  -F "format=BASIC_TEXT_MESSAGE"

Response

// HTTP/1.1 200 OK
// Content-Type: application/json;charset=UTF-8
{
  "id": 12345,
  "creativeId": 12345,
  "name": "카카오톡 채널_도달_20210625",
  "adGroupId": 11223,
  "format": "BASIC_TEXT_MESSAGE",
  "config": "ON",
  "statusDescription": "발송 대기",
  "creativeStatus": "OPERATING",
  "createdDate": "2021-06-25T17:04:02.883575",
  "lastModifiedDate": "2021-06-25T17:04:06.291245",
  "messageElement": {
    "id": 12345,
    "adAccountId": 123,
    "profileId": "_xbHxd",
    "name": "카카오톡 채널_도달_20210625",
    "creativeFormat": "BASIC_TEXT_MESSAGE",
    "title": "홍보문구입니다.",
    "image": {
      "valueWithVariable": "${image_url1}"
    },
    "shareFlag": true,
    "adFlag": true,
    "thumbnail": {
      "fileSize": 168816,
      "url": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
      "fileName": "풀뷰 1280x720.jpg",
      "imageWidth": 1280,
      "imageHeight": 720,
      "mimeType": "image/jpeg",
      "imageHash": "35156f0c1393434ced4be21423d08a6a"
    },
    "buttonAssetGroups": [
      {
        "ordering": 0,
        "title": "버튼1",
        "pcLandingUrl": "http://www.daum.net",
        "mobileLandingUrl": "http://www.google.com",
        "landingType": "LANDING_URL"
      }
    ],
    "thumbnailUrl": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
    "messageThumbnail": {
      "fileSize": 168816,
      "url": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
      "fileName": "풀뷰 1280x720.jpg",
      "imageWidth": 1280,
      "imageHeight": 720,
      "mimeType": "image/jpeg",
      "imageHash": "35156f0c1393434ced4be21423d08a6a"
    },
    "createdDate": "2021-06-25T17:04:02.883575",
    "lastModifiedDate": "2021-06-25T17:04:06.291245"
  }
}

Edit Personalized message creative template

Basic information

Method	URL	Authorization
`PUT`	`https://apis.moment.kakao.com/openapi/v4/creatives`	Business token

Requirements		See also
Obtain usage permission Switch to a Biz app	Register business redirect URI Set business consent items	Error code Glossary

Enables you to edit a creative template of Personal message X reach campaign.

Conditions for use

Creatives that include a Coupon Book asset group (CouponBookAssetGroup) cannot be edited with the Open API.
If a message delivery request is in progress, both the request and delivery statuses are stopped.

Rate limit

This API limits the number of calls you can make every second per user account and ad account.

Request

Header

Name	Description	Required
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` Business token as a type of user authentication.	O
adAccountId	`adAccountId: ${AD_ACCOUNT_ID}` Ad account's ID.	O

Body

Name	Type	Description	Required
adGroupId	`Long`	Ad group ID	O
format	`Enum`	Creative type `BASIC_TEXT_MESSAGE`: Basic text `WIDE_MESSAGE`: Wide image `WIDE_LIST_MESSAGE`: Wide list `CAROUSEL_COMMERCE_MESSAGE`: Carousel commerce `CAROUSEL_FEED_MESSAGE`: Carousel feed	O
name	`String`	Creative's name (Maximum: 50 characters) Automatically generated in the `{CAMPAIGN_TYPE}_{CAMPAIGN_TARGET}_{CURRENT_TIME}` format if omitted.	X
messageElement	`MessageElement`	The content of the message. Use `MULTIPART/FORM-DATA` and pass each content as `messageElement.{}`.	O

Response

Body

Name	Type	Description
id	`Long`	Original creative ID for execution.
creativeId	`Long`	Creative's ID. Message creatives have no review status and are always the same as the original creative ID (`id`).
name	`String`	Creative name
adGroupId	`Long`	Ad group ID
format	`Enum`	Message type `BASIC_TEXT_MESSAGE`: Basic text `WIDE_MESSAGE`: Wide image `WIDE_LIST_MESSAGE`: Wide list `CAROUSEL_COMMERCE_MESSAGE`: Carousel commerce `CAROUSEL_FEED_MESSAGE`: Carousel feed
config	`Enum: Config`	Creative status
creativeStatus	`Enum`	Status of the creative `OPERATING`: Possible to operate `INVALID_DATE`: Invalid date `OFF`: User OFF `DELETED`: Deleted `ADGROUP_UNAVAILABLE`: Impossible to operate ad group
creativeDate	`String`	Date and time when the creative is created.
lastModifiedDate	`String`	Date and time when the creative is lastly modified.
messageElement	`MessageElement`	Message contents

Sample

Request

curl -X PUT "https://apis.moment.kakao.com/openapi/v4/creatives" \
  -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
  -H "adAccountId: ${AD_ACCOUNT_ID}"
-F "messageElement.creativeFormat=BASIC_TEXT_MESSAGE" \
  -F "messageElement.profileId=_Xxo" \
  -F "messageElement.title=홍보문구" \
  -F "messageElement.buttonAssetGroups[0].ordering=0" \
  -F "messageElement.buttonAssetGroups[0].landingType=LANDING_URL" \
  -F "messageElement.buttonAssetGroups[0].title=버튼1" \
  -F "messageElement.buttonAssetGroups[0].pcLandingUrl=http://www.daum.net" \
  -F "messageElement.buttonAssetGroups[0].mobileLandingUrl=http://www.kakaocorp.com" \
  -F "messageElement.buttonAssetGroups[1].ordering=1" \
  -F "messageElement.buttonAssetGroups[1].landingType=BIZ_FORM" \
  -F "messageElement.buttonAssetGroups[1].bizFormId=1" \
  -F "messageElement.buttonAssetGroups[1].title=톡에서 시승신청" \
  -F "messageElement.name=기본텍스트" \
  -F "messageElement.shareFlag=true" \
  -F "messageElement.adFlag=true" \
  -F "messageElement.csInfo=02-1234-5678" \
  -F "messageElement.imageFile=@/directory/banner.png" \
  -F "adGroupId=39688" \
  -F "format=BASIC_TEXT_MESSAGE"

Response

// HTTP/1.1 200 OK
// Content-Type: application/json;charset=UTF-8
{
  "id": 12345,
  "creativeId": 12345,
  "name": "카카오톡 채널_도달_20210625",
  "adGroupId": 11223,
  "format": "BASIC_TEXT_MESSAGE",
  "config": "ON",
  "statusDescription": "발송 대기",
  "creativeStatus": "OPERATING",
  "createdDate": "2021-06-25T17:04:02.883575",
  "lastModifiedDate": "2021-06-25T17:04:06.291245",
  "messageElement": {
    "id": 12345,
    "adAccountId": 123,
    "profileId": "_xbHxd",
    "name": "카카오톡 채널_도달_20210625",
    "creativeFormat": "BASIC_TEXT_MESSAGE",
    "title": "홍보문구입니다.",
    "image": {
      "fileSize": 168816,
      "url": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
      "fileName": "풀뷰 1280x720.jpg",
      "imageWidth": 1280,
      "imageHeight": 720,
      "mimeType": "image/jpeg",
      "imageHash": "35156f0c1393434ced4be21423d08a6a"
    },
    "shareFlag": true,
    "adFlag": true,
    "thumbnail": {
      "fileSize": 168816,
      "url": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
      "fileName": "풀뷰 1280x720.jpg",
      "imageWidth": 1280,
      "imageHeight": 720,
      "mimeType": "image/jpeg",
      "imageHash": "35156f0c1393434ced4be21423d08a6a"
    },
    "buttonAssetGroups": [
      {
        "ordering": 0,
        "title": "버튼1",
        "pcLandingUrl": "http://www.daum.net",
        "mobileLandingUrl": "http://www.google.com",
        "landingType": "LANDING_URL"
      }
    ],
    "thumbnailUrl": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
    "messageThumbnail": {
      "fileSize": 168816,
      "url": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
      "fileName": "풀뷰 1280x720.jpg",
      "imageWidth": 1280,
      "imageHeight": 720,
      "mimeType": "image/jpeg",
      "imageHash": "35156f0c1393434ced4be21423d08a6a"
    },
    "createdDate": "2021-06-25T17:04:02.883575",
    "lastModifiedDate": "2021-06-25T17:04:06.291245"
  }
}

See more

Kakao Moment API Reference

사이드 메뉴

Docs Home

Getting started

Kakao Developers

Login

Communication

Map

Navigation

Advertisement

Search

More

Ad creation: Personalized message creative

Before you begin

Caution

Common guide

Promotion image

Promotion text

Button

Component guide

Required component

Component specification

Landing

Variable field name

Variable specification

Available variables for each creative type

Default text

Wide image

Wide list

Create Personalized message creative template

Basic information

Rate limit

Request

Header

Body

MessageElement

ButtonAssetGroup

ItemAssetGroup

ImageFile

Image

Response

Body

MessageElement

Image

ButtonAssetGroup

ItemAssetGroup

Thumbnail

Sample

Request

Response

Edit Personalized message creative template

Basic information

Conditions for use

Rate limit

Request

Header

Body

Response

Body

Sample

Request

Response

See more

Was this helpful?