AT AppointmentTrader
登录
当前在线  

/v1/beta_program/

Beta Program invite-code endpoints. Auth: every endpoint requires an authenticated user ($_APIUserID > 0).
GET

/v1/beta_program/get_invite_commission_preview

#
Return the legacy invite-friends commission preview as structured data, using the authenticated user's current commission permissions.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/beta_program/get_invite_commission_preview' \
  --data-urlencode 'key={{API_KEY}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$beta_program_get_invite_commission_preview_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.headlinestring 是的
$.oneOf[0].allOf[1].Payload.introstring 是的
$.oneOf[0].allOf[1].Payload.friendColumnLabelstring 是的
$.oneOf[0].allOf[1].Payload.earnColumnLabelstring 是的
$.oneOf[0].allOf[1].Payload.totalLabelstring 是的
$.oneOf[0].allOf[1].Payload.totalFormattedstring 是的
$.oneOf[0].allOf[1].Payload.footnotestring 是的
$.oneOf[0].allOf[1].Payload.statusNotestring 是的
$.oneOf[0].allOf[1].Payload.statusURLstring 是的
$.oneOf[0].allOf[1].Payload.examplePurchaseLabelstring 是的
$.oneOf[0].allOf[1].Payload.totalnumber 是的
$.oneOf[0].allOf[1].Payload.examplePurchasePriceinteger 是的
$.oneOf[0].allOf[1].Payload.standardFeePercentnumber 是的
$.oneOf[0].allOf[1].Payload.rowsarray 是的
$.oneOf[0].allOf[1].Payload.rows[]object 否
$.oneOf[0].allOf[1].Payload.rows[].keystring ["first_purchase","monthly_use","first_sale","recurring_sales"] 是的
$.oneOf[0].allOf[1].Payload.rows[].labelstring 是的
$.oneOf[0].allOf[1].Payload.rows[].amountnumber 是的
$.oneOf[0].allOf[1].Payload.rows[].amountFormattedstring 是的
$.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 否
响应示例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/beta_program/get_invite_commission_preview",
    "RequestUserAlias": "example-user",
    "Payload": {
        "headline": "synthetic-example",
        "intro": "synthetic-example",
        "friendColumnLabel": "synthetic-example",
        "earnColumnLabel": "synthetic-example",
        "totalLabel": "synthetic-example",
        "totalFormatted": "synthetic-example",
        "footnote": "synthetic-example",
        "statusNote": "synthetic-example",
        "statusURL": "synthetic-example",
        "examplePurchaseLabel": "synthetic-example",
        "total": 0,
        "examplePurchasePrice": 0,
        "standardFeePercent": 0,
        "rows": []
    }
}
机器可读的端点文档
GET

/v1/beta_program/get_invites

#
Return the authenticated user's beta invite summary, including remaining credits, return credits from redeemed codes, active unused codes, and redeemed codes with claimant details.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/beta_program/get_invites' \
  --data-urlencode 'key={{API_KEY}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$beta_program_get_invites_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.baseCreditsinteger 是的
$.oneOf[0].allOf[1].Payload.signupCreditsinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedReturnCreditsinteger 是的
$.oneOf[0].allOf[1].Payload.issuedInviteCountinteger 是的
$.oneOf[0].allOf[1].Payload.unusedInviteCountinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCountinteger 是的
$.oneOf[0].allOf[1].Payload.invitesLeftinteger 是的
$.oneOf[0].allOf[1].Payload.invitesLeftLabelstring 是的
$.oneOf[0].allOf[1].Payload.sidebarLabelstring 是的
$.oneOf[0].allOf[1].Payload.activeCodesarray 是的
$.oneOf[0].allOf[1].Payload.activeCodes[]object 否
$.oneOf[0].allOf[1].Payload.activeCodes[].codestring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].formattedCodestring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].inviteURLstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDatestring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDateLabelstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToAliasstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToEmailstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToLabelstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToProfileURLstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByAliasstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issueSourcestring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].idinteger 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextObjectIDinteger 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].isInviteCreditExemptboolean 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextTypestring ["","board"] 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayloadInviteContext 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0]object 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].boardIdinteger 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1]array 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodesarray 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[]object 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].codestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].formattedCodestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].inviteURLstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDatestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDateLabelstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToAliasstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToEmailstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToLabelstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToProfileURLstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByAliasstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issueSourcestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].idinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextObjectIDinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isInviteCreditExemptboolean 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextTypestring ["","board"] 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayloadInviteContext 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0]object 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].boardIdinteger 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1]array 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAliasstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAvatarstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByProfileURLstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDatestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDateLabelstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemSourcestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isSignupCreditGrantedboolean 是的
$.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 否
响应示例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/beta_program/get_invites",
    "RequestUserAlias": "example-user",
    "Payload": {
        "baseCredits": 0,
        "signupCredits": 0,
        "redeemedReturnCredits": 0,
        "issuedInviteCount": 0,
        "unusedInviteCount": 0,
        "redeemedCount": 0,
        "invitesLeft": 0,
        "invitesLeftLabel": "synthetic-example",
        "sidebarLabel": "synthetic-example",
        "activeCodes": [],
        "redeemedCodes": []
    }
}
机器可读的端点文档
POST

/v1/beta_program/set_create_contextual_invite_link

#
Create a reusable invite link with optional onboarding context. While the beta invite gate is enabled, the link carries a beta code; when the gate is later disabled, the same link shape still carries referral/context.

参数

名称类型必填默认值描述
invitePurpose string 否 "generic_invite" Invite purpose allowlist value.
contextType string 否 "" Context object type.
contextObjectID int 否 0 Context object ID, such as ATDiscussionBoards.ID.
presetProfileIntent string 否 "" Optional profile intent applied only when the redeemer has none.
contextPayloadJson string 否 "" JSON context payload. For board_membership, optional profileImageMediaID and bannerImageMediaID select inviter-owned photos. On acceptance, copies sharing the original file URLs are assigned only when both user photo slots are empty.
isWritingRequest bool 否 false Set true to actually create the invite link.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/beta_program/set_create_contextual_invite_link' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'invitePurpose={{invitePurpose}}' \
  --data-urlencode 'contextType={{contextType}}' \
  --data-urlencode 'contextObjectID={{contextObjectID}}' \
  --data-urlencode 'presetProfileIntent={{presetProfileIntent}}' \
  --data-urlencode 'contextPayloadJson={{contextPayloadJson}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
参数: contextPayloadJson
字段类型必填描述
contextPayloadJsonstring (application/json) 否
contextPayloadJsonInviteContext (解码后的 JSON) 否
contextPayloadJson.oneOf[0]object 否
contextPayloadJson.oneOf[0].boardIdinteger 否
contextPayloadJson.oneOf[0].capabilities 否
contextPayloadJson.oneOf[0].capabilities.anyOf[0]array 否
contextPayloadJson.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] 否
contextPayloadJson.oneOf[0].capabilities.anyOf[1]string 否
contextPayloadJson.oneOf[0].capabilities.anyOf[2]object 否
contextPayloadJson.oneOf[0].capabilities.anyOf[2].* 否
contextPayloadJson.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean 否
contextPayloadJson.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer 否
contextPayloadJson.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string 否
contextPayloadJson.oneOf[0].profileImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
contextPayloadJson.oneOf[0].profileImageMediaID.oneOf[0]integer 否
contextPayloadJson.oneOf[0].profileImageMediaID.oneOf[1]string 否
contextPayloadJson.oneOf[0].bannerImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
contextPayloadJson.oneOf[0].bannerImageMediaID.oneOf[0]integer 否
contextPayloadJson.oneOf[0].bannerImageMediaID.oneOf[1]string 否
contextPayloadJson.oneOf[0].*InviteContextJSONValue 否
contextPayloadJson.oneOf[0].*.anyOf[0]null 否
contextPayloadJson.oneOf[0].*.anyOf[1]string 否
contextPayloadJson.oneOf[0].*.anyOf[2]number 否
contextPayloadJson.oneOf[0].*.anyOf[3]boolean 否
contextPayloadJson.oneOf[0].*.anyOf[4]array 否
contextPayloadJson.oneOf[0].*.anyOf[4][]InviteContextJSONValue 否
contextPayloadJson.oneOf[0].*.anyOf[5]object 否
contextPayloadJson.oneOf[0].*.anyOf[5].*InviteContextJSONValue 否
contextPayloadJson.oneOf[1]array 否
contextPayloadJson.oneOf[1][]InviteContextJSONValue 否
contextPayloadJson.oneOf[1][].anyOf[0]null 否
contextPayloadJson.oneOf[1][].anyOf[1]string 否
contextPayloadJson.oneOf[1][].anyOf[2]number 否
contextPayloadJson.oneOf[1][].anyOf[3]boolean 否
contextPayloadJson.oneOf[1][].anyOf[4]array 否
contextPayloadJson.oneOf[1][].anyOf[4][]InviteContextJSONValue 否
contextPayloadJson.oneOf[1][].anyOf[5]object 否
contextPayloadJson.oneOf[1][].anyOf[5].*InviteContextJSONValue 否
响应字段
字段类型必填描述
$beta_program_set_create_contextual_invite_link_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.baseCreditsinteger 是的
$.oneOf[0].allOf[1].Payload.signupCreditsinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedReturnCreditsinteger 是的
$.oneOf[0].allOf[1].Payload.issuedInviteCountinteger 是的
$.oneOf[0].allOf[1].Payload.unusedInviteCountinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCountinteger 是的
$.oneOf[0].allOf[1].Payload.invitesLeftinteger 是的
$.oneOf[0].allOf[1].Payload.invitesLeftLabelstring 是的
$.oneOf[0].allOf[1].Payload.sidebarLabelstring 是的
$.oneOf[0].allOf[1].Payload.activeCodesarray 是的
$.oneOf[0].allOf[1].Payload.activeCodes[]object 否
$.oneOf[0].allOf[1].Payload.activeCodes[].codestring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].formattedCodestring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].inviteURLstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDatestring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDateLabelstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToAliasstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToEmailstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToLabelstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToProfileURLstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByAliasstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issueSourcestring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].idinteger 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextObjectIDinteger 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].isInviteCreditExemptboolean 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextTypestring ["","board"] 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayloadInviteContext 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0]object 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].boardIdinteger 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1]array 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodesarray 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[]object 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].codestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].formattedCodestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].inviteURLstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDatestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDateLabelstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToAliasstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToEmailstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToLabelstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToProfileURLstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByAliasstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issueSourcestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].idinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextObjectIDinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isInviteCreditExemptboolean 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextTypestring ["","board"] 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayloadInviteContext 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0]object 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].boardIdinteger 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1]array 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAliasstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAvatarstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByProfileURLstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDatestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDateLabelstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemSourcestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isSignupCreditGrantedboolean 是的
$.oneOf[0].allOf[1].Payload.createdInviteobject 否
$.oneOf[0].allOf[1].Payload.createdInvite.codestring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.formattedCodestring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.inviteURLstring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.createdDatestring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.createdDateLabelstring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToAliasstring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToEmailstring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToLabelstring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToProfileURLstring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.issuedByAliasstring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.issueSourcestring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.idinteger 是的
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.createdInvite.issuedByUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.createdInvite.contextObjectIDinteger 是的
$.oneOf[0].allOf[1].Payload.createdInvite.isInviteCreditExemptboolean 是的
$.oneOf[0].allOf[1].Payload.createdInvite.invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] 是的
$.oneOf[0].allOf[1].Payload.createdInvite.contextTypestring ["","board"] 是的
$.oneOf[0].allOf[1].Payload.createdInvite.presetProfileIntentstring ["","buy","sell","socialize","location-partner"] 是的
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayloadInviteContext 是的
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0]object 是的
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].boardIdinteger 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[0]array 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2]object 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].* 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1]array 是的
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue 否
$.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 否
响应示例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/beta_program/set_create_contextual_invite_link",
    "RequestUserAlias": "example-user",
    "Payload": {
        "baseCredits": 0,
        "signupCredits": 0,
        "redeemedReturnCredits": 0,
        "issuedInviteCount": 0,
        "unusedInviteCount": 0,
        "redeemedCount": 0,
        "invitesLeft": 0,
        "invitesLeftLabel": "synthetic-example",
        "sidebarLabel": "synthetic-example",
        "activeCodes": [],
        "redeemedCodes": []
    }
}
机器可读的端点文档
POST

/v1/beta_program/set_create_invite_code

#
Create one unused beta invite code if the authenticated user has invite credits remaining. Creating an unused code consumes one visible credit.

参数

名称类型必填默认值描述
isWritingRequest bool 否 false Set true to actually create the invite code.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/beta_program/set_create_invite_code' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$beta_program_set_create_invite_code_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.baseCreditsinteger 是的
$.oneOf[0].allOf[1].Payload.signupCreditsinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedReturnCreditsinteger 是的
$.oneOf[0].allOf[1].Payload.issuedInviteCountinteger 是的
$.oneOf[0].allOf[1].Payload.unusedInviteCountinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCountinteger 是的
$.oneOf[0].allOf[1].Payload.invitesLeftinteger 是的
$.oneOf[0].allOf[1].Payload.invitesLeftLabelstring 是的
$.oneOf[0].allOf[1].Payload.sidebarLabelstring 是的
$.oneOf[0].allOf[1].Payload.activeCodesarray 是的
$.oneOf[0].allOf[1].Payload.activeCodes[]object 否
$.oneOf[0].allOf[1].Payload.activeCodes[].codestring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].formattedCodestring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].inviteURLstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDatestring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDateLabelstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToAliasstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToEmailstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToLabelstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToProfileURLstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByAliasstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issueSourcestring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].idinteger 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextObjectIDinteger 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].isInviteCreditExemptboolean 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextTypestring ["","board"] 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayloadInviteContext 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0]object 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].boardIdinteger 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1]array 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodesarray 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[]object 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].codestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].formattedCodestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].inviteURLstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDatestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDateLabelstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToAliasstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToEmailstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToLabelstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToProfileURLstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByAliasstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issueSourcestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].idinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextObjectIDinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isInviteCreditExemptboolean 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextTypestring ["","board"] 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayloadInviteContext 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0]object 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].boardIdinteger 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1]array 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAliasstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAvatarstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByProfileURLstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDatestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDateLabelstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemSourcestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isSignupCreditGrantedboolean 是的
$.oneOf[0].allOf[1].Payload.createdInviteobject 否
$.oneOf[0].allOf[1].Payload.createdInvite.codestring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.formattedCodestring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.inviteURLstring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.createdDatestring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.createdDateLabelstring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToAliasstring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToEmailstring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToLabelstring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToProfileURLstring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.issuedByAliasstring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.issueSourcestring 是的
$.oneOf[0].allOf[1].Payload.createdInvite.idinteger 是的
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.createdInvite.issuedByUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.createdInvite.contextObjectIDinteger 是的
$.oneOf[0].allOf[1].Payload.createdInvite.isInviteCreditExemptboolean 是的
$.oneOf[0].allOf[1].Payload.createdInvite.invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] 是的
$.oneOf[0].allOf[1].Payload.createdInvite.contextTypestring ["","board"] 是的
$.oneOf[0].allOf[1].Payload.createdInvite.presetProfileIntentstring ["","buy","sell","socialize","location-partner"] 是的
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayloadInviteContext 是的
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0]object 是的
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].boardIdinteger 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[0]array 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2]object 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].* 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1]array 是的
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue 否
$.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 否
响应示例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/beta_program/set_create_invite_code",
    "RequestUserAlias": "example-user",
    "Payload": {
        "baseCredits": 0,
        "signupCredits": 0,
        "redeemedReturnCredits": 0,
        "issuedInviteCount": 0,
        "unusedInviteCount": 0,
        "redeemedCount": 0,
        "invitesLeft": 0,
        "invitesLeftLabel": "synthetic-example",
        "sidebarLabel": "synthetic-example",
        "activeCodes": [],
        "redeemedCodes": []
    }
}
机器可读的端点文档
POST

/v1/beta_program/set_revoke_invite_code

#
Revoke an unused beta invite code owned by the authenticated user. Revoking an unused code returns one visible invite credit.

参数

名称类型必填默认值描述
inviteCodeID int 是的 — Invite code ID from get_invites.
isWritingRequest bool 否 false Set true to actually revoke the invite code.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/beta_program/set_revoke_invite_code' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'inviteCodeID={{inviteCodeID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$beta_program_set_revoke_invite_code_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.baseCreditsinteger 是的
$.oneOf[0].allOf[1].Payload.signupCreditsinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedReturnCreditsinteger 是的
$.oneOf[0].allOf[1].Payload.issuedInviteCountinteger 是的
$.oneOf[0].allOf[1].Payload.unusedInviteCountinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCountinteger 是的
$.oneOf[0].allOf[1].Payload.invitesLeftinteger 是的
$.oneOf[0].allOf[1].Payload.invitesLeftLabelstring 是的
$.oneOf[0].allOf[1].Payload.sidebarLabelstring 是的
$.oneOf[0].allOf[1].Payload.activeCodesarray 是的
$.oneOf[0].allOf[1].Payload.activeCodes[]object 否
$.oneOf[0].allOf[1].Payload.activeCodes[].codestring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].formattedCodestring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].inviteURLstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDatestring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDateLabelstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToAliasstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToEmailstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToLabelstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToProfileURLstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByAliasstring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issueSourcestring 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].idinteger 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextObjectIDinteger 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].isInviteCreditExemptboolean 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextTypestring ["","board"] 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayloadInviteContext 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0]object 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].boardIdinteger 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1]array 是的
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodesarray 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[]object 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].codestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].formattedCodestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].inviteURLstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDatestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDateLabelstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToAliasstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToEmailstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToLabelstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToProfileURLstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByAliasstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issueSourcestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].idinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextObjectIDinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isInviteCreditExemptboolean 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextTypestring ["","board"] 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayloadInviteContext 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0]object 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].boardIdinteger 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1]array 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue 否
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAliasstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAvatarstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByProfileURLstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDatestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDateLabelstring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemSourcestring 是的
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isSignupCreditGrantedboolean 是的
$.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 否
响应示例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/beta_program/set_revoke_invite_code",
    "RequestUserAlias": "example-user",
    "Payload": {
        "baseCredits": 0,
        "signupCredits": 0,
        "redeemedReturnCredits": 0,
        "issuedInviteCount": 0,
        "unusedInviteCount": 0,
        "redeemedCount": 0,
        "invitesLeft": 0,
        "invitesLeftLabel": "synthetic-example",
        "sidebarLabel": "synthetic-example",
        "activeCodes": [],
        "redeemedCodes": []
    }
}
机器可读的端点文档