AT AppointmentTrader
サインイン
オンライン中  

/v1/customer_survey/

Seller-private customer surveys with customer-confirmed answer reuse.
GET

/v1/customer_survey/get_catalog

#
List AT and private templates, reusable fields, and optional chat recipient/sales context. Never returns customer answers.

パラメーター

名前型必須既定値説明
chatID int いいえ 0 Accepted direct or bid chat; zero lists the acting seller's catalog.
リクエスト例（cURL） 
curl --get \
  'https://jp.appointmenttrader.com/v1/customer_survey/get_catalog' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'chatID={{chatID}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$customer_survey_get_catalog_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.fieldsarray はい
$.oneOf[0].allOf[1].Payload.fields[]object いいえ
$.oneOf[0].allOf[1].Payload.fields[].IDDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.fields[].ID.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.fields[].ID.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.fields[].CreatedDatestring はい
$.oneOf[0].allOf[1].Payload.fields[].OwnerUserID はい
$.oneOf[0].allOf[1].Payload.fields[].OwnerUserID.anyOf[0]DatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.fields[].OwnerUserID.anyOf[0].oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.fields[].OwnerUserID.anyOf[0].oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.fields[].OwnerUserID.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.fields[].FieldKeystring はい
$.oneOf[0].allOf[1].Payload.fields[].Labelstring はい
$.oneOf[0].allOf[1].Payload.fields[].LabelKey はい
$.oneOf[0].allOf[1].Payload.fields[].LabelKey.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.fields[].LabelKey.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.fields[].FieldGroupstring はい
$.oneOf[0].allOf[1].Payload.fields[].FieldTypestring ["text","number","boolean","single_select","multi_select","longtext"] はい
$.oneOf[0].allOf[1].Payload.fields[].ValueScopestring ["customer","booking"] はい
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSONstring (application/json) はい
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSONSurveyValidation (デコードされたJSON) はい
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0]object はい
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0].maxLengthinteger いいえ
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0].integerboolean いいえ
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0].minnumber いいえ
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0].maxnumber いいえ
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[1] = [] はい
$.oneOf[0].allOf[1].Payload.fields[].IsActiveDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.fields[].IsActive.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.fields[].IsActive.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.fields[].Optionsarray はい
$.oneOf[0].allOf[1].Payload.fields[].Options[]object いいえ
$.oneOf[0].allOf[1].Payload.fields[].Options[].IDDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.fields[].Options[].ID.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.fields[].Options[].ID.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.fields[].Options[].FieldIDDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.fields[].Options[].FieldID.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.fields[].Options[].FieldID.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.fields[].Options[].OptionKeystring はい
$.oneOf[0].allOf[1].Payload.fields[].Options[].Labelstring はい
$.oneOf[0].allOf[1].Payload.fields[].Options[].LabelKey はい
$.oneOf[0].allOf[1].Payload.fields[].Options[].LabelKey.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.fields[].Options[].LabelKey.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.fields[].Options[].SortOrderDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.fields[].Options[].SortOrder.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.fields[].Options[].SortOrder.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.templatesarray はい
$.oneOf[0].allOf[1].Payload.templates[]object いいえ
$.oneOf[0].allOf[1].Payload.templates[].IDDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.templates[].ID.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.templates[].ID.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.templates[].CreatedDatestring はい
$.oneOf[0].allOf[1].Payload.templates[].OwnerUserID はい
$.oneOf[0].allOf[1].Payload.templates[].OwnerUserID.anyOf[0]DatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.templates[].OwnerUserID.anyOf[0].oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.templates[].OwnerUserID.anyOf[0].oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.templates[].OwnerUserID.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.templates[].StarterKey はい
$.oneOf[0].allOf[1].Payload.templates[].StarterKey.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.templates[].StarterKey.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.templates[].SourceTemplateID はい
$.oneOf[0].allOf[1].Payload.templates[].SourceTemplateID.anyOf[0]DatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.templates[].SourceTemplateID.anyOf[0].oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.templates[].SourceTemplateID.anyOf[0].oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.templates[].SourceTemplateID.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.templates[].CurrentVersionID はい
$.oneOf[0].allOf[1].Payload.templates[].CurrentVersionID.anyOf[0]DatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.templates[].CurrentVersionID.anyOf[0].oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.templates[].CurrentVersionID.anyOf[0].oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.templates[].CurrentVersionID.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.templates[].ArchivedDate はい
$.oneOf[0].allOf[1].Payload.templates[].ArchivedDate.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.templates[].ArchivedDate.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.templates[].Titlestring はい
$.oneOf[0].allOf[1].Payload.templates[].TitleKey はい
$.oneOf[0].allOf[1].Payload.templates[].TitleKey.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.templates[].TitleKey.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.templates[].VersionNumberDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.templates[].VersionNumber.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.templates[].VersionNumber.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.context はい
$.oneOf[0].allOf[1].Payload.context.anyOf[0]object はい
$.oneOf[0].allOf[1].Payload.context.anyOf[0].canSendboolean はい
$.oneOf[0].allOf[1].Payload.context.anyOf[0].writableboolean はい
$.oneOf[0].allOf[1].Payload.context.anyOf[0].chatIDinteger はい
$.oneOf[0].allOf[1].Payload.context.anyOf[0].customerIDinteger はい
$.oneOf[0].allOf[1].Payload.context.anyOf[0].bidIDinteger はい
$.oneOf[0].allOf[1].Payload.context.anyOf[0].reasonCodestring いいえ
$.oneOf[0].allOf[1].Payload.context.anyOf[0].reasonstring いいえ
$.oneOf[0].allOf[1].Payload.context.anyOf[0].otherUserIDinteger いいえ
$.oneOf[0].allOf[1].Payload.context.anyOf[0].buyerIdentityHiddenboolean いいえTrue when the authenticated viewer cannot see the buyer during the current response race.
$.oneOf[0].allOf[1].Payload.context.anyOf[0].buyerIdentityHiddenUntilinteger | null いいえSaved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
$.oneOf[0].allOf[1].Payload.context.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.customer はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0]object はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].aliasstring | null はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].avatarstring | null はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].avatarEmojistring | null はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImageUrlstring | null はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImageURLstring | null はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].labelstring はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileUrlstring | null はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileURLstring | null はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].titlestring はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].customColorstring | null はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].customTextColorstring | null はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].avatarModestring | null はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].htmlstring はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].idinteger | null はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].userIDinteger | null はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].isRichboolean はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0]object はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].idinteger はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].thumbUrlstring はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].mediaUrlstring はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].mediaTypestring はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].widthinteger はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].heightinteger はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].titlestring はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].isImageboolean はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].isEmbeddedboolean はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].frameobject はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].frame.positionXPercentnumber はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].frame.positionYPercentnumber はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].frame.zoomPercentnumber はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].backgroundUrlstring いいえ
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].medalsarray はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].medals[]object いいえ
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].medals[].Namestring はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].medals[].URLstring はい
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].identityHiddenboolean いいえAn anonymized author has no profile or follow action.
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].identityHiddenUntilinteger | null いいえCurrent response-race closing timestamp in Unix seconds.
$.oneOf[0].allOf[1].Payload.customer.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.salesarray はい
$.oneOf[0].allOf[1].Payload.sales[]object いいえ
$.oneOf[0].allOf[1].Payload.sales[].IDDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.sales[].ID.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.sales[].ID.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.sales[].BidID はい
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[0]DatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[0].oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[0].oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID はい
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[0]DatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[0].oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[0].oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.sales[].TransactionCompletedDate はい
$.oneOf[0].allOf[1].Payload.sales[].TransactionCompletedDate.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.sales[].TransactionCompletedDate.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.sales[].LocationName はい
$.oneOf[0].allOf[1].Payload.sales[].LocationName.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.sales[].LocationName.anyOf[1]null はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/get_catalog",
    "RequestUserAlias": "example-user",
    "Payload": {
        "fields": [],
        "templates": [],
        "context": {
            "canSend": false,
            "writable": false,
            "chatID": 0,
            "customerID": 0,
            "bidID": 0
        },
        "customer": {
            "alias": "synthetic-example",
            "avatar": "synthetic-example",
            "avatarEmoji": "synthetic-example",
            "profileImageUrl": "synthetic-example",
            "profileImageURL": "synthetic-example",
            "label": "synthetic-example",
            "profileUrl": "synthetic-example",
            "profileURL": "synthetic-example",
            "title": "synthetic-example",
            "customColor": "synthetic-example",
            "customTextColor": "synthetic-example",
            "avatarMode": "synthetic-example",
            "html": "synthetic-example",
            "id": 0,
            "userID": 0,
            "isRich": false,
            "profileImage": {
                "id": 0,
                "thumbUrl": "synthetic-example",
                "mediaUrl": "synthetic-example",
                "mediaType": "synthetic-example",
                "width": 0,
                "height": 0,
                "title": "synthetic-example",
                "isImage": false,
                "isEmbedded": false,
                "frame": {
                    "positionXPercent": 0,
                    "positionYPercent": 0,
                    "zoomPercent": 100
                }
            },
            "medals": []
        },
        "sales": []
    }
}
機械可読のエンドポイントドキュメント
GET

/v1/customer_survey/get_customer_fields

#
Read own remembered values, or values this customer explicitly shared with the acting seller. Other sellers' responses are never returned.

パラメーター

名前型必須既定値説明
customerID int はい — Customer user ID.
リクエスト例（cURL） 
curl --get \
  'https://jp.appointmenttrader.com/v1/customer_survey/get_customer_fields' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'customerID={{customerID}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$customer_survey_get_customer_fields_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.canForgetboolean はい
$.oneOf[0].allOf[1].Payload.itemsarray はい
$.oneOf[0].allOf[1].Payload.items[]object いいえ
$.oneOf[0].allOf[1].Payload.items[].fieldIDinteger はい
$.oneOf[0].allOf[1].Payload.items[].labelstring はい
$.oneOf[0].allOf[1].Payload.items[].typestring ["text","longtext","number","boolean","single_select","multi_select"] はい
$.oneOf[0].allOf[1].Payload.items[].valueSurveyAnswerValue はいValue follows the question type: text or selected key, decimal numeric string, boolean, selected-key list, or null when unanswered.
$.oneOf[0].allOf[1].Payload.items[].value.anyOf[0]null はい
$.oneOf[0].allOf[1].Payload.items[].value.anyOf[1]string はい
$.oneOf[0].allOf[1].Payload.items[].value.anyOf[2]number はい
$.oneOf[0].allOf[1].Payload.items[].value.anyOf[3]boolean はい
$.oneOf[0].allOf[1].Payload.items[].value.anyOf[4]array はい
$.oneOf[0].allOf[1].Payload.items[].value.anyOf[4][]string いいえ
$.oneOf[0].allOf[1].Payload.items[].optionsarray はい
$.oneOf[0].allOf[1].Payload.items[].options[]object いいえ
$.oneOf[0].allOf[1].Payload.items[].options[].keystring はい
$.oneOf[0].allOf[1].Payload.items[].options[].labelstring はい
$.oneOf[0].allOf[1].Payload.items[].confirmedDate はい
$.oneOf[0].allOf[1].Payload.items[].confirmedDate.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.items[].confirmedDate.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.items[].requestIDinteger はい
$.oneOf[0].allOf[1].Payload.items[].sourceTitlestring はい
$.oneOf[0].allOf[1].Payload.items[].revisioninteger はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/get_customer_fields",
    "RequestUserAlias": "example-user",
    "Payload": {
        "canForget": false,
        "items": []
    }
}
機械可読のエンドポイントドキュメント
GET

/v1/customer_survey/get_request

#
Read a questionnaire. Only its customer receives drafts, remembered prefills and memory revisions. Sellers receive submitted history only.

パラメーター

名前型必須既定値説明
requestID int はい — Sent questionnaire identifier.
adminInspection bool いいえ false Explicit read-only inspection requiring AccessSpecialFunctions; logged with actor and request.
リクエスト例（cURL） 
curl --get \
  'https://jp.appointmenttrader.com/v1/customer_survey/get_request' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'requestID={{requestID}}' \
  --data-urlencode 'adminInspection={{adminInspection}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$customer_survey_get_request_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.requestobject はい
$.oneOf[0].allOf[1].Payload.request.idinteger はい
$.oneOf[0].allOf[1].Payload.request.revisioninteger はい
$.oneOf[0].allOf[1].Payload.request.customerIDinteger はい
$.oneOf[0].allOf[1].Payload.request.sellerIDinteger はい
$.oneOf[0].allOf[1].Payload.request.chatIDinteger はい
$.oneOf[0].allOf[1].Payload.request.bidIDinteger はい
$.oneOf[0].allOf[1].Payload.request.transactionIDinteger はい
$.oneOf[0].allOf[1].Payload.request.titlestring はい
$.oneOf[0].allOf[1].Payload.request.statusstring ["sent","in_progress","submitted","cancelled"] はい
$.oneOf[0].allOf[1].Payload.request.submittedDate はい
$.oneOf[0].allOf[1].Payload.request.submittedDate.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.request.submittedDate.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.request.urlstring はい
$.oneOf[0].allOf[1].Payload.request.buyerIdentityHiddenboolean いいえTrue when the authenticated viewer cannot see the buyer during the current response race.
$.oneOf[0].allOf[1].Payload.request.buyerIdentityHiddenUntilinteger | null いいえSaved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
$.oneOf[0].allOf[1].Payload.titlestring はい
$.oneOf[0].allOf[1].Payload.introductionstring はい
$.oneOf[0].allOf[1].Payload.questionsarray はい
$.oneOf[0].allOf[1].Payload.questions[]object いいえ
$.oneOf[0].allOf[1].Payload.questions[].IDDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].ID.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].ID.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.questions[].VersionIDDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].VersionID.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].VersionID.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.questions[].FieldID はい
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[0]DatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[0].oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[0].oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.questions[].QuestionKeystring はい
$.oneOf[0].allOf[1].Payload.questions[].Labelstring はい
$.oneOf[0].allOf[1].Payload.questions[].LabelKey はい
$.oneOf[0].allOf[1].Payload.questions[].LabelKey.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.questions[].LabelKey.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.questions[].HelpTextstring はい
$.oneOf[0].allOf[1].Payload.questions[].FieldTypestring ["text","number","boolean","single_select","multi_select","longtext"] はい
$.oneOf[0].allOf[1].Payload.questions[].RequiredDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Required.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].Required.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.questions[].SortOrderDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].SortOrder.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].SortOrder.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSONstring (application/json) はい
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSONSurveyValidation (デコードされたJSON) はい
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0]object はい
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].maxLengthinteger いいえ
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].integerboolean いいえ
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].minnumber いいえ
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].maxnumber いいえ
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[1] = [] はい
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID はい
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[0]DatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[0].oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[0].oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.questions[].ValueScope はい
$.oneOf[0].allOf[1].Payload.questions[].ValueScope.anyOf[0]string ["customer","booking"] はい
$.oneOf[0].allOf[1].Payload.questions[].ValueScope.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.questions[].FieldKey はい
$.oneOf[0].allOf[1].Payload.questions[].FieldKey.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.questions[].FieldKey.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.questions[].validationSurveyValidation はい
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0]object はい
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].maxLengthinteger いいえ
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].integerboolean いいえ
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].minnumber いいえ
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].maxnumber いいえ
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[1] = [] はい
$.oneOf[0].allOf[1].Payload.questions[].Optionsarray はい
$.oneOf[0].allOf[1].Payload.questions[].Options[]object いいえ
$.oneOf[0].allOf[1].Payload.questions[].Options[].IDDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].ID.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].ID.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].QuestionIDDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].QuestionID.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].QuestionID.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[0]DatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[0].oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[0].oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].OptionKeystring はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].Labelstring はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].LabelKey はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].LabelKey.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].LabelKey.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].SortOrderDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].SortOrder.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].SortOrder.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.historyarray はい
$.oneOf[0].allOf[1].Payload.history[]object いいえ
$.oneOf[0].allOf[1].Payload.history[].idinteger はい
$.oneOf[0].allOf[1].Payload.history[].revisioninteger はい
$.oneOf[0].allOf[1].Payload.history[].submittedDate はい
$.oneOf[0].allOf[1].Payload.history[].submittedDate.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.history[].submittedDate.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.history[].answersobject はい
$.oneOf[0].allOf[1].Payload.history[].answers.*SurveyAnswerValue いいえValue follows the question type: text or selected key, decimal numeric string, boolean, selected-key list, or null when unanswered.
$.oneOf[0].allOf[1].Payload.history[].answers.*.anyOf[0]null いいえ
$.oneOf[0].allOf[1].Payload.history[].answers.*.anyOf[1]string いいえ
$.oneOf[0].allOf[1].Payload.history[].answers.*.anyOf[2]number いいえ
$.oneOf[0].allOf[1].Payload.history[].answers.*.anyOf[3]boolean いいえ
$.oneOf[0].allOf[1].Payload.history[].answers.*.anyOf[4]array いいえ
$.oneOf[0].allOf[1].Payload.history[].answers.*.anyOf[4][]string いいえ
$.oneOf[0].allOf[1].Payload.draft はい
$.oneOf[0].allOf[1].Payload.draft.anyOf[0]object はい
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].idinteger はい
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].revisioninteger はい
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].submittedDate はい
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].submittedDate.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].submittedDate.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answersobject はい
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*SurveyAnswerValue いいえValue follows the question type: text or selected key, decimal numeric string, boolean, selected-key list, or null when unanswered.
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*.anyOf[0]null いいえ
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*.anyOf[1]string いいえ
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*.anyOf[2]number いいえ
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*.anyOf[3]boolean いいえ
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*.anyOf[4]array いいえ
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*.anyOf[4][]string いいえ
$.oneOf[0].allOf[1].Payload.draft.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.prefillobject はい
$.oneOf[0].allOf[1].Payload.prefill.*object いいえ
$.oneOf[0].allOf[1].Payload.prefill.*.valueSurveyAnswerValue はいValue follows the question type: text or selected key, decimal numeric string, boolean, selected-key list, or null when unanswered.
$.oneOf[0].allOf[1].Payload.prefill.*.value.anyOf[0]null はい
$.oneOf[0].allOf[1].Payload.prefill.*.value.anyOf[1]string はい
$.oneOf[0].allOf[1].Payload.prefill.*.value.anyOf[2]number はい
$.oneOf[0].allOf[1].Payload.prefill.*.value.anyOf[3]boolean はい
$.oneOf[0].allOf[1].Payload.prefill.*.value.anyOf[4]array はい
$.oneOf[0].allOf[1].Payload.prefill.*.value.anyOf[4][]string いいえ
$.oneOf[0].allOf[1].Payload.prefill.*.sourcestring ["saved","booking"] はい
$.oneOf[0].allOf[1].Payload.memoryRevisionsobject はい
$.oneOf[0].allOf[1].Payload.memoryRevisions.*integer いいえ
$.oneOf[0].allOf[1].Payload.canAnswerboolean はい
$.oneOf[0].allOf[1].Payload.canCancelboolean はい
$.oneOf[0].allOf[1].Payload.canAttachboolean はい
$.oneOf[0].allOf[1].Payload.isCustomerboolean はい
$.oneOf[0].allOf[1].Payload.salesarray はい
$.oneOf[0].allOf[1].Payload.sales[]object いいえ
$.oneOf[0].allOf[1].Payload.sales[].IDDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.sales[].ID.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.sales[].ID.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.sales[].BidID はい
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[0]DatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[0].oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[0].oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID はい
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[0]DatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[0].oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[0].oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.sales[].TransactionCompletedDate はい
$.oneOf[0].allOf[1].Payload.sales[].TransactionCompletedDate.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.sales[].TransactionCompletedDate.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.sales[].LocationName はい
$.oneOf[0].allOf[1].Payload.sales[].LocationName.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.sales[].LocationName.anyOf[1]null はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/get_request",
    "RequestUserAlias": "example-user",
    "Payload": {
        "request": {
            "id": 0,
            "revision": 0,
            "customerID": 0,
            "sellerID": 0,
            "chatID": 0,
            "bidID": 0,
            "transactionID": 0,
            "title": "synthetic-example",
            "status": "sent",
            "submittedDate": "synthetic-example",
            "url": "synthetic-example"
        },
        "title": "synthetic-example",
        "introduction": "synthetic-example",
        "questions": [],
        "history": [],
        "draft": {
            "id": 0,
            "revision": 0,
            "submittedDate": "synthetic-example",
            "answers": []
        },
        "prefill": [],
        "memoryRevisions": [],
        "canAnswer": false,
        "canCancel": false,
        "canAttach": false,
        "isCustomer": false,
        "sales": []
    }
}
機械可読のエンドポイントドキュメント
GET

/v1/customer_survey/get_requests

#
List only questionnaires sent or received by the acting user. Context filters never widen that access.

パラメーター

名前型必須既定値説明
customerID int いいえ 0 Filter recipient.
transactionID int いいえ 0 Filter a sale, including surveys for its bid and same original pair.
bidID int いいえ 0 Filter bid.
beforeID int いいえ 0 Pagination cursor.
sentOnly bool いいえ false Seller dashboard filter.
completedOnly bool いいえ false Only requests with a submitted response; excludes unanswered requests and private drafts.
リクエスト例（cURL） 
curl --get \
  'https://jp.appointmenttrader.com/v1/customer_survey/get_requests' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'customerID={{customerID}}' \
  --data-urlencode 'transactionID={{transactionID}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'beforeID={{beforeID}}' \
  --data-urlencode 'sentOnly={{sentOnly}}' \
  --data-urlencode 'completedOnly={{completedOnly}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$customer_survey_get_requests_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.itemsarray はい
$.oneOf[0].allOf[1].Payload.items[]object いいえ
$.oneOf[0].allOf[1].Payload.items[].idinteger はい
$.oneOf[0].allOf[1].Payload.items[].revisioninteger はい
$.oneOf[0].allOf[1].Payload.items[].customerIDinteger はい
$.oneOf[0].allOf[1].Payload.items[].sellerIDinteger はい
$.oneOf[0].allOf[1].Payload.items[].chatIDinteger はい
$.oneOf[0].allOf[1].Payload.items[].bidIDinteger はい
$.oneOf[0].allOf[1].Payload.items[].transactionIDinteger はい
$.oneOf[0].allOf[1].Payload.items[].titlestring はい
$.oneOf[0].allOf[1].Payload.items[].statusstring ["sent","in_progress","submitted","cancelled"] はい
$.oneOf[0].allOf[1].Payload.items[].submittedDate はい
$.oneOf[0].allOf[1].Payload.items[].submittedDate.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.items[].submittedDate.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.items[].urlstring はい
$.oneOf[0].allOf[1].Payload.items[].buyerIdentityHiddenboolean いいえTrue when the authenticated viewer cannot see the buyer during the current response race.
$.oneOf[0].allOf[1].Payload.items[].buyerIdentityHiddenUntilinteger | null いいえSaved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
$.oneOf[0].allOf[1].Payload.hasMoreboolean はい
$.oneOf[0].allOf[1].Payload.beforeIDinteger はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/get_requests",
    "RequestUserAlias": "example-user",
    "Payload": {
        "items": [],
        "hasMore": false,
        "beforeID": 0
    }
}
機械可読のエンドポイントドキュメント
GET

/v1/customer_survey/get_template

#
Read a versioned AT or seller-owned template for preview/edit/copy.

パラメーター

名前型必須既定値説明
templateID int はい — Template identifier.
リクエスト例（cURL） 
curl --get \
  'https://jp.appointmenttrader.com/v1/customer_survey/get_template' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'templateID={{templateID}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$customer_survey_get_template_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.IDDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ID.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.ID.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.CreatedDatestring はい
$.oneOf[0].allOf[1].Payload.OwnerUserID はい
$.oneOf[0].allOf[1].Payload.OwnerUserID.anyOf[0]DatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.OwnerUserID.anyOf[0].oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.OwnerUserID.anyOf[0].oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.OwnerUserID.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.StarterKey はい
$.oneOf[0].allOf[1].Payload.StarterKey.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.StarterKey.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.SourceTemplateID はい
$.oneOf[0].allOf[1].Payload.SourceTemplateID.anyOf[0]DatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.SourceTemplateID.anyOf[0].oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.SourceTemplateID.anyOf[0].oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.SourceTemplateID.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.CurrentVersionID はい
$.oneOf[0].allOf[1].Payload.CurrentVersionID.anyOf[0]DatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.CurrentVersionID.anyOf[0].oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.CurrentVersionID.anyOf[0].oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.CurrentVersionID.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.ArchivedDate はい
$.oneOf[0].allOf[1].Payload.ArchivedDate.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.ArchivedDate.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.Titlestring はい
$.oneOf[0].allOf[1].Payload.TitleKey はい
$.oneOf[0].allOf[1].Payload.TitleKey.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.TitleKey.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.VersionNumber はい
$.oneOf[0].allOf[1].Payload.VersionNumber.anyOf[0]DatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.VersionNumber.anyOf[0].oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.VersionNumber.anyOf[0].oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.VersionNumber.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.Introduction はい
$.oneOf[0].allOf[1].Payload.Introduction.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.Introduction.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.questionsarray はい
$.oneOf[0].allOf[1].Payload.questions[]object いいえ
$.oneOf[0].allOf[1].Payload.questions[].IDDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].ID.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].ID.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.questions[].VersionIDDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].VersionID.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].VersionID.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.questions[].FieldID はい
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[0]DatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[0].oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[0].oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.questions[].QuestionKeystring はい
$.oneOf[0].allOf[1].Payload.questions[].Labelstring はい
$.oneOf[0].allOf[1].Payload.questions[].LabelKey はい
$.oneOf[0].allOf[1].Payload.questions[].LabelKey.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.questions[].LabelKey.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.questions[].HelpTextstring はい
$.oneOf[0].allOf[1].Payload.questions[].FieldTypestring ["text","number","boolean","single_select","multi_select","longtext"] はい
$.oneOf[0].allOf[1].Payload.questions[].RequiredDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Required.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].Required.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.questions[].SortOrderDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].SortOrder.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].SortOrder.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSONstring (application/json) はい
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSONSurveyValidation (デコードされたJSON) はい
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0]object はい
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].maxLengthinteger いいえ
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].integerboolean いいえ
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].minnumber いいえ
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].maxnumber いいえ
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[1] = [] はい
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID はい
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[0]DatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[0].oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[0].oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.questions[].ValueScope はい
$.oneOf[0].allOf[1].Payload.questions[].ValueScope.anyOf[0]string ["customer","booking"] はい
$.oneOf[0].allOf[1].Payload.questions[].ValueScope.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.questions[].FieldKey はい
$.oneOf[0].allOf[1].Payload.questions[].FieldKey.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.questions[].FieldKey.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.questions[].validationSurveyValidation はい
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0]object はい
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].maxLengthinteger いいえ
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].integerboolean いいえ
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].minnumber いいえ
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].maxnumber いいえ
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[1] = [] はい
$.oneOf[0].allOf[1].Payload.questions[].Optionsarray はい
$.oneOf[0].allOf[1].Payload.questions[].Options[]object いいえ
$.oneOf[0].allOf[1].Payload.questions[].Options[].IDDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].ID.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].ID.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].QuestionIDDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].QuestionID.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].QuestionID.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[0]DatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[0].oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[0].oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].OptionKeystring はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].Labelstring はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].LabelKey はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].LabelKey.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].LabelKey.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].SortOrderDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].SortOrder.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.questions[].Options[].SortOrder.oneOf[1]string はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/get_template",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ID": 0,
        "CreatedDate": "synthetic-example",
        "OwnerUserID": 0,
        "StarterKey": "synthetic-example",
        "SourceTemplateID": 0,
        "CurrentVersionID": 0,
        "ArchivedDate": "synthetic-example",
        "Title": "synthetic-example",
        "TitleKey": "synthetic-example",
        "VersionNumber": 0,
        "Introduction": "synthetic-example",
        "questions": []
    }
}
機械可読のエンドポイントドキュメント
POST

/v1/customer_survey/set_attach

#
Attach a customer/bid questionnaire to a completed sale between its original seller and customer. Existing sale links cannot be moved.

パラメーター

名前型必須既定値説明
requestID int はい — Questionnaire identifier.
transactionID int はい — Completed sale identifier.
expectedRevision int はい — Last observed request revision.
isWritingRequest bool いいえ false Confirm write.
リクエスト例（cURL） 
curl --request POST \
  'https://jp.appointmenttrader.com/v1/customer_survey/set_attach' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'requestID={{requestID}}' \
  --data-urlencode 'transactionID={{transactionID}}' \
  --data-urlencode 'expectedRevision={{expectedRevision}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$customer_survey_set_attach_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.requestIDinteger はい
$.oneOf[0].allOf[1].Payload.chatIDinteger はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_attach",
    "RequestUserAlias": "example-user",
    "Payload": {
        "requestID": 0,
        "chatID": 0
    }
}
機械可読のエンドポイントドキュメント
POST

/v1/customer_survey/set_cancel

#
Cancel an unanswered questionnaire as its sending seller.

パラメーター

名前型必須既定値説明
requestID int はい — Questionnaire identifier.
expectedRevision int はい — Last observed request revision.
isWritingRequest bool いいえ false Confirm write.
リクエスト例（cURL） 
curl --request POST \
  'https://jp.appointmenttrader.com/v1/customer_survey/set_cancel' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'requestID={{requestID}}' \
  --data-urlencode 'expectedRevision={{expectedRevision}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$customer_survey_set_cancel_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.requestIDinteger はい
$.oneOf[0].allOf[1].Payload.chatIDinteger はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_cancel",
    "RequestUserAlias": "example-user",
    "Payload": {
        "requestID": 0,
        "chatID": 0
    }
}
機械可読のエンドポイントドキュメント
POST

/v1/customer_survey/set_draft

#
Save a customer-only draft. Drafts never update seller CRM or remembered values.

パラメーター

名前型必須既定値説明
dataJSON string はい — UTF-8 JSON object, preferably encoded as base64url: followed by unpadded URL-safe base64 to preserve authored text. Object: requestID, expectedRevision, operationKey, answers keyed by question ID, memoryRevisions keyed by field ID. Null means unanswered; false and zero are answers.
isWritingRequest bool いいえ false Confirm write.
リクエスト例（cURL） 
curl --request POST \
  'https://jp.appointmenttrader.com/v1/customer_survey/set_draft' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'dataJSON={{dataJSON}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

戻り値

JSON
See the shared response schema and synthetic example.
パラメーター: dataJSON
フィールド型必須説明
dataJSONstring (application/json) はい
dataJSONobject (デコードされたJSON) はい
dataJSON.requestIDinteger はい
dataJSON.operationKeystring はい
dataJSON.expectedRevisioninteger はい
dataJSON.answersobject はい
dataJSON.answers.*SurveyAnswerValue いいえValue follows the question type: text or selected key, decimal numeric string, boolean, selected-key list, or null when unanswered.
dataJSON.answers.*.anyOf[0]null いいえ
dataJSON.answers.*.anyOf[1]string いいえ
dataJSON.answers.*.anyOf[2]number いいえ
dataJSON.answers.*.anyOf[3]boolean いいえ
dataJSON.answers.*.anyOf[4]array いいえ
dataJSON.answers.*.anyOf[4][]string いいえ
dataJSON.memoryRevisionsobject はい
dataJSON.memoryRevisions.*integer いいえ
レスポンスフィールド
フィールド型必須説明
$customer_survey_set_draft_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.requestIDinteger はい
$.oneOf[0].allOf[1].Payload.revisioninteger はい
$.oneOf[0].allOf[1].Payload.chatIDinteger いいえ
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_draft",
    "RequestUserAlias": "example-user",
    "Payload": {
        "requestID": 0,
        "revision": 0
    }
}
機械可読のエンドポイントドキュメント
POST

/v1/customer_survey/set_forget

#
Forget an own remembered value for future prefills. Existing seller-shared submissions remain unchanged.

パラメーター

名前型必須既定値説明
fieldID int はい — Remembered field identifier.
expectedRevision int はい — Memory revision returned by get_customer_fields.
isWritingRequest bool いいえ false Confirm write.
リクエスト例（cURL） 
curl --request POST \
  'https://jp.appointmenttrader.com/v1/customer_survey/set_forget' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'fieldID={{fieldID}}' \
  --data-urlencode 'expectedRevision={{expectedRevision}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$customer_survey_set_forget_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.fieldIDinteger はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_forget",
    "RequestUserAlias": "example-user",
    "Payload": {
        "fieldID": 0
    }
}
機械可読のエンドポイントドキュメント
POST

/v1/customer_survey/set_send

#
Send one questionnaire to the server-resolved customer in an accepted chat. Reuse operationKey for retries only. Active bid selection pauses incoming questionnaires unless the sender has GlobalCommunityAdministration; ErrorReason=active_bid_selection.

パラメーター

名前型必須既定値説明
dataJSON string はい — UTF-8 JSON object, preferably encoded as base64url: followed by unpadded URL-safe base64 to preserve authored text. Object: chatID, templateID, versionID, transactionID (optional), operationKey (16-80 ASCII letters/digits/hyphens/underscores).
isWritingRequest bool いいえ false Confirm write.
リクエスト例（cURL） 
curl --request POST \
  'https://jp.appointmenttrader.com/v1/customer_survey/set_send' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'dataJSON={{dataJSON}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

戻り値

JSON
See the shared response schema and synthetic example.
パラメーター: dataJSON
フィールド型必須説明
dataJSONstring (application/json) はい
dataJSONobject (デコードされたJSON) はい
dataJSON.chatIDinteger はい
dataJSON.templateIDinteger はい
dataJSON.versionIDinteger はい
dataJSON.transactionIDinteger いいえ
dataJSON.operationKeystring はい
レスポンスフィールド
フィールド型必須説明
$customer_survey_set_send_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.requestIDinteger はい
$.oneOf[0].allOf[1].Payload.chatIDinteger いいえ
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_send",
    "RequestUserAlias": "example-user",
    "Payload": {
        "requestID": 0
    }
}
機械可読のエンドポイントドキュメント
POST

/v1/customer_survey/set_submit

#
Confirm and share a new immutable response revision with this seller. Also updates customer memory and this seller's CRM pointers atomically.

パラメーター

名前型必須既定値説明
dataJSON string はい — UTF-8 JSON object, preferably encoded with the base64url: prefix. Same object as /v1/customer_survey/set_draft; required answers and memory revisions are enforced.
isWritingRequest bool いいえ false Confirm customer sharing.
リクエスト例（cURL） 
curl --request POST \
  'https://jp.appointmenttrader.com/v1/customer_survey/set_submit' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'dataJSON={{dataJSON}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

戻り値

JSON
See the shared response schema and synthetic example.
パラメーター: dataJSON
フィールド型必須説明
dataJSONstring (application/json) はい
dataJSONobject (デコードされたJSON) はい
dataJSON.requestIDinteger はい
dataJSON.operationKeystring はい
dataJSON.expectedRevisioninteger はい
dataJSON.answersobject はい
dataJSON.answers.*SurveyAnswerValue いいえValue follows the question type: text or selected key, decimal numeric string, boolean, selected-key list, or null when unanswered.
dataJSON.answers.*.anyOf[0]null いいえ
dataJSON.answers.*.anyOf[1]string いいえ
dataJSON.answers.*.anyOf[2]number いいえ
dataJSON.answers.*.anyOf[3]boolean いいえ
dataJSON.answers.*.anyOf[4]array いいえ
dataJSON.answers.*.anyOf[4][]string いいえ
dataJSON.memoryRevisionsobject はい
dataJSON.memoryRevisions.*integer いいえ
レスポンスフィールド
フィールド型必須説明
$customer_survey_set_submit_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.requestIDinteger はい
$.oneOf[0].allOf[1].Payload.revisioninteger はい
$.oneOf[0].allOf[1].Payload.chatIDinteger いいえ
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_submit",
    "RequestUserAlias": "example-user",
    "Payload": {
        "requestID": 0,
        "revision": 0
    }
}
機械可読のエンドポイントドキュメント
POST

/v1/customer_survey/set_template

#
Create or append an immutable template version. A system-field ID owns type, label and options; clients cannot redefine them. Answer types: text (single-line input), longtext (multiline textarea), number, boolean, single_select, multi_select. Both text types preserve nonblank string values up to 4000 characters by default; empty or whitespace-only text is unanswered.

パラメーター

名前型必須既定値説明
dataJSON string はい — UTF-8 JSON object, preferably encoded as base64url: followed by unpadded URL-safe base64 to preserve authored text. Object: templateID (zero creates), expectedVersionID, sourceTemplateID, title, introduction, questions [{fieldID, label, help, type, required, remember, integer, min, max, options:[{key,label}]}].
isWritingRequest bool いいえ false Confirm write.
リクエスト例（cURL） 
curl --request POST \
  'https://jp.appointmenttrader.com/v1/customer_survey/set_template' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'dataJSON={{dataJSON}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

戻り値

JSON
See the shared response schema and synthetic example.
パラメーター: dataJSON
フィールド型必須説明
dataJSONstring (application/json) はい
dataJSONobject (デコードされたJSON) はい
dataJSON.titlestring はい
dataJSON.introductionstring いいえ
dataJSON.templateIDinteger いいえ
dataJSON.sourceTemplateIDinteger いいえ
dataJSON.expectedVersionIDinteger いいえ
dataJSON.questionsarray はい
dataJSON.questions[] いいえ
dataJSON.questions[].anyOf[0]object いいえ
dataJSON.questions[].anyOf[0].fieldIDinteger はい
dataJSON.questions[].anyOf[0].labelstring いいえ
dataJSON.questions[].anyOf[0].typestring ["text","longtext","number","boolean","single_select","multi_select"] いいえ
dataJSON.questions[].anyOf[0].helpstring いいえ
dataJSON.questions[].anyOf[0].requiredboolean いいえ
dataJSON.questions[].anyOf[0].rememberboolean いいえ
dataJSON.questions[].anyOf[0].integerboolean いいえ
dataJSON.questions[].anyOf[0].minDatabaseNumber いいえNumeric value; MySQL reads can serialize numbers as numeric strings.
dataJSON.questions[].anyOf[0].min.oneOf[0]number いいえ
dataJSON.questions[].anyOf[0].min.oneOf[1]string いいえ
dataJSON.questions[].anyOf[0].maxDatabaseNumber いいえNumeric value; MySQL reads can serialize numbers as numeric strings.
dataJSON.questions[].anyOf[0].max.oneOf[0]number いいえ
dataJSON.questions[].anyOf[0].max.oneOf[1]string いいえ
dataJSON.questions[].anyOf[0].optionsarray いいえ
dataJSON.questions[].anyOf[0].options[]object いいえ
dataJSON.questions[].anyOf[0].options[].keystring いいえ
dataJSON.questions[].anyOf[0].options[].labelstring はい
dataJSON.questions[].anyOf[1]object いいえ
dataJSON.questions[].anyOf[1].fieldIDinteger いいえ
dataJSON.questions[].anyOf[1].labelstring はい
dataJSON.questions[].anyOf[1].typestring ["text","longtext","number","boolean","single_select","multi_select"] はい
dataJSON.questions[].anyOf[1].helpstring いいえ
dataJSON.questions[].anyOf[1].requiredboolean いいえ
dataJSON.questions[].anyOf[1].rememberboolean いいえ
dataJSON.questions[].anyOf[1].integerboolean いいえ
dataJSON.questions[].anyOf[1].minDatabaseNumber いいえNumeric value; MySQL reads can serialize numbers as numeric strings.
dataJSON.questions[].anyOf[1].min.oneOf[0]number いいえ
dataJSON.questions[].anyOf[1].min.oneOf[1]string いいえ
dataJSON.questions[].anyOf[1].maxDatabaseNumber いいえNumeric value; MySQL reads can serialize numbers as numeric strings.
dataJSON.questions[].anyOf[1].max.oneOf[0]number いいえ
dataJSON.questions[].anyOf[1].max.oneOf[1]string いいえ
dataJSON.questions[].anyOf[1].optionsarray いいえ
dataJSON.questions[].anyOf[1].options[]object いいえ
dataJSON.questions[].anyOf[1].options[].keystring いいえ
dataJSON.questions[].anyOf[1].options[].labelstring はい
レスポンスフィールド
フィールド型必須説明
$customer_survey_set_template_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.templateIDinteger はい
$.oneOf[0].allOf[1].Payload.versionIDinteger はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_template",
    "RequestUserAlias": "example-user",
    "Payload": {
        "templateID": 0,
        "versionID": 0
    }
}
機械可読のエンドポイントドキュメント
POST

/v1/customer_survey/set_template_archive

#
Archive an owned template without changing sent questionnaires.

パラメーター

名前型必須既定値説明
templateID int はい — Template identifier.
expectedVersionID int はい — Last observed current version ID.
isWritingRequest bool いいえ false Confirm write.
リクエスト例（cURL） 
curl --request POST \
  'https://jp.appointmenttrader.com/v1/customer_survey/set_template_archive' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'templateID={{templateID}}' \
  --data-urlencode 'expectedVersionID={{expectedVersionID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$customer_survey_set_template_archive_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.templateIDinteger はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_template_archive",
    "RequestUserAlias": "example-user",
    "Payload": {
        "templateID": 0
    }
}
機械可読のエンドポイントドキュメント