사이드 메뉴
Getting started
Kakao Developers
Login
Communication
Advertisement
- Concepts
- Ad creation: Ad account
- Ad creation: Campaign
- Ad creation: Ad group
- Targeting for ad group
- Custom audience targeting for ad group
- Ad creation: Creative common
- Ad creation: Display creative
- Ad creation: Message creative
- Ad creation: Personalized message creative
- Bizboard landing settings
- Report
- Message management
- Personalized message management
- Message ad management
- Message ad operation
- Ad View management
- Business Form+ management
- Business Form linkage management
- Pixel & SDK linkage management
- Audience management
- Engagement targeting management
- Customer file management
- Friend group management
- Ad account management
- Reference
- Type information
- Error code
Business Form linkage management
This document describes how to use the Business Form linkage management APIs.
| Method | URL | Authorization |
|---|---|---|
GET | https://apis.moment.kakao.com/openapi/v4/talkBizForms/linkages | 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 |
Retrieves the list of Business Forms with permission granted to the designated ad account.
You can check the detailed information of the Business Form created with your Kakao Account in [비즈니스 도구(Business tools)] > [비즈니스폼(Business Form)] in Business Partner Center.
Send a GET 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 list of the Business Forms in JSON format. If failed, refer to Error code to figure out its failure cause.
| 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 |
| Name | Type | Description |
|---|---|---|
| - | BusinessForm[] | List of Business Forms. |
Request
curl -X GET "https://apis.moment.kakao.com/openapi/v4/talkBizForms/linkages" \-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \-H "adAccountId: ${AD_ACCOUNT_ID}"
Response
// HTTP/1.1 200 OK// Content-Type: application/json;charset=UTF-8[{"id": 1,"adAccountId": 1234,"bizFormId": 1111,"title": "first_talk_business_form","flowType": "SURVEY","linkedDate": "2020-01-01 00:00:00","beginDate": "2020-02-01 00:00","endDate": "2020-03-01 00:00"}]
| Method | URL | Authorization |
|---|---|---|
GET | https://apis.moment.kakao.com/openapi/v4/talkBizForms/linkables | 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 |
Retrieves the list of Business Forms that permission can be added to.
Send a GET 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 list of the Business Forms in JSON format. If failed, refer to Error code to figure out its failure cause.
| 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 |
| Name | Type | Description |
|---|---|---|
| - | LinkablesBusinessForm[] | List of Business Forms. |
| Name | Type | Description |
|---|---|---|
| bizFormId | Long | Business Form's ID. Pass bizFormId when requesting the Link Business Form API. |
| title | String | Business Form's name. |
| flowType | String | Business Form type One of: APPLY (바로응모형)SURVEY (설문조사형)RESERV (신청예약형) |
| beginDate | String | Start time of delivery period in yyyy-MM-dd'T'HH:mm:ss format. |
| endDate | String | End time of delivery period in yyyy-MM-dd'T'HH:mm:ss format. |
Request
curl -X GET "https://apis.moment.kakao.com/openapi/v4/talkBizForms/linkables" \-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \-H "adAccountId: ${AD_ACCOUNT_ID}"
Response
// HTTP/1.1 200 OK// Content-Type: application/json;charset=UTF-8[{"bizFormId": 5678,"adAccountId": 1234,"title": "first_talk_business_form","flowType": "APPLY","beginDate": "2020-02-01 00:00","endDate": "2020-03-01 00:00"}]
| Method | URL | Authorization |
|---|---|---|
POST | https://apis.moment.kakao.com/openapi/v4/talkBizForms | 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 link a specific Business Form to an ad account.
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 information of the added Business Form. If failed, refer to Error code to figure out its failure cause.
| 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 |
| Name | Type | Description | Required |
|---|---|---|---|
| bizFormId | Long | Business Form's ID. | O |
| Name | Type | Description |
|---|---|---|
| id | Long | Business Form's linkage ID. |
| adAccount | Long | Ad account's ID. |
| bizFormId | Long | Business Form's ID. |
| title | String | Business Form's title. |
| flowType | String | Business Form type One of: APPLY (바로응모형)SURVEY (설문조사형)RESERV (신청예약형) |
| beginDate | String | Start time of delivery period in yyyy-MM-dd'T'HH:mm:ss format. |
| endDate | String | End time of delivery period in yyyy-MM-dd'T'HH:mm:ss format. |
| linkedDate | String | Linkage time in yyyy-MM-dd'T'HH:mm:ss format. |
Request
curl -X POST "https://apis.moment.kakao.com/openapi/v4/talkBizForms" \-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}"-H "adAccountId: ${AD_ACCOUNT_ID}"-d '{"bizFormId": ${BIZ_FORM_ID}}'
Response
// HTTP/1.1 200 OK// Content-Type: application/json;charset=UTF-8{"id": 1,"adAccountId": 1234,"bizFormId": 1,"title": "first_talk_business_form","flowType": "APPLY","linkedDate": "2020-01-01 15:00:00","beginDate": "2020-02-01 00:00","endDate": "2020-03-01 00:00"}