Kakao Moment API Reference
This document provides the supported APIs of Kakao Moment and response information.
API list
- Host:
apis.moment.kakao.com
Ad creation: Ad account
| URL |
Method |
Name |
Limit |
/openapi/v4/adAccounts/pages |
GET |
View list of ad accounts |
|
/openapi/v4/adAccounts/${AD_ACCOUNT_ID} |
GET |
View ad account |
|
/openapi/v4/adAccounts/balance |
GET |
View real-time balance |
|
/openapi/v4/adAccounts/bizRight |
GET |
View business right |
|
/openapi/v4/adAccounts/channel/profiles |
GET |
View list of Kakao Talk Channel profiles |
|
/openapi/v4/adAccounts/trackers |
GET |
View Pixel & SDK |
|
/openapi/v4/adAccounts |
POST |
Create ad account |
1 per second |
/openapi/v4/adAccounts/onOff |
PUT |
Change ad account status |
1 per second |
Ad creation: Campaign
| URL |
Method |
Name |
Limit |
/openapi/v4/campaigns |
GET |
View list of campaigns |
|
/openapi/v4/campaigns/${ID} |
GET |
View campaigns |
|
/openapi/v4/campaigns |
POST |
Create campaign |
|
/openapi/v4/campaigns |
PUT |
Edit campaign |
|
/openapi/v4/campaigns/dailyBudgetAmount |
PUT |
Edit daily budget for Display campaign |
1 per second |
/openapi/v4/campaigns/onOff |
PUT |
Change campaign status |
1 per second |
/openapi/v4/campaigns/${ID} |
DELETE |
Delete campaign |
|
/openapi/v4/campaigns/${ID}/latestSystemConfigHistory |
GET |
View reason for system stop |
|
/openapi/v4/campaigns/${ID}/systemConfigHistories |
GET |
View list of reasons for system stop |
|
Ad creation: Ad group
| URL |
Method |
Name |
Limit |
/openapi/v4/adGroups |
GET |
View list of ad groups |
|
/openapi/v4/adGroups/${ID} |
GET |
View ad group |
|
/openapi/v4/adGroups |
POST |
Create Display ad group |
1 per 5 seconds |
/openapi/v4/adGroups |
PUT |
Edit Display ad group |
1 per 5 seconds |
/openapi/v4/adGroups/dailyBudgetAmount |
PUT |
Edit daily budget for Display ad group |
1 per second |
/openapi/v4/adGroups/bidAmount |
PUT |
Edit maximum bid for Display ad group |
1 per second |
/openapi/v4/adGroups/pacing |
PUT |
Edit spending method for Display ad group |
1 per second |
/openapi/v4/adGroups |
POST |
Create Message ad group |
1 per 5 seconds |
/openapi/v4/adGroups |
PUT |
Edit Message ad group |
1 per 5 seconds |
/openapi/v4/targetings/populationScore |
POST |
Retrieve estimated target population for Message ad group |
|
/openapi/v4/adGroups |
POST |
Create Personalized message ad group |
1 per 5 seconds |
/openapi/v4/adGroups |
PUT |
Edit Personalized message ad group |
1 per 5 seconds |
/openapi/v4/adGroups/onOff |
PUT |
Change ad group status |
1 per second |
/openapi/v4/adGroups/cancel/${ID} |
PUT |
Cancel contract for Message ad group |
|
/openapi/v4/adGroups/${ID} |
DELETE |
Delete ad group |
|
/openapi/v4/adGroups/${ID}/adminStopHistory |
GET |
View reason for system stop |
|
/openapi/v4/adGroups/${ID}/adminStopHistories |
GET |
View list of reasons for system stop |
|
Targeting for ad group
| URL |
Method |
Name |
Limit |
/openapi/v4/targetings/location/depth1 |
GET |
View city/province |
|
/openapi/v4/targetings/location/depth2 |
GET |
View city/county/district |
|
/openapi/v4/targetings/location/map |
GET |
View neighborhood/town/township |
|
/openapi/v4/targetings/placement/adServingCategories |
GET |
View categories of Network for placements |
|
/openapi/v4/targetings/placement/sectionCategories |
GET |
View list of section categories |
|
/openapi/v4/adGroups/targetings/cohort/availables |
GET |
View targetable engagement targets |
|
/openapi/v4/adGroups/targetings/trackers/eventCreatables/${TRACK_ID} |
GET |
View targetable Pixel & SDK events |
|
/openapi/v4/adGroups/targetings/customerFiles/availables |
GET |
View list of targetable customer files |
|
/openapi/v4/adGroups/targetings/talkChannels/availables |
GET |
View list of targetable Kakao Talk Channels |
|
/openapi/v4/adGroups/targetings/syncProfiles/availables |
GET |
View list of targetable Kakao Login users |
|
/openapi/v4/adGroups/targetings/talkChannelGroupFiles/availables |
GET |
View list of targetable Friend groups |
|
Custom audience targeting for ad group
| URL |
Method |
Name |
Limit |
/openapi/v4/targetings/data/categories?type=INTEREST |
GET |
View category data for custom audience targeting |
|
/openapi/v4/targetings/location/map |
GET |
View location for custom audience targeting |
|
Ad creation: Creative
| URL |
Method |
Name |
Limit |
/openapi/v4/creatives |
GET |
View list of creatives |
|
/openapi/v4/creatives/${ID} |
GET |
View creative |
|
/openapi/v4/creatives |
POST |
Create Display creative |
1 per second |
/openapi/v4/creatives |
PUT |
Edit Display creative |
1 per second |
/openapi/v4/creatives/copy |
POST |
Copy Display creative |
1 per 5 seconds |
/openapi/v4/creatives/${ID}/opinionProof |
GET |
Retrieve materials for Display ad verification |
|
/openapi/v4/creatives |
POST |
Create Message creative |
1 per second |
/openapi/v4/creatives |
PUT |
Edit Message creative |
1 per second |
/openapi/v4/creatives/copy |
POST |
Copy Message creative |
1 per 5 seconds |
/openapi/v4/creatives |
POST |
Create Personalized message creative template |
1 per second |
/openapi/v4/creatives |
PUT |
Edit Personalized message creative template |
1 per second |
/openapi/v4/creatives/onOff |
PUT |
Change creative status |
1 per second |
/openapi/v4/creatives/${ID} |
DELETE |
Delete creative |
|
/openapi/v4/creatives/${ID}/systemConfigHistory |
GET |
View reason for system stop |
|
/openapi/v4/creatives/${ID}/systemConfigHistories |
GET |
View list of reasons for system stop |
|
Bizboard landing settings
| URL |
Method |
Name |
Limit |
/openapi/v4/creatives/landing/talkBizForms |
GET |
View list of Business Forms for landing settings |
|
/openapi/v4/creatives/landing/adViews |
GET |
View list of Ad Views for landing settings |
|
/openapi/v4/creatives/landing/channelPosts/${PROFILE_ID} |
GET |
View list of Channel Posts for landing settings |
|
Report
| URL |
Method |
Name |
Limit |
/openapi/v4/adAccounts/report |
GET |
View report on ad account |
1 per 5 seconds |
/openapi/v4/campaigns/report |
GET |
View reports on campaigns |
1 per 5 seconds |
/openapi/v4/adGroups/report |
GET |
View reports on ad groups |
1 per 1 second |
/openapi/v4/creatives/report |
GET |
View reports on creatives |
1 per 5 seconds |
Message management
| URL |
Method |
Name |
Limit |
/openapi/v4/messages/kakaotv/channels |
GET |
View list of Kakao TV channels |
|
/openapi/v4/messages/kakaotv/channels/${ID} |
GET |
View details of Kakao TV channel |
|
/openapi/v4/messages/kakaotv/channels/${ID}/clipLinks |
GET |
View list of Kakao TV channel videos |
|
/openapi/v4/messages/kakaotv/channels/
${CHANNEL_ID}/clipLinks/${CLIP_LINK_ID} |
GET |
View details of Kakao TV channel video |
|
/openapi/v4/messages/coupons |
GET |
View list of coupons |
|
/openapi/v4/messages/coupons/${ID} |
GET |
View details of coupon |
|
/openapi/v4/messages/adViews |
GET |
View list of Ad Views |
|
/openapi/v4/messages/posts/${PROFILE_ID} |
GET |
View list of posts |
|
/openapi/v4/messages/bizForms |
GET |
View list of Business Forms |
|
/openapi/v4/messages/bizForms/${BIZ_FORM_ID} |
GET |
View details of Business Form |
|
Personalized message management
| URL |
Method |
Name |
Limit |
/openapi/v4/messages/creatives/${ID}/sendTestPersonalMessage |
POST |
Test sending personalized message |
1 per 1 minute |
/openapi/v4/messages/creatives/1/sendPersonalMessage |
POST |
Send a personalized messsage |
|
/openapi/v4/messages/creatives/${ID}/sendPersonalMessages |
POST |
Send multiple personalized meesage |
|
/openapi/v4/messages/creatives/${ID}/statuses/${REQUEST_ID} |
GET |
Retrieve sending status |
|
/openapi/v4/messages/personal/images/upload |
POST |
Upload image for personalized message |
|
/openapi/v4/messages/personal/videos/register |
POST |
Set video for personalized message |
|
Message ad management
| URL |
Method |
Name |
Limit |
/openapi/message/v2/message-ads |
POST |
View list of message ads |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID} |
GET |
View message ad |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID} |
DELETE |
Delete message ad |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/message |
GET |
View messages |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/copy |
POST |
Copy message |
|
/openapi/message/v2/message-ads/reports |
POST |
View message ad report |
|
Message ad operation
| URL |
Method |
Name |
Limit |
/openapi/message/v2/message-ads/message |
POST |
Save message ad |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/message |
PATCH |
Edit message |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/send-test |
POST |
Send test message ad |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/sending-reservation |
POST |
Create scheduled message ad |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/sending-reservation |
GET |
View scheduled message ads |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/sending-reservation |
PATCH |
Edit scheduled message ad |
|
/openapi/message/v2/message-ads/sending-reservation/location |
GET |
View targeting locations |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/sending-reservation/targeting-price |
POST |
View targeting audience and price |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/finish |
PUT |
Finish message ad |
|
Ad View management
| URL |
Method |
Name |
Limit |
/openapi/v4/adViews |
GET |
View list of Ad Views |
|
/openapi/v4/adViews/${ID} |
GET |
View Ad View |
|
/openapi/v4/adViews/${ID} |
DELETE |
Delete Ad View |
|
Business Form linkage management
| URL |
Method |
Name |
Limit |
/openapi/v4/talkBizForms/linkages |
GET |
View list of linked Business Forms |
|
/openapi/v4/talkBizForms/linkables |
GET |
View list of linkable Business Forms |
|
/openapi/v4/talkBizForms |
POST |
Link Business Form |
|
Pixel & SDK linkage management
| URL |
Method |
Name |
Limit |
/openapi/v4/trackers/rights |
GET |
View list of linked Pixel & SDKs |
1 per 5 seconds |
/openapi/v4/trackers/rightAvailables |
GET |
View list of linkable Pixel & SDKs |
|
/openapi/v4/trackers |
POST |
Link Pixel & SDK |
|
/openapi/v4/trackers/${ID} |
DELETE |
Unlink Pixel & SDK |
|
Audience management
| URL |
Method |
Name |
Limit |
/openapi/v4/targetings/audiences |
GET |
View list of Audiences |
|
/openapi/v4/targetings/${ID} |
GET |
View details of Audience |
|
/openapi/v4/targetings |
POST |
Create Audience |
|
/openapi/v4/targetings |
PUT |
Edit Audience |
|
/openapi/v4/targetings/${ID} |
DELETE |
Delete Audience |
|
/openapi/v4/targetings |
DELETE |
Delete multiple Audiences |
|
/openapi/v4/targetings/${ID}/adGroups |
GET |
View usage of Audience |
|
/openapi/v4/targetings/${ID}/unlink?adGroupId=${AD_GROUP_ID} |
PUT |
Disable use of Audience |
|
Engagement targeting management
| URL |
Method |
Name |
Limit |
/openapi/v4/targetings/cohort/list |
GET |
View list of engagement targets |
|
/openapi/v4/targetings/cohort/${ID} |
GET |
View engagement target |
|
/openapi/v4/targetings/cohort/creatables |
GET |
View creatable engagement targets |
|
/openapi/v4/targetings/cohort |
POST |
Create engagement target |
1 per second |
/openapi/v4/targetings/cohort/name |
PUT |
Edit name of engagement target |
1 per second |
/openapi/v4/targetings/cohort |
PUT |
Edit data of engagement target |
|
/openapi/v4/targetings/cohort/${ID} |
DELETE |
Delete engagement target |
1 per second |
/openapi/v4/targetings/cohort |
DELETE |
Delete multiple engagement targets |
1 per second |
/openapi/v4/targetings/cohort/usages/${ID} |
GET |
View usage of engagement target |
|
Customer file management
| URL |
Method |
Name |
Limit |
/openapi/v4/customerFiles |
GET |
View list of customer files |
|
/openapi/v4/customerFiles/${ID} |
GET |
View details of customer file |
1 per 5 seconds |
/openapi/v4/customerFiles |
POST |
Register customer file |
1 per 5 seconds |
/openapi/v4/customerFiles |
PUT |
Edit customer file |
|
/openapi/v4/customerFiles/name |
PUT |
Edit customer file name |
|
/openapi/v4/customerFiles/${ID} |
DELETE |
Delete customer file |
|
/openapi/v4/customerFiles |
DELETE |
Delete multiple customer files |
|
/openapi/v4/customerFiles/usages/${ID} |
GET |
View usage of customer file |
|
Friend group management
| URL |
Method |
Name |
Limit |
/openapi/v4/talkChannelGroupFiles |
GET |
View list of Friend groups |
|
/openapi/v4/talkChannelGroupFile |
POST |
Register Friend group |
1 per 5 seconds |
/openapi/v4/talkChannelGroupFiles/name |
PUT |
Edit Friend group name |
|
/openapi/v4/talkChannelGroupFiles/${ID} |
DELETE |
Delete Friend group |
|
/openapi/v4/talkChannelGroupFiles |
DELETE |
Delete multiple Friend groups |
|
/openapi/v4/talkChannelGroupFiles/usages/${ID} |
GET |
View usage of Friend group |
|
Ad account management
| URL |
Method |
Name |
Limit |
/openapi/v4/companies |
GET |
View business information |
|
Response code
HTTP status code
| Status code |
Status |
Description |
| 200 |
Success |
|
| 400 |
Fail |
General error
Errors related to the required parameters for APIs |
| 401 |
Fail |
Authorization error
(Mostly related to user tokens) |
| 403 |
Fail |
Permission Error |
| 429 |
Fail |
Quota error
Errors that occurs when quota limit exceeds |
| 500 |
Fail |
System error |
| 502 |
Fail |
System error |
| 503 |
Fail |
Undergoing system maintenance |
Error code
See Error code.
