Kakao MomentBusiness Form+ management
This document explains how to use the Business Form+ API.
Get Business Form+ response
| Method | URL | Authorization |
|---|
GET | https://apis.moment.kakao.com/openapi/v4/adAccounts/bizFormPlus/report | |
Returns the response results of Business Form+ created in an ad account.
To call the Business Form+ response result retrieval API, you must meet the below conditions.
- The business registration numbers registered in the Kakao Developers app and the ad account must match.
- User consent to the consent item for retrieving Business Form+ response results among the Business access permission consent items.
- Hold permission for the Moment ad account to retrieve and form report download permission for the form ID to retrieve.
| Name | Description | Required |
|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} Auth header for the request, authenticated with a Business token | O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID} Ad account ID | O |
| Name | Type | Description | Required |
|---|
| formId | String | Business Form+ form ID (Example: MA-1111) | O |
| cursorId | Long | Cursor ID for pagination | X |
| size | Integer | Number of records to retrieve (Default: 100, Maximum: 1,000) | X |
| Name | Type | Description |
|---|
| code | Integer | Error code |
| message | String | Result message |
| data | Data[] | Detailed data for each report item |
| hasNext | Boolean | Whether a next page exists |
| nextCursor | Long | Cursor ID for the next page request |
| Name | Type | Description |
|---|
| applyId | Long | Response ID |
| submittedAt | String | Response submission date and time |
| expiresAt | String | Response expiration date and time, 90 days after submission |
| email | String | Email |
| birthDate | String | Birth date in YYYY-MM-DD format |
| gender | String | Gender, one of the following:
|
| name | String | Name |
| phoneNumber | String | Phone number |
| address | String | Address |
| answers | Answer[] | Survey response values |
| optionalAgreements | OptionalAgreement[] | List of optional consent items |
| channelAddStatus | String | Channel add status (Example: -, already added, Y, N) |
| inflowSource | String | Inflow source (for example, Moment or ETC) |
| kakaoResponseUse | Boolean | Whether the user agreed to use responses to improve participation-based ads, included in the response only when used in forms.
Y: Consented.
N: Not consented.
|
| Name | Type | Description |
|---|
| question | String | Question |
| answer | String | Answer |
| Name | Type | Description |
|---|
| title | String | Title |
| agree | Boolean | Whether the user agreed |