본문 바로가기메인 메뉴 바로가기사이드 메뉴 바로가기

kakao developers

Related sites
  • Docs
  • Kakao Moment
  • Reference

사이드 메뉴

Docs Home

Getting started

Kakao Developers

Login

Communication

Kakao Map

Navigation

Advertisement

Search

More

Kakao Moment

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

URLMethodNameLimit
/openapi/v4/adAccounts/pagesGETView list of ad accounts-
/openapi/v4/adAccounts/${AD_ACCOUNT_ID}GETView ad account-
/openapi/v4/adAccounts/balanceGETView real-time balance-
/openapi/v4/adAccounts/bizRightGETView business right-
/openapi/v4/adAccounts/channel/profilesGETView list of Kakao Talk Channel profiles-
/openapi/v4/adAccounts/trackersGETView Pixel & SDK-
/openapi/v4/adAccountsPOSTCreate ad account1 per second
/openapi/v4/adAccounts/onOffPUTChange ad account status1 per second

Ad creation: Campaign

URLMethodNameLimit
/openapi/v4/campaignsGETView list of campaigns-
/openapi/v4/campaigns/${ID}GETView campaigns-
/openapi/v4/campaignsPOSTCreate campaign-
/openapi/v4/campaignsPUTEdit campaign-
/openapi/v4/campaigns/dailyBudgetAmountPUTEdit daily budget for Display campaign1 per second
/openapi/v4/campaigns/onOffPUTChange campaign status1 per second
/openapi/v4/campaigns/${ID}DELETEDelete campaign-
/openapi/v4/campaigns/${ID}/latestSystemConfigHistoryGETView reason for system stop-
/openapi/v4/campaigns/${ID}/systemConfigHistoriesGETView list of reasons for system stop-

Ad creation: Ad group

URLMethodNameLimit
/openapi/v4/adGroupsGETView list of ad groups-
/openapi/v4/adGroups/${ID}GETView ad group-
/openapi/v4/adGroupsPOSTCreate Display ad group1 per 5 seconds
/openapi/v4/adGroupsPUTEdit Display ad group1 per 5 seconds
/openapi/v4/adGroups/dailyBudgetAmountPUTEdit daily budget for Display ad group1 per second
/openapi/v4/adGroups/bidAmountPUTEdit maximum bid for Display ad group1 per second
/openapi/v4/adGroups/pacingPUTEdit spending method for Display ad group1 per second
/openapi/v4/adGroupsPOSTCreate Message ad group1 per 5 seconds
/openapi/v4/adGroupsPUTEdit Message ad group1 per 5 seconds
/openapi/v4/targetings/populationScorePOSTRetrieve estimated target population for Message ad group-
/openapi/v4/adGroupsPOSTCreate Personalized message ad group1 per 5 seconds
/openapi/v4/adGroupsPUTEdit Personalized message ad group1 per 5 seconds
/openapi/v4/adGroups/onOffPUTChange ad group status1 per second
/openapi/v4/adGroups/cancel/${ID}PUTCancel contract for Message ad group-
/openapi/v4/adGroups/${ID}DELETEDelete ad group-
/openapi/v4/adGroups/${ID}/adminStopHistoryGETView reason for system stop-
/openapi/v4/adGroups/${ID}/adminStopHistoriesGETView list of reasons for system stop-

Targeting for ad group

URLMethodNameLimit
/openapi/v4/targetings/location/depth1GETView city/province-
/openapi/v4/targetings/location/depth2GETView city/county/district-
/openapi/v4/targetings/location/mapGETView neighborhood/town/township-
/openapi/v4/targetings/placement/adServingCategoriesGETView categories of Network for placements-
/openapi/v4/targetings/placement/sectionCategoriesGETView list of section categories-
/openapi/v4/adGroups/targetings/cohort/availablesGETView targetable engagement targets-
/openapi/v4/adGroups/targetings/trackers/eventCreatables/${TRACK_ID}GETView targetable Pixel & SDK events-
/openapi/v4/adGroups/targetings/customerFiles/availablesGETView list of targetable customer files-
/openapi/v4/adGroups/targetings/talkChannels/availablesGETView list of targetable Kakao Talk Channels-
/openapi/v4/adGroups/targetings/syncProfiles/availablesGETView list of targetable Kakao Login users-
/openapi/v4/adGroups/targetings/talkChannelGroupFiles/availablesGETView list of targetable Friend groups-
Custom audience targeting for ad group
URLMethodNameLimit
/openapi/v4/targetings/data/categories?type=INTERESTGETView category data for custom audience targeting-
/openapi/v4/targetings/location/mapGETView location for custom audience targeting-

Ad creation: Creative

URLMethodNameLimit
/openapi/v4/creativesGETView list of creatives-
/openapi/v4/creatives/${ID}GETView creative-
/openapi/v4/creativesPOSTCreate Display creative1 per second
/openapi/v4/creativesPUTEdit Display creative1 per second
/openapi/v4/creatives/copyPOSTCopy Display creative1 per 5 seconds
/openapi/v4/creatives/${ID}/opinionProofGETRetrieve materials for Display ad verification-
/openapi/v4/creativesPOSTCreate Message creative1 per second
/openapi/v4/creativesPUTEdit Message creative1 per second
/openapi/v4/creatives/copyPOSTCopy Message creative1 per 5 seconds
/openapi/v4/creativesPOSTCreate Personalized message creative template1 per second
/openapi/v4/creativesPUTEdit Personalized message creative template1 per second
/openapi/v4/creatives/onOffPUTChange creative status1 per second
/openapi/v4/creatives/${ID}DELETEDelete creative-
/openapi/v4/creatives/${ID}/systemConfigHistoryGETView reason for system stop-
/openapi/v4/creatives/${ID}/systemConfigHistoriesGETView list of reasons for system stop-

Bizboard landing settings

URLMethodNameLimit
/openapi/v4/creatives/landing/talkBizFormsGETView list of Business Forms for landing settings-
/openapi/v4/creatives/landing/adViewsGETView list of Ad Views for landing settings-
/openapi/v4/creatives/landing/channelPosts/${PROFILE_ID}GETView list of Channel Posts for landing settings-

Report

URLMethodNameLimit
/openapi/v4/adAccounts/reportGETView report on ad account1 per 5 seconds
/openapi/v4/campaigns/reportGETView reports on campaigns1 per 5 seconds
/openapi/v4/adGroups/reportGETView reports on ad groups1 per 1 second
/openapi/v4/creatives/reportGETView reports on creatives1 per 5 seconds

Message management

URLMethodNameLimit
/openapi/v4/messages/kakaotv/channelsGETView list of Kakao TV channels-
/openapi/v4/messages/kakaotv/channels/${ID}GETView details of Kakao TV channel-
/openapi/v4/messages/kakaotv/channels/${ID}/clipLinksGETView list of Kakao TV channel videos-
/openapi/v4/messages/kakaotv/channels/
${CHANNEL_ID}/clipLinks/${CLIP_LINK_ID}		GETView details of Kakao TV channel video-
/openapi/v4/messages/couponsGETView list of coupons-
/openapi/v4/messages/coupons/${ID}GETView details of coupon-
/openapi/v4/messages/adViewsGETView list of Ad Views-
/openapi/v4/messages/posts/${PROFILE_ID}GETView list of posts-
/openapi/v4/messages/bizFormsGETView list of Business Forms-
/openapi/v4/messages/bizForms/${BIZ_FORM_ID}GETView details of Business Form-

Personalized message management

URLMethodNameLimit
/openapi/v4/messages/creatives/${ID}/sendTestPersonalMessagePOSTTest sending personalized message1 per 1 minute
/openapi/v4/messages/creatives/1/sendPersonalMessagePOSTSend a personalized messsage-
/openapi/v4/messages/creatives/${ID}/sendPersonalMessages POSTSend multiple personalized meesage-
/openapi/v4/messages/creatives/${ID}/statuses/${REQUEST_ID}GETRetrieve sending status-
/openapi/v4/messages/personal/images/uploadPOSTUpload image for personalized message-
/openapi/v4/messages/personal/videos/registerPOSTSet video for personalized message-

Message ad management

URLMethodNameLimit
/openapi/message/v2/message-adsPOSTView list of message ads-
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}GETView message ad-
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}DELETEDelete message ad-
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/messageGETView messages-
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/copyPOSTCopy message-
/openapi/message/v2/message-ads/reportsPOSTView message ad report-

Message ad operation

URLMethodNameLimit
/openapi/message/v2/message-ads/messagePOSTSave message ad-
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/messagePATCHEdit message-
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/send-testPOSTSend test message ad-
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/sending-reservationPOSTCreate scheduled message ad-
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/sending-reservationGETView scheduled message ads-
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/sending-reservationPATCHEdit scheduled message ad-
/openapi/message/v2/message-ads/sending-reservation/locationGETView targeting locations-
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/sending-reservation/targeting-pricePOSTView targeting audience and price-
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/finishPUTFinish message ad-

Ad View management

URLMethodNameLimit
/openapi/v4/adViewsGETView list of Ad Views-
/openapi/v4/adViews/${ID}GETView Ad View-
/openapi/v4/adViews/${ID}DELETEDelete Ad View-

Business Form linkage management

URLMethodNameLimit
/openapi/v4/talkBizForms/linkagesGETView list of linked Business Forms-
/openapi/v4/talkBizForms/linkablesGETView list of linkable Business Forms-
/openapi/v4/talkBizFormsPOSTLink business form-

Pixel & SDK linkage management

URLMethodNameLimit
/openapi/v4/trackers/rightsGETView list of linked Pixel & SDKs1 per 5 seconds
/openapi/v4/trackers/rightAvailablesGETView list of linkable Pixel & SDKs-
/openapi/v4/trackersPOSTLink Pixel & SDK-
/openapi/v4/trackers/${ID}DELETEUnlink Pixel & SDK-

Audience management

URLMethodNameLimit
/openapi/v4/targetings/audiencesGETView list of Audiences-
/openapi/v4/targetings/${ID}GETView details of Audience-
/openapi/v4/targetingsPOSTCreate Audience-
/openapi/v4/targetingsPUTEdit Audience-
/openapi/v4/targetings/${ID}DELETEDelete Audience-
/openapi/v4/targetingsDELETEDelete multiple Audiences-
/openapi/v4/targetings/${ID}/adGroupsGETView usage of Audience-
/openapi/v4/targetings/${ID}/unlink?adGroupId=${AD_GROUP_ID}PUTDisable use of Audience-

Engagement targeting management

URLMethodNameLimit
/openapi/v4/targetings/cohort/listGETView list of engagement targets-
/openapi/v4/targetings/cohort/${ID}GETView engagement target-
/openapi/v4/targetings/cohort/creatablesGETView creatable engagement targets-
/openapi/v4/targetings/cohortPOSTCreate engagement target1 per second
/openapi/v4/targetings/cohort/namePUTEdit name of engagement target1 per second
/openapi/v4/targetings/cohortPUTEdit data of engagement target-
/openapi/v4/targetings/cohort/${ID}DELETEDelete engagement target1 per second
/openapi/v4/targetings/cohortDELETEDelete multiple engagement targets1 per second
/openapi/v4/targetings/cohort/usages/${ID}GETView usage of engagement target-

Customer file management

URLMethodNameLimit
/openapi/v4/customerFilesGETView list of customer files-
/openapi/v4/customerFiles/${ID}GETView details of customer file1 per 5 seconds
/openapi/v4/customerFilesPOSTRegister customer file1 per 5 seconds
/openapi/v4/customerFilesPUTEdit customer file-
/openapi/v4/customerFiles/namePUTEdit customer file name-
/openapi/v4/customerFiles/${ID}DELETEDelete customer file-
/openapi/v4/customerFilesDELETEDelete multiple customer files-
/openapi/v4/customerFiles/usages/${ID}GETView usage of customer file-

Friend group management

URLMethodNameLimit
/openapi/v4/talkChannelGroupFilesGETView list of Friend groups-
/openapi/v4/talkChannelGroupFilePOSTRegister Friend group1 per 5 seconds
/openapi/v4/talkChannelGroupFiles/namePUTEdit Friend group name-
/openapi/v4/talkChannelGroupFiles/${ID}DELETEDelete Friend group-
/openapi/v4/talkChannelGroupFilesDELETEDelete multiple Friend groups-
/openapi/v4/talkChannelGroupFiles/usages/${ID}GETView usage of Friend group-

Ad account management

URLMethodNameLimit
/openapi/v4/companiesGETView business information-

Response code

HTTP status code

Status codeStatusDescription
200Success-
400FailGeneral error
Errors related to the required parameters for APIs
401FailAuthorization error
(Mostly related to user tokens)
403FailPermission Error
429FailQuota error
Errors that occurs when quota limit exceeds
500FailSystem error
502FailSystem error
503FailUndergoing system maintenance

Error code

See Error code.

Was this helpful?