Şu an çevrimiçi  

/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.
İstek örneği (cURL)
curl --get \
  'https://tr.appointmenttrader.com/v1/beta_program/get_invite_commission_preview' \
  --data-urlencode 'key={{API_KEY}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$beta_program_get_invite_commission_preview_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.headlinestring Evet
$.oneOf[0].allOf[1].Payload.introstring Evet
$.oneOf[0].allOf[1].Payload.friendColumnLabelstring Evet
$.oneOf[0].allOf[1].Payload.earnColumnLabelstring Evet
$.oneOf[0].allOf[1].Payload.totalLabelstring Evet
$.oneOf[0].allOf[1].Payload.totalFormattedstring Evet
$.oneOf[0].allOf[1].Payload.footnotestring Evet
$.oneOf[0].allOf[1].Payload.statusNotestring Evet
$.oneOf[0].allOf[1].Payload.statusURLstring Evet
$.oneOf[0].allOf[1].Payload.examplePurchaseLabelstring Evet
$.oneOf[0].allOf[1].Payload.totalnumber Evet
$.oneOf[0].allOf[1].Payload.examplePurchasePriceinteger Evet
$.oneOf[0].allOf[1].Payload.standardFeePercentnumber Evet
$.oneOf[0].allOf[1].Payload.rowsarray Evet
$.oneOf[0].allOf[1].Payload.rows[]object HAYIR
$.oneOf[0].allOf[1].Payload.rows[].keystring ["first_purchase","monthly_use","first_sale","recurring_sales"] Evet
$.oneOf[0].allOf[1].Payload.rows[].labelstring Evet
$.oneOf[0].allOf[1].Payload.rows[].amountnumber Evet
$.oneOf[0].allOf[1].Payload.rows[].amountFormattedstring Evet
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
Yanıt örneği
{
    "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": []
    }
}
Makine tarafından okunabilir uç nokta belgeleri
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.
İstek örneği (cURL)
curl --get \
  'https://tr.appointmenttrader.com/v1/beta_program/get_invites' \
  --data-urlencode 'key={{API_KEY}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$beta_program_get_invites_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.baseCreditsinteger Evet
$.oneOf[0].allOf[1].Payload.signupCreditsinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedReturnCreditsinteger Evet
$.oneOf[0].allOf[1].Payload.issuedInviteCountinteger Evet
$.oneOf[0].allOf[1].Payload.unusedInviteCountinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedCountinteger Evet
$.oneOf[0].allOf[1].Payload.invitesLeftinteger Evet
$.oneOf[0].allOf[1].Payload.invitesLeftLabelstring Evet
$.oneOf[0].allOf[1].Payload.sidebarLabelstring Evet
$.oneOf[0].allOf[1].Payload.activeCodesarray Evet
$.oneOf[0].allOf[1].Payload.activeCodes[]object HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].codestring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].formattedCodestring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].inviteURLstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDatestring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDateLabelstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToAliasstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToEmailstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToLabelstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToProfileURLstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByAliasstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issueSourcestring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].idinteger Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToUserIDinteger Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByUserIDinteger Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].contextObjectIDinteger Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].isInviteCreditExemptboolean Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].contextTypestring ["","board"] Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayloadInviteContext Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0]object Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].boardIdinteger HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger HAYIRInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger HAYIRInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[0]null HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[2]number HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4]array HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5]object HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1]array Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[0]null HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[2]number HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[3]boolean HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4]array HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5]object HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodesarray Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[]object HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].codestring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].formattedCodestring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].inviteURLstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDatestring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDateLabelstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToAliasstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToEmailstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToLabelstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToProfileURLstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByAliasstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issueSourcestring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].idinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToUserIDinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByUserIDinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextObjectIDinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isInviteCreditExemptboolean Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextTypestring ["","board"] Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayloadInviteContext Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0]object Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].boardIdinteger HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger HAYIRInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger HAYIRInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[0]null HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[2]number HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4]array HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5]object HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1]array Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[0]null HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[2]number HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[3]boolean HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4]array HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5]object HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByUserIDinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAliasstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAvatarstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByProfileURLstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDatestring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDateLabelstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemSourcestring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isSignupCreditGrantedboolean Evet
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
Yanıt örneği
{
    "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": []
    }
}
Makine tarafından okunabilir uç nokta belgeleri
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.

Parametreler

AdTürGerekliVarsayılanAçıklama
isWritingRequest bool HAYIR false Set true to actually create the invite code.
İstek örneği (cURL)
curl --request POST \
  'https://tr.appointmenttrader.com/v1/beta_program/set_create_invite_code' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$beta_program_set_create_invite_code_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.baseCreditsinteger Evet
$.oneOf[0].allOf[1].Payload.signupCreditsinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedReturnCreditsinteger Evet
$.oneOf[0].allOf[1].Payload.issuedInviteCountinteger Evet
$.oneOf[0].allOf[1].Payload.unusedInviteCountinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedCountinteger Evet
$.oneOf[0].allOf[1].Payload.invitesLeftinteger Evet
$.oneOf[0].allOf[1].Payload.invitesLeftLabelstring Evet
$.oneOf[0].allOf[1].Payload.sidebarLabelstring Evet
$.oneOf[0].allOf[1].Payload.activeCodesarray Evet
$.oneOf[0].allOf[1].Payload.activeCodes[]object HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].codestring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].formattedCodestring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].inviteURLstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDatestring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDateLabelstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToAliasstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToEmailstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToLabelstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToProfileURLstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByAliasstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issueSourcestring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].idinteger Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToUserIDinteger Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByUserIDinteger Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].contextObjectIDinteger Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].isInviteCreditExemptboolean Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].contextTypestring ["","board"] Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayloadInviteContext Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0]object Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].boardIdinteger HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger HAYIRInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger HAYIRInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[0]null HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[2]number HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4]array HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5]object HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1]array Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[0]null HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[2]number HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[3]boolean HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4]array HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5]object HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodesarray Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[]object HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].codestring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].formattedCodestring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].inviteURLstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDatestring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDateLabelstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToAliasstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToEmailstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToLabelstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToProfileURLstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByAliasstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issueSourcestring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].idinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToUserIDinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByUserIDinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextObjectIDinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isInviteCreditExemptboolean Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextTypestring ["","board"] Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayloadInviteContext Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0]object Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].boardIdinteger HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger HAYIRInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger HAYIRInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[0]null HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[2]number HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4]array HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5]object HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1]array Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[0]null HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[2]number HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[3]boolean HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4]array HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5]object HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByUserIDinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAliasstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAvatarstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByProfileURLstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDatestring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDateLabelstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemSourcestring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isSignupCreditGrantedboolean Evet
$.oneOf[0].allOf[1].Payload.createdInviteobject HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.codestring Evet
$.oneOf[0].allOf[1].Payload.createdInvite.formattedCodestring Evet
$.oneOf[0].allOf[1].Payload.createdInvite.inviteURLstring Evet
$.oneOf[0].allOf[1].Payload.createdInvite.createdDatestring Evet
$.oneOf[0].allOf[1].Payload.createdInvite.createdDateLabelstring Evet
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToAliasstring Evet
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToEmailstring Evet
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToLabelstring Evet
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToProfileURLstring Evet
$.oneOf[0].allOf[1].Payload.createdInvite.issuedByAliasstring Evet
$.oneOf[0].allOf[1].Payload.createdInvite.issueSourcestring Evet
$.oneOf[0].allOf[1].Payload.createdInvite.idinteger Evet
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToUserIDinteger Evet
$.oneOf[0].allOf[1].Payload.createdInvite.issuedByUserIDinteger Evet
$.oneOf[0].allOf[1].Payload.createdInvite.contextObjectIDinteger Evet
$.oneOf[0].allOf[1].Payload.createdInvite.isInviteCreditExemptboolean Evet
$.oneOf[0].allOf[1].Payload.createdInvite.invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] Evet
$.oneOf[0].allOf[1].Payload.createdInvite.contextTypestring ["","board"] Evet
$.oneOf[0].allOf[1].Payload.createdInvite.presetProfileIntentstring ["","buy","sell","socialize","location-partner"] Evet
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayloadInviteContext Evet
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0]object Evet
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].boardIdinteger HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[0]array HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2]object HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].* HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger HAYIRInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger HAYIRInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[0]null HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[2]number HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[3]boolean HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[4]array HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[5]object HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1]array Evet
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[0]null HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[2]number HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[3]boolean HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[4]array HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[5]object HAYIR
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue HAYIR
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
Yanıt örneği
{
    "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": []
    }
}
Makine tarafından okunabilir uç nokta belgeleri
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.

Parametreler

AdTürGerekliVarsayılanAçıklama
inviteCodeID int Evet — Invite code ID from get_invites.
isWritingRequest bool HAYIR false Set true to actually revoke the invite code.
İstek örneği (cURL)
curl --request POST \
  'https://tr.appointmenttrader.com/v1/beta_program/set_revoke_invite_code' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'inviteCodeID={{inviteCodeID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$beta_program_set_revoke_invite_code_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.baseCreditsinteger Evet
$.oneOf[0].allOf[1].Payload.signupCreditsinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedReturnCreditsinteger Evet
$.oneOf[0].allOf[1].Payload.issuedInviteCountinteger Evet
$.oneOf[0].allOf[1].Payload.unusedInviteCountinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedCountinteger Evet
$.oneOf[0].allOf[1].Payload.invitesLeftinteger Evet
$.oneOf[0].allOf[1].Payload.invitesLeftLabelstring Evet
$.oneOf[0].allOf[1].Payload.sidebarLabelstring Evet
$.oneOf[0].allOf[1].Payload.activeCodesarray Evet
$.oneOf[0].allOf[1].Payload.activeCodes[]object HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].codestring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].formattedCodestring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].inviteURLstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDatestring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDateLabelstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToAliasstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToEmailstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToLabelstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToProfileURLstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByAliasstring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issueSourcestring Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].idinteger Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToUserIDinteger Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByUserIDinteger Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].contextObjectIDinteger Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].isInviteCreditExemptboolean Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].contextTypestring ["","board"] Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayloadInviteContext Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0]object Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].boardIdinteger HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger HAYIRInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger HAYIRInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[0]null HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[2]number HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4]array HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5]object HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1]array Evet
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[0]null HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[2]number HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[3]boolean HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4]array HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5]object HAYIR
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodesarray Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[]object HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].codestring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].formattedCodestring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].inviteURLstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDatestring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDateLabelstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToAliasstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToEmailstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToLabelstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToProfileURLstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByAliasstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issueSourcestring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].idinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToUserIDinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByUserIDinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextObjectIDinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isInviteCreditExemptboolean Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextTypestring ["","board"] Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayloadInviteContext Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0]object Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].boardIdinteger HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger HAYIRInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger HAYIRInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[0]null HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[2]number HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4]array HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5]object HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1]array Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[0]null HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[2]number HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[3]boolean HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4]array HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5]object HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue HAYIR
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByUserIDinteger Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAliasstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAvatarstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByProfileURLstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDatestring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDateLabelstring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemSourcestring Evet
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isSignupCreditGrantedboolean Evet
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
Yanıt örneği
{
    "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": []
    }
}
Makine tarafından okunabilir uç nokta belgeleri