Kakao Moment

Ad creation: Message creative

This document describes how to use the Message creative APIs.

Before you begin

Policies on creative registration

If you create a creative for a sending group after the start of sending messages, the messages can be sent immediately as soon as the creative is saved according to the ad group's status. Check the start period and status of the ad group when creating a creative.

Type	5 minutes before sending	5 minutes before start of sending to sending moment	During delivery period	After delivery period
Basic message	Allowed to register.	Allowed to register.	Allowed to register.	Not allowed to register.
Smart message	Allowed to register or add.	Allowed to register. Allowed to add when ad group is OFF.	Allowed to register. Allowed to add when ad group is OFF.	Not allowed to register or add.

Required components by creative type

You cannot create the below creatives with Open APIs:

Creatives in PREMIUM_VIDEO_MESSAGE type.
Creatives including CouponBookAssetGroup.

You can only use the images and text that comply with the message delivery guidelines.

Basic text message

Component	Required	Landing: URL	Landing: Post	Landing: Coupon	Landing: Ad View	Landing: Business Form
Promotional image	X	X	X	X	X	X
Promotional text	O	No landing	No landing	No landing	No landing	No landing
Button1	X	O	O	O	X	X
Button2	X	O	O	O	O	O
Share	X	No landing	No landing	No landing	No landing	No landing

Promotional image:
- Image width: 80 pixels or more
- Image type: JPG, PNG
- Image file size: Up to 10 MB
- Image aspect ratio: 1:2.5 or less
- Original image: Up to 200 million pixels or less
- If the landing for Button1 exists, the same landing is applied (Not allowed to set separately).
Promotional text:
- You can enter up to 1,300 characters regardless of whether an image is attached.
- Not allowed to input a URL link.
- Up to 99 line breaks are allowed.
Button 1:
- Lable: Up to 8 characters including space are allowed (If exceeding, not allowed to input).
Button 2:
- Lable: Up to 8 characters including space are allowed (If exceeding, not allowed to input).

Wide image message

Component	Required	Landing: URL	Landing: Post	Landing: Coupon	Landing: Ad View	Landing: Business Form
Promotional image	O Promotional image is required.	O	O	O	X	X
Promotional text	O	No landing	No landing	No landing	No landing	No landing
Button	X	O	O	O	O	O
Share	X	No landing	No landing	No landing	No landing	No landing

Promotional image:
- Image width: 80 pixels or more
- Image type: JPG, PNG
- Image file size: Up to 10 MB
- Image aspect ratio: 1:2.5 or less
- Original image: Up to 200 million pixels or less
Promotional text:
- Up to 76 characters are allowed (If exceeding, not allowed to input).
- Not allowed to input a URL link.
- 5 line break is allowed.
Button:
- Lable: Up to 8 characters including space are allowed (If exceeding, not allowed to input).

Wide list message

Component	Required	Landing: URL	Landing: Post	Landing: Coupon	Landing: Ad View	Landing: Business Form
Title of List 1	X	No landing	No landing	No landing	No landing	No landing
Title of List 2 and 3	O	No landing	No landing	No landing	No landing	No landing
Promotional image of List1 to List3	O	O	O	O	X	X
Promotional text of List1 to List3	O	Same as landing of promotional image set for each item	Same as landing of promotional image set for each item	Same as landing of promotional image set for each item	Same as landing of promotional image set for each item	Same as landing of promotional image set for each item
Promotional image of List4~5	X	O	O	O	X	X
Promotional text of List4~5	X	Same as landing of promotional image set for each item	Same as landing of promotional image set for each item	Same as landing of promotional image set for each item	Same as landing of promotional image set for each item	Same as landing of promotional image set for each item
Button	X	O	O	O	O	O
Share	X	No landing	No landing	No landing	No landing	No landing

Title: Up to 20 characters allowed (If exceeding, not allowed to input).
Promotional image of List1 to List3:
- Image width: 80 pixels or more
- Image type: JPG, PNG
- Image file size: Up to 10 MB
- Image aspect ratio: 1:2.5 or less
- Original image: Up to 200 million pixels or less
- Recommended image size: For Item1, 800 x 400 pixels. For the others, 400 x 400 pixels
Promotional text of List1 to List3:
- For Item1, up to 25 characters are allowed. For the others, up to 30 characters (If exceeding, not allowed to input).
- Not allowed to input a URL link.
- A single line break is allowed.
Promotional image of List4~5:
- Image width: 80 pixels or more
- Image type: JPG, PNG
- Image file size: Up to 10 MB
- Image aspect ratio: 1:2.5 or less
- Original image: Up to 200 million pixels or less
Promotional text of List4~5:
- For Item1, up to 25 characters are allowed. For the others, up to 30 characters (If exceeding, not allowed to input).
- Not allowed to input a URL link.
- A single line break is allowed.
Button:
- Lable: Up to 8 characters including space are allowed (If exceeding, not allowed to input).

Policies on creative modification

To edit a creative, it must be the same as the previous message format. Since 5 minutes before the delivery, you can only edit the creative's name. The request to edit other parameters except for its name is ignored.

Type	5 minutes before sending	5 minutes before start of sending to sending moment	During delivery period	After delivery period
Basic message	Possible	Impossible	Impossible	Impossible
Smart message	Possible	Impossible	Impossible	Impossible

You cannot edit the below creatives with Open APIs:

Creatives in PREMIUM_VIDEO_MESSAGE type.
Creatives including CouponBookAssetGroup.

You can only use the images and text that comply with the message delivery guidelines.

Message creatives not allowed to be copied

You cannot copy the below creatives with Open APIs:

Creatives in PREMIUM_VIDEO_MESSAGE type.
Creatives including CouponBookAssetGroup.

Case	Result if attempting to copy
Message under a campaign from different Kakao Talk Channel	Only the corresponding Kakao Talk Channel's profile ID is displayed in the campaign selection list on the pop-up screen to copy a creative.
Channel Partner Center message saved under an ad group before the editor is released	If the message is selected as the creatives to be copied, an alert is displayed.
Message that lands on the coupon of which status is 'Immediately finished' or 'event application date expired'.	The message is not counted as the number of creatives that can be copied. "Impossible to copy" is displayed on the list.
Message that lands on the Business Form of which status is 'Finished'	The message is not counted as the number of creatives that can be copied. "Impossible to copy" is displayed on the list.
Message that lands on the Post of which status is 'Deleted'	The message is not counted as the number of creatives that can be copied. "Impossible to copy" is displayed on the list.
Message that lands on the Ad View of which status is 'Deleted'	The message is not counted as the number of creatives that can be copied. "Impossible to copy" is displayed on the list.
Message under a campaign from the same Kakao Talk Channel	On the pop-up screen to copy a creative, it is impossible to copy the creative under an existing ad group set as `ageVerification: true` to a new ad group set as `ageVerification: false`.

Button items

Buttons are not essential for BASIC_TEXT_MESSAGE, WIDE_MESSAGE, WIDE_LIST_MESSAGE types
Button 1 is required for CAROUSEL_COMMERCE_MESSAGE, CAROUSEL_FEED_MESSAGE tyeps

Type	Number of configurable buttons	Configurable landing for button 1	Configurable landing for button 2
BASIC_TEXT_MESSAGE	2	None, URL, Post, Coupon	None, URL, Post, Coupon, AdView, Business form
WIDE_MESSAGE	1	None, URL, Post, Coupon, AdView, Business form	If set `shareFlag`, a sharing button will be displayed
WIDE_LIST_MESSAGE	1	None, URL, Post, Coupon, AdView, Business form	If set `shareFlag`, a sharing button will be displayed
CAROUSEL_COMMERCE_MESSAGE	1	None, URL	If set `shareFlag`, a sharing button will be displayed
CAROUSEL_FEED_MESSAGE	2	None, URL	None, URL

Button order for carousel types

Input order for carousel types	Card number	Button Number
itemAssetGroup 0	Carousel 1	buttonAssetGroup 0, 1
itemAssetGroup 1	Carousel 2	buttonAssetGroup 2, 3
itemAssetGroup 2	Carousel 3	buttonAssetGroup 4, 5
itemAssetGroup 3	Carousel 4	buttonAssetGroup 6, 7
itemAssetGroup 4	Carousel 5	buttonAssetGroup 8, 9
itemAssetGroup 5	Carousel 6	buttonAssetGroup 10, 11

Create Message creative

Basic information

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

Permission	Prerequisite	Business Authentication	Business consent items
Required: Request permission	Switch to a Biz app Set Business redirect URI Business consent items	Required	Required

Creates a Message creative under the 'Kakao Talk Channel X Reach(도달)' type of campaign.

Send a POST request with the issued business token and an ad account ID (adAccountId) in the request header. If the request is successful, this API returns the detailed information of the created creative. If failed, refer to Error code to figure out its failure cause.

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's ID.	O
format	`String`	Creative type. Use one of the followings: `BASIC_TEXT_MESSAGE` `WIDE_MESSAGE` `WIDE_LIST_MESSAGE` `CAROUSEL_COMMERCE_MESSAGE` `CAROUSEL_FEED_MESSAGE`	O
name	`String`	Creative's name. Up to 50 characters are allowed. If not specified, the name is automatically set in `{CAMPAIGN_TYPE}_{CAMPAIGN_GOAL}_{CURRENT_TIME}` format.	X
messageElement	`MessageElement`	Message content to be created. Pass the contents in `mesasgeElement.{}` format with `MULTIPART/FORM-DATA`.	O

MessageElement

Name	Type	Description	Required
creativeFormat	`String`	Message creative's type. One of the followings: `BASIC_TEXT_MESSAGE` `WIDE_MESSAGE` `WIDE_LIST_MESSAGE` `CAROUSEL_COMMERCE_MESSAGE` `CAROUSEL_FEED_MESSAGE` Must be same as `format`.	O
profileId	`String`	Kakao Talk Channel's profile ID.	O
title	`String`	Promotional text or title Displayed on the different locations by the creative format. `BASIC_TEXT_MESSAGE`: Promotional text (Up to 400 characters, up to 300 characters with an image) `WIDE_MESSAGE`: Promotional text (Up to 76 characters) `WIDE_LIST_MESSAGE`: Title (Up to 20 characters) `CAROUSEL_COMMERCE_MESSAGE`: Title of the intro card (Up to 20 characters)	O
description	`String`	Promotional text for the intro card of `CAROUSEL_COMMERCE_MESSAGE` Up to 50 characters	X
buttonAssetGroups	`ButtonAssetGroup[]`	Button items 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	X
itemAssetGroups	`ItemAssetGroup[]`	List items.	O
shareFlag	`Boolean`	Whether to use Sharing. If `ageVerification` (age verification message) of the parent ad group is set to `true`, only `false` is allowed.	O
adFlag	`Boolean`	Advertising message	O
imageFile	`Multipart file`	Image file to be uploaded. Allowed only if the message type is `BASIC_TEXT_MESSAGE` or `CAROUSEL_COMMERCE_MESSAGE` with the intro card. For the other types, pass through the `itemAssetGroup` object.	X
csInfo	`String`	Phone number of customer support.	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
mobileLandingUrl	`String`	See more landing URL for Carousel Commerce and Carousel Feed types	X
pcLandingUrl	`String`	See more landing URL for Carousel Commerce and Carousel Feed types	X

ButtonAssetGroup

Name	Type	Description	Required
ordering	`Integer`	Order of buttons. Pass `0` or `1` for `BASIC_TEXT_MESSAGE`. For other types, `0` is allowed only. Note: Button order for carousel types	O
pcLandingUrl	`String`	Landing URL for PC. Only allowed when `LANDING_URL` is set for a landing type. Used to land on a separate URL when a user clicks a button on the PC version of Kakao Talk. Pass a valid URL with `http://` or `https://` scheme.	X
mobileLandingUrl	`String`	Landing URL for mobile. Pass a valid URL with `http://` or `https://` scheme.	O*
title	`String`	Button name. Up to 8 characters are allowed. In case of Business Form, only the following button names are allowed: "톡에서 설문하기" (Survery on Talk) "톡에서 시승신청" (Request test drive on Talk) "톡에서 예약하기" (Reserve on Talk) "톡에서 응모하기" (Apply on Talk) "톡에서 참여하기" (Join on Talk) For button 1 of `CAROUSEL_COMMERCE_MESSAGE` type, only "구매하기" is available.	O
landingType	`String`	Landing type. Use one of the followings: `LANDING_URL`: URL landing `CHANNEL_COUPON` : Coupon landing `CHANNEL_POST`: Post landing `BIZ_FORM`: Business Form landing `AD_VIEW`: Ad View landing For carousel types, only `LANDING_URL` is available.	O
channelCouponId	`Long`	Coupon ID. Allowed if the message landing type is `CHANNEL_COUPON` . Use the coupon ID obtained through the View list of coupons API.	O*
channelPostId	`Long`	Channel post ID. Allowed if the landing type is `CHANNEL_POST`. Pass the Post ID obtained through the View list of Channel Posts for landing settings API.	O*
bizFormId	`Long`	Business Form's ID. Allowed if the landing type is is `BIZ_FORM` (Business Form) Pass the `bizFormId` obtained through the View list of Business Forms for landing settings API.	O*
adViewId	`Long`	Ad View ID. Allowed if the landing type is `AD_VIEW`. Pass the Ad View ID obtained through the View list of Ad Views API.	O*

ItemAssetGroup

Name	Type	Description	Required
landingType	`String`	Landing type. Use one of the followings: `LANDING_URL`: URL landing `CHANNEL_COUPON`: Coupon landing `CHANNEL_POST`: Post landing	O
title	`String`	Promotional text. Displayed on different locations by the creative type `WIDE_LIST_MESSAGE`: Title (limitation: for the first title up to 25 characters, for the second to fifth title up to 30 characters) first, fourth or fifth list is not essential `CAROUSEL_COMMERCE_MESSAGE`: Title (Up to 25 characters) `CAROUSEL_FEED_MESSAGE`: Title (Up to 20 characters)	O*
description	`String`	Promotional text for `CAROUSEL_FEED_MESSAGE` Up to 180 characters	O
priceAmount	`String`	Price for `CAROUSEL_COMMERCE_MESSAGE` (Minumum: 0, Maximum: 99999999, integers only) Required for `CAROUSEL_COMMERCE_MESSAGE`	O*
priceCurrencyCode	`String`	Currency One of KRW, USD, JPY, and EUR Required for `CAROUSEL_COMMERCE_MESSAGE`	O*
discountedPriceAmount	`String`	Discounted price for `CAROUSEL_COMMERCE_MESSAGE` (Minumum: 0, Maximum: 99999999, integers only) Must be bigger than the `priceAmount`	X
mobileLandingUrl	`String`	Landing URL for mobile. Pass a valid URL with `http://` or `https://` scheme.	X
pcLandingUrl	`String`	Landing URL for PC. Pass a valid URL with `http://` or `https://` scheme.	X
channelPostId	`Long`	Channel post ID. Allowed if the landing type is `CHANNEL_POST`. Pass the Post ID obtained through the View list of Channel Posts for landing settings API.	X
channelCouponId	`Long`	Coupon ID. Allowed if the message landing type is `CHANNEL_COUPON` . Use the coupon ID obtained through the View list of coupons API.	X
imageFile	`Multipart File`	Image file to be uploaded. Alowed only if the message type is one of `WIDE_MESSAGE`, `WIDE_LIST_MESSAGE`, `CAROUSEL_COMMERCE_MESSAGE` without the intro card, or `CAROUSEL_FEED_MESSAGE`. Not allowed if the landing type is `URL`.	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's name.
adGroupId	`Long`	Ad group's ID.
format	`String`	Creative's type. One of the followings: `BASIC_TEXT_MESSAGE` `WIDE_MESSAGE` `WIDE_LIST_MESSAGE` `CAROUSEL_COMMERCE_MESSAGE` `CAROUSEL_FEED_MESSAGE`
config	`String`	Creative's status. One of `ON`, `OFF`, or `DEL` (Deleted).
systemConfig	`String`	Creative's system status. Either `ON` or `ADMIN_STOP`.
statusDescription	`String`	Current status of a Message ad group. One of the followings: `발송 대기`: Ready. `발송중`: Sending. `발송중지`: Paused. `발송종료`: Finished.
creativeStatus	`String`	Creative's operation status. One of the followings: `OPERATING`: Possible to opearate. `UNAPPROVED`: Unapproved. `INVALID_DATE`: Invalid date. `MONITORING_REJECTED`: Admin suspended. `OFF`: User OFF. `DELETED`: Deleted. `ADGROUP_UNAVAILABLE`: Impossible to operate ad group.
createdDate	`String`	Date and time when the creative is created.
lastModifiedDate	`String`	Date and time when the creative is lastly modified.
messageElement	`MessageElement`	Detailed information about Message creative.
ageVerification	`Boolean`	Whether to use age verification messages. `true`: Age verification message used. `false`: General message used.

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=Promotional text" \
    -F "messageElement.buttonAssetGroups[0].ordering=0" \
    -F "messageElement.buttonAssetGroups[0].landingType=LANDING_URL" \
    -F "messageElement.buttonAssetGroups[0].title=button1" \
    -F "messageElement.buttonAssetGroups[0].pcLandingUrl=http://www.daum.net" \
    -F "messageElement.buttonAssetGroups[0].mobileLandingUrl=https://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=request_test_drive_on_talk" \
    -F "messageElement.name=basic_text" \
    -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": "KakaoTalkChannel_Reach_20210625",
  "adGroupId": 11223,
  "format": "BASIC_TEXT_MESSAGE",
  "config": "ON",
  "systemConfig": "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": "KakaoTalkChannel_Reach_20210625",
    "creativeFormat": "BASIC_TEXT_MESSAGE",
    "title": "This is promotional text.",
    "image": {
      "fileSize": 168816,
      "url": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
      "fileName": "fullview_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": "fullview_1280x720.jpg",
      "imageWidth": 1280,
      "imageHeight": 720,
      "mimeType": "image/jpeg",
      "imageHash": "35156f0c1393434ced4be21423d08a6a"
    },
    "buttonAssetGroups": [
      {
        "ordering": 0,
        "title": "button1",
        "pcLandingUrl": "http://www.daum.net",
        "mobileLandingUrl": "https://www.kakaocorp.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": "fullview_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 Message creative

Basic information

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

Permission	Prerequisite	Business Authentication	Business consent items
Required: Request permission	Switch to a Biz app Set Business redirect URI Business consent items	Required	Required

Enables you to edit a Message creative under the 'Kakao Talk Channel X Reach(도달)' type of campaign.

Send a PUT request with the issued business token and an ad account ID (adAccountId) in the request header. If the request is successful, this API returns the detailed information of the modified creative. If failed, refer to Error code to figure out its failure cause.

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's ID.	O
format	`String`	Creative's type. Use one of the followings: `BASIC_TEXT_MESSAGE` `WIDE_MESSAGE` `WIDE_LIST_MESSAGE` `CAROUSEL_COMMERCE_MESSAGE` `CAROUSEL_FEED_MESSAGE` `CAROUSEL_COMMERCE_MESSAGE` `CAROUSEL_FEED_MESSAGE`	O
name	`String`	Creative's name. Up to 50 characters are allowed. If not specified, the name is automatically set in `{CAMPAIGN_TYPE}_{CAMPAIGN_GOAL}_{CURRENT_TIME}` format.	X
messageElement	`MessageElement`	Message content to be modified to. Pass the contents in `mesasgeElement.{}` format with `MULTIPART/FORM-DATA`.	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's name.
adGroupId	`Long`	Ad group's ID.
format	`String`	Creative's type. One of the followings: `BASIC_TEXT_MESSAGE` `WIDE_MESSAGE` `WIDE_LIST_MESSAGE` `CAROUSEL_COMMERCE_MESSAGE` `CAROUSEL_FEED_MESSAGE`
config	`String`	Creative's status. One of `ON`, `OFF`, or `DEL` (Deleted).
systemConfig	`String`	Creative's system status. Either `ON` or `ADMIN_STOP`.
statusDescription	`String`	Current status of a Message ad group. One of the followings: `발송 대기`: Ready. `발송중`: Sending. `발송중지`: Paused. `발송종료`: Finished.
creativeStatus	`String`	Creative's operation status. One of the followings: `OPERATING`: Possible to opearate. `UNAPPROVED`: Unapproved. `INVALID_DATE`: Invalid date. `MONITORING_REJECTED`: Admin suspended. `OFF`: User OFF. `DELETED`: Deleted. `ADGROUP_UNAVAILABLE`: Impossible to operate ad group.
createdDate	`String`	Date and time when the creative is created.
lastModifiedDate	`String`	Date and time when the creative is lastly modified.
messageElement	`MessageElement`	Detailed information about Message creative.
ageVerification	`Boolean`	Whether to use age verification messages. `true`: Age verification message used. `false`: General message used.

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=Promotional text" \
    -F "messageElement.buttonAssetGroups[0].ordering=0" \
    -F "messageElement.buttonAssetGroups[0].landingType=LANDING_URL" \
    -F "messageElement.buttonAssetGroups[0].title=button1" \
    -F "messageElement.buttonAssetGroups[0].pcLandingUrl=http://www.daum.net" \
    -F "messageElement.buttonAssetGroups[0].mobileLandingUrl=https://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=request_test_drive_on_talk" \
    -F "messageElement.name=basic_text" \
    -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": "KakaoTalkChannel_Reach_20210625",
  "adGroupId": 11223,
  "format": "BASIC_TEXT_MESSAGE",
  "config": "ON",
  "systemConfig": "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": "KakaoTalkChannel_Reach_20210625",
    "creativeFormat": "BASIC_TEXT_MESSAGE",
    "title": "This is promotional text.",
    "image": {
      "fileSize": 168816,
      "url": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
      "fileName": "fullview_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": "fullview_1280x720.jpg",
      "imageWidth": 1280,
      "imageHeight": 720,
      "mimeType": "image/jpeg",
      "imageHash": "35156f0c1393434ced4be21423d08a6a"
    },
    "buttonAssetGroups": [
      {
        "ordering": 0,
        "title": "button1",
        "pcLandingUrl": "http://www.daum.net",
        "mobileLandingUrl": "https://www.kakaocorp.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": "fullview_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"
  }
}

Copy Message creative

Basic information

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

Permission	Prerequisite	Business Authentication	Business consent items
Required: Request permission	Switch to a Biz app Set Business redirect URI Business consent items	Required	Required

Enables you to copy a creative under the 'Kakao Talk Channel X Reach(도달)' type of campaign.

Send a POST request with the issued business token and an ad account ID (adAccountId) in the request header. You must also pass the ad group ID which the creatives will copy to and the creative IDs to be copied as a list. If the request is successful, this API returns the detailed information of the copied creatives. If failed, refer to Error code to figure out its failure cause.

This API limits the number of calls you can make to every five seconds 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 which the creatives will be copied to.	O
creativeIds	`Long[]`	ID list of creatives to be copied.	O

Response

Body

Name	Type	Description
-	`MessageCreative[]`	List of creative information.

MessageCreative

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's name.
adGroupId	`Long`	Ad group's ID.
format	`String`	Creative's type. One of the followings: `BASIC_TEXT_MESSAGE` `WIDE_MESSAGE` `WIDE_LIST_MESSAGE` `CAROUSEL_COMMERCE_MESSAGE` `CAROUSEL_FEED_MESSAGE`
config	`String`	Creative's status. One of `ON`, `OFF`, or `DEL` (Deleted).
systemConfig	`String`	Creative's system status. Either `ON` or `ADMIN_STOP`.
statusDescription	`String`	Current status of a Message ad group. One of the followings: `발송 대기`: Ready. `발송중`: Sending. `발송중지`: Paused. `발송종료`: Finished.
creativeStatus	`String`	Creative's operation status. One of the followings: `OPERATING`: Possible to opearate. `UNAPPROVED`: Unapproved. `INVALID_DATE`: Invalid date. `MONITORING_REJECTED`: Admin suspended. `OFF`: User OFF. `DELETED`: Deleted. `ADGROUP_UNAVAILABLE`: Impossible to operate ad group.
createdDate	`String`	Date and time when the creative is created.
lastModifiedDate	`String`	Date and time when the creative is lastly modified.
messageElement	`MessageElement`	Detailed information about Message creative.
ageVerification	`Boolean`	Whether to use age verification messages. `true`: Age verification message used. `false`: General message used.

Sample

Request

curl -X POST "https://apis.moment.kakao.com/openapi/v4/creatives/copy" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -d '{
            "adGroupId": 11223,
            "creativeIds": [12345]
        }'

Response

// HTTP/1.1 200 OK
// Content-Length: 0
// Content-Type: application/json;charset=UTF-8
[
  {
    "id": 12346,
    "creativeId": 12346,
    "name": "KakaoTalkChannel_Reach_20210625",
    "adGroupId": 11223,
    "format": "BASIC_TEXT_MESSAGE",
    "config": "ON",
    "systemConfig": "ON",
    "statusDescription": "발송 대기",
    "creativeStatus": "OPERATING",
    "createdDate": "2021-06-25T17:04:03",
    "lastModifiedDate": "2021-06-25T17:04:06",
    "messageElement": {
      "id": 78428,
      "adAccountId": 759,
      "profileId": "_xbHxd",
      "name": "KakaoTalkChannel_Reach_20210625",
      "creativeFormat": "BASIC_TEXT_MESSAGE",
      "title": "This is promotional text.",
      "image": {
        "fileSize": 168816,
        "url": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
        "fileName": "fullview_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": "fullview_1280x720.jpg",
        "imageWidth": 1280,
        "imageHeight": 720,
        "mimeType": "image/jpeg",
        "imageHash": "35156f0c1393434ced4be21423d08a6a"
      },
      "buttonAssetGroups": [
        {
          "ordering": 0,
          "title": "button1",
          "pcLandingUrl": "http://www.daum.net",
          "mobileLandingUrl": "https://www.kakaocorp.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": "fullview_1280x720.jpg",
        "imageWidth": 1280,
        "imageHeight": 720,
        "mimeType": "image/jpeg",
        "imageHash": "35156f0c1393434ced4be21423d08a6a"
      },
      "createdDate": "2021-06-25T17:04:03",
      "lastModifiedDate": "2021-06-25T17:04:06"
    }
  }
]

See more

Kakao Moment API Reference

사이드 메뉴

인하우스/공동체 문서

Docs Home

Getting started

Kakao Developers

Login

Communication

Kakao Map

Navigation

Advertisement

Search

More

Ad creation: Message creative

Before you begin

Policies on creative registration

Required components by creative type

Basic text message

Wide image message

Wide list message

Policies on creative modification

Message creatives not allowed to be copied

Button items

Button order for carousel types

Create Message creative

Basic information

Request

Header

Body

MessageElement

ButtonAssetGroup

ItemAssetGroup

Response

Body

Sample

Request

Response

Edit Message creative

Basic information

Request

Header

Body

Response

Body

Sample

Request

Response

Copy Message creative

Basic information

Request

Header

Body

Response

Body

MessageCreative

Sample

Request

Response

See more

Was this helpful?