AT AppointmentTrader
Iniciar sesión
En línea ahora  

/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.
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.appointmenttrader.com/v1/beta_program/get_invite_commission_preview' \
  --data-urlencode 'key={{API_KEY}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Campos de respuesta
CampoTipoObligatorioDescripción
$beta_program_get_invite_commission_preview_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.headlinestring si
$.oneOf[0].allOf[1].Payload.introstring si
$.oneOf[0].allOf[1].Payload.friendColumnLabelstring si
$.oneOf[0].allOf[1].Payload.earnColumnLabelstring si
$.oneOf[0].allOf[1].Payload.totalLabelstring si
$.oneOf[0].allOf[1].Payload.totalFormattedstring si
$.oneOf[0].allOf[1].Payload.footnotestring si
$.oneOf[0].allOf[1].Payload.statusNotestring si
$.oneOf[0].allOf[1].Payload.statusURLstring si
$.oneOf[0].allOf[1].Payload.examplePurchaseLabelstring si
$.oneOf[0].allOf[1].Payload.totalnumber si
$.oneOf[0].allOf[1].Payload.examplePurchasePriceinteger si
$.oneOf[0].allOf[1].Payload.standardFeePercentnumber si
$.oneOf[0].allOf[1].Payload.rowsarray si
$.oneOf[0].allOf[1].Payload.rows[]object No
$.oneOf[0].allOf[1].Payload.rows[].keystring ["first_purchase","monthly_use","first_sale","recurring_sales"] si
$.oneOf[0].allOf[1].Payload.rows[].labelstring si
$.oneOf[0].allOf[1].Payload.rows[].amountnumber si
$.oneOf[0].allOf[1].Payload.rows[].amountFormattedstring si
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "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": []
    }
}
Documentación del endpoint legible por máquinas
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.
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.appointmenttrader.com/v1/beta_program/get_invites' \
  --data-urlencode 'key={{API_KEY}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Campos de respuesta
CampoTipoObligatorioDescripción
$beta_program_get_invites_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.baseCreditsinteger si
$.oneOf[0].allOf[1].Payload.signupCreditsinteger si
$.oneOf[0].allOf[1].Payload.redeemedReturnCreditsinteger si
$.oneOf[0].allOf[1].Payload.issuedInviteCountinteger si
$.oneOf[0].allOf[1].Payload.unusedInviteCountinteger si
$.oneOf[0].allOf[1].Payload.redeemedCountinteger si
$.oneOf[0].allOf[1].Payload.invitesLeftinteger si
$.oneOf[0].allOf[1].Payload.invitesLeftLabelstring si
$.oneOf[0].allOf[1].Payload.sidebarLabelstring si
$.oneOf[0].allOf[1].Payload.activeCodesarray si
$.oneOf[0].allOf[1].Payload.activeCodes[]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].codestring si
$.oneOf[0].allOf[1].Payload.activeCodes[].formattedCodestring si
$.oneOf[0].allOf[1].Payload.activeCodes[].inviteURLstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDatestring si
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDateLabelstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToAliasstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToEmailstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToLabelstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToProfileURLstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByAliasstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issueSourcestring si
$.oneOf[0].allOf[1].Payload.activeCodes[].idinteger si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToUserIDinteger si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByUserIDinteger si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextObjectIDinteger si
$.oneOf[0].allOf[1].Payload.activeCodes[].isInviteCreditExemptboolean si
$.oneOf[0].allOf[1].Payload.activeCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextTypestring ["","board"] si
$.oneOf[0].allOf[1].Payload.activeCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayloadInviteContext si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0]object si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].boardIdinteger No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1]array si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[0]null No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[2]number No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4]array No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodesarray si
$.oneOf[0].allOf[1].Payload.redeemedCodes[]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].codestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].formattedCodestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].inviteURLstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDatestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDateLabelstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToAliasstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToEmailstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToLabelstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToProfileURLstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByAliasstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issueSourcestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].idinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToUserIDinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByUserIDinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextObjectIDinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isInviteCreditExemptboolean si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextTypestring ["","board"] si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayloadInviteContext si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0]object si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].boardIdinteger No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1]array si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[0]null No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[2]number No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4]array No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByUserIDinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAliasstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAvatarstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByProfileURLstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDatestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDateLabelstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemSourcestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isSignupCreditGrantedboolean si
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "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": []
    }
}
Documentación del endpoint legible por máquinas
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.

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
invitePurpose string No "generic_invite" Invite purpose allowlist value.
contextType string No "" Context object type.
contextObjectID int No 0 Context object ID, such as ATDiscussionBoards.ID.
presetProfileIntent string No "" Optional profile intent applied only when the redeemer has none.
contextPayloadJson string No "" 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 No false Set true to actually create the invite link.
Ejemplo de solicitud (cURL) 
curl --request POST \
  'https://es.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}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Parámetros: contextPayloadJson
CampoTipoObligatorioDescripción
contextPayloadJsonstring (application/json) No
contextPayloadJsonInviteContext (JSON decodificado) No
contextPayloadJson.oneOf[0]object No
contextPayloadJson.oneOf[0].boardIdinteger No
contextPayloadJson.oneOf[0].capabilities No
contextPayloadJson.oneOf[0].capabilities.anyOf[0]array No
contextPayloadJson.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] No
contextPayloadJson.oneOf[0].capabilities.anyOf[1]string No
contextPayloadJson.oneOf[0].capabilities.anyOf[2]object No
contextPayloadJson.oneOf[0].capabilities.anyOf[2].* No
contextPayloadJson.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean No
contextPayloadJson.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer No
contextPayloadJson.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string No
contextPayloadJson.oneOf[0].profileImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
contextPayloadJson.oneOf[0].profileImageMediaID.oneOf[0]integer No
contextPayloadJson.oneOf[0].profileImageMediaID.oneOf[1]string No
contextPayloadJson.oneOf[0].bannerImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
contextPayloadJson.oneOf[0].bannerImageMediaID.oneOf[0]integer No
contextPayloadJson.oneOf[0].bannerImageMediaID.oneOf[1]string No
contextPayloadJson.oneOf[0].*InviteContextJSONValue No
contextPayloadJson.oneOf[0].*.anyOf[0]null No
contextPayloadJson.oneOf[0].*.anyOf[1]string No
contextPayloadJson.oneOf[0].*.anyOf[2]number No
contextPayloadJson.oneOf[0].*.anyOf[3]boolean No
contextPayloadJson.oneOf[0].*.anyOf[4]array No
contextPayloadJson.oneOf[0].*.anyOf[4][]InviteContextJSONValue No
contextPayloadJson.oneOf[0].*.anyOf[5]object No
contextPayloadJson.oneOf[0].*.anyOf[5].*InviteContextJSONValue No
contextPayloadJson.oneOf[1]array No
contextPayloadJson.oneOf[1][]InviteContextJSONValue No
contextPayloadJson.oneOf[1][].anyOf[0]null No
contextPayloadJson.oneOf[1][].anyOf[1]string No
contextPayloadJson.oneOf[1][].anyOf[2]number No
contextPayloadJson.oneOf[1][].anyOf[3]boolean No
contextPayloadJson.oneOf[1][].anyOf[4]array No
contextPayloadJson.oneOf[1][].anyOf[4][]InviteContextJSONValue No
contextPayloadJson.oneOf[1][].anyOf[5]object No
contextPayloadJson.oneOf[1][].anyOf[5].*InviteContextJSONValue No
Campos de respuesta
CampoTipoObligatorioDescripción
$beta_program_set_create_contextual_invite_link_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.baseCreditsinteger si
$.oneOf[0].allOf[1].Payload.signupCreditsinteger si
$.oneOf[0].allOf[1].Payload.redeemedReturnCreditsinteger si
$.oneOf[0].allOf[1].Payload.issuedInviteCountinteger si
$.oneOf[0].allOf[1].Payload.unusedInviteCountinteger si
$.oneOf[0].allOf[1].Payload.redeemedCountinteger si
$.oneOf[0].allOf[1].Payload.invitesLeftinteger si
$.oneOf[0].allOf[1].Payload.invitesLeftLabelstring si
$.oneOf[0].allOf[1].Payload.sidebarLabelstring si
$.oneOf[0].allOf[1].Payload.activeCodesarray si
$.oneOf[0].allOf[1].Payload.activeCodes[]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].codestring si
$.oneOf[0].allOf[1].Payload.activeCodes[].formattedCodestring si
$.oneOf[0].allOf[1].Payload.activeCodes[].inviteURLstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDatestring si
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDateLabelstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToAliasstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToEmailstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToLabelstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToProfileURLstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByAliasstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issueSourcestring si
$.oneOf[0].allOf[1].Payload.activeCodes[].idinteger si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToUserIDinteger si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByUserIDinteger si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextObjectIDinteger si
$.oneOf[0].allOf[1].Payload.activeCodes[].isInviteCreditExemptboolean si
$.oneOf[0].allOf[1].Payload.activeCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextTypestring ["","board"] si
$.oneOf[0].allOf[1].Payload.activeCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayloadInviteContext si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0]object si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].boardIdinteger No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1]array si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[0]null No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[2]number No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4]array No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodesarray si
$.oneOf[0].allOf[1].Payload.redeemedCodes[]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].codestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].formattedCodestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].inviteURLstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDatestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDateLabelstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToAliasstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToEmailstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToLabelstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToProfileURLstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByAliasstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issueSourcestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].idinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToUserIDinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByUserIDinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextObjectIDinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isInviteCreditExemptboolean si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextTypestring ["","board"] si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayloadInviteContext si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0]object si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].boardIdinteger No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1]array si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[0]null No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[2]number No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4]array No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByUserIDinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAliasstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAvatarstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByProfileURLstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDatestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDateLabelstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemSourcestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isSignupCreditGrantedboolean si
$.oneOf[0].allOf[1].Payload.createdInviteobject No
$.oneOf[0].allOf[1].Payload.createdInvite.codestring si
$.oneOf[0].allOf[1].Payload.createdInvite.formattedCodestring si
$.oneOf[0].allOf[1].Payload.createdInvite.inviteURLstring si
$.oneOf[0].allOf[1].Payload.createdInvite.createdDatestring si
$.oneOf[0].allOf[1].Payload.createdInvite.createdDateLabelstring si
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToAliasstring si
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToEmailstring si
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToLabelstring si
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToProfileURLstring si
$.oneOf[0].allOf[1].Payload.createdInvite.issuedByAliasstring si
$.oneOf[0].allOf[1].Payload.createdInvite.issueSourcestring si
$.oneOf[0].allOf[1].Payload.createdInvite.idinteger si
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToUserIDinteger si
$.oneOf[0].allOf[1].Payload.createdInvite.issuedByUserIDinteger si
$.oneOf[0].allOf[1].Payload.createdInvite.contextObjectIDinteger si
$.oneOf[0].allOf[1].Payload.createdInvite.isInviteCreditExemptboolean si
$.oneOf[0].allOf[1].Payload.createdInvite.invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] si
$.oneOf[0].allOf[1].Payload.createdInvite.contextTypestring ["","board"] si
$.oneOf[0].allOf[1].Payload.createdInvite.presetProfileIntentstring ["","buy","sell","socialize","location-partner"] si
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayloadInviteContext si
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0]object si
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].boardIdinteger No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[0]array No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2]object No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].* No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1]array si
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[0]null No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[1]string No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[2]number No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[4]array No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[5]object No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue No
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "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": []
    }
}
Documentación del endpoint legible por máquinas
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.

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
isWritingRequest bool No false Set true to actually create the invite code.
Ejemplo de solicitud (cURL) 
curl --request POST \
  'https://es.appointmenttrader.com/v1/beta_program/set_create_invite_code' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Campos de respuesta
CampoTipoObligatorioDescripción
$beta_program_set_create_invite_code_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.baseCreditsinteger si
$.oneOf[0].allOf[1].Payload.signupCreditsinteger si
$.oneOf[0].allOf[1].Payload.redeemedReturnCreditsinteger si
$.oneOf[0].allOf[1].Payload.issuedInviteCountinteger si
$.oneOf[0].allOf[1].Payload.unusedInviteCountinteger si
$.oneOf[0].allOf[1].Payload.redeemedCountinteger si
$.oneOf[0].allOf[1].Payload.invitesLeftinteger si
$.oneOf[0].allOf[1].Payload.invitesLeftLabelstring si
$.oneOf[0].allOf[1].Payload.sidebarLabelstring si
$.oneOf[0].allOf[1].Payload.activeCodesarray si
$.oneOf[0].allOf[1].Payload.activeCodes[]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].codestring si
$.oneOf[0].allOf[1].Payload.activeCodes[].formattedCodestring si
$.oneOf[0].allOf[1].Payload.activeCodes[].inviteURLstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDatestring si
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDateLabelstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToAliasstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToEmailstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToLabelstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToProfileURLstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByAliasstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issueSourcestring si
$.oneOf[0].allOf[1].Payload.activeCodes[].idinteger si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToUserIDinteger si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByUserIDinteger si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextObjectIDinteger si
$.oneOf[0].allOf[1].Payload.activeCodes[].isInviteCreditExemptboolean si
$.oneOf[0].allOf[1].Payload.activeCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextTypestring ["","board"] si
$.oneOf[0].allOf[1].Payload.activeCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayloadInviteContext si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0]object si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].boardIdinteger No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1]array si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[0]null No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[2]number No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4]array No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodesarray si
$.oneOf[0].allOf[1].Payload.redeemedCodes[]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].codestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].formattedCodestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].inviteURLstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDatestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDateLabelstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToAliasstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToEmailstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToLabelstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToProfileURLstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByAliasstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issueSourcestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].idinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToUserIDinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByUserIDinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextObjectIDinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isInviteCreditExemptboolean si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextTypestring ["","board"] si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayloadInviteContext si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0]object si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].boardIdinteger No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1]array si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[0]null No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[2]number No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4]array No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByUserIDinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAliasstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAvatarstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByProfileURLstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDatestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDateLabelstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemSourcestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isSignupCreditGrantedboolean si
$.oneOf[0].allOf[1].Payload.createdInviteobject No
$.oneOf[0].allOf[1].Payload.createdInvite.codestring si
$.oneOf[0].allOf[1].Payload.createdInvite.formattedCodestring si
$.oneOf[0].allOf[1].Payload.createdInvite.inviteURLstring si
$.oneOf[0].allOf[1].Payload.createdInvite.createdDatestring si
$.oneOf[0].allOf[1].Payload.createdInvite.createdDateLabelstring si
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToAliasstring si
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToEmailstring si
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToLabelstring si
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToProfileURLstring si
$.oneOf[0].allOf[1].Payload.createdInvite.issuedByAliasstring si
$.oneOf[0].allOf[1].Payload.createdInvite.issueSourcestring si
$.oneOf[0].allOf[1].Payload.createdInvite.idinteger si
$.oneOf[0].allOf[1].Payload.createdInvite.issuedToUserIDinteger si
$.oneOf[0].allOf[1].Payload.createdInvite.issuedByUserIDinteger si
$.oneOf[0].allOf[1].Payload.createdInvite.contextObjectIDinteger si
$.oneOf[0].allOf[1].Payload.createdInvite.isInviteCreditExemptboolean si
$.oneOf[0].allOf[1].Payload.createdInvite.invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] si
$.oneOf[0].allOf[1].Payload.createdInvite.contextTypestring ["","board"] si
$.oneOf[0].allOf[1].Payload.createdInvite.presetProfileIntentstring ["","buy","sell","socialize","location-partner"] si
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayloadInviteContext si
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0]object si
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].boardIdinteger No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[0]array No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2]object No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].* No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1]array si
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[0]null No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[1]string No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[2]number No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[4]array No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[5]object No
$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue No
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "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": []
    }
}
Documentación del endpoint legible por máquinas
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.

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
inviteCodeID int si — Invite code ID from get_invites.
isWritingRequest bool No false Set true to actually revoke the invite code.
Ejemplo de solicitud (cURL) 
curl --request POST \
  'https://es.appointmenttrader.com/v1/beta_program/set_revoke_invite_code' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'inviteCodeID={{inviteCodeID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Campos de respuesta
CampoTipoObligatorioDescripción
$beta_program_set_revoke_invite_code_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.baseCreditsinteger si
$.oneOf[0].allOf[1].Payload.signupCreditsinteger si
$.oneOf[0].allOf[1].Payload.redeemedReturnCreditsinteger si
$.oneOf[0].allOf[1].Payload.issuedInviteCountinteger si
$.oneOf[0].allOf[1].Payload.unusedInviteCountinteger si
$.oneOf[0].allOf[1].Payload.redeemedCountinteger si
$.oneOf[0].allOf[1].Payload.invitesLeftinteger si
$.oneOf[0].allOf[1].Payload.invitesLeftLabelstring si
$.oneOf[0].allOf[1].Payload.sidebarLabelstring si
$.oneOf[0].allOf[1].Payload.activeCodesarray si
$.oneOf[0].allOf[1].Payload.activeCodes[]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].codestring si
$.oneOf[0].allOf[1].Payload.activeCodes[].formattedCodestring si
$.oneOf[0].allOf[1].Payload.activeCodes[].inviteURLstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDatestring si
$.oneOf[0].allOf[1].Payload.activeCodes[].createdDateLabelstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToAliasstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToEmailstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToLabelstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToProfileURLstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByAliasstring si
$.oneOf[0].allOf[1].Payload.activeCodes[].issueSourcestring si
$.oneOf[0].allOf[1].Payload.activeCodes[].idinteger si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToUserIDinteger si
$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByUserIDinteger si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextObjectIDinteger si
$.oneOf[0].allOf[1].Payload.activeCodes[].isInviteCreditExemptboolean si
$.oneOf[0].allOf[1].Payload.activeCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextTypestring ["","board"] si
$.oneOf[0].allOf[1].Payload.activeCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayloadInviteContext si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0]object si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].boardIdinteger No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1]array si
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[0]null No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[1]string No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[2]number No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4]array No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodesarray si
$.oneOf[0].allOf[1].Payload.redeemedCodes[]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].codestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].formattedCodestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].inviteURLstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDatestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDateLabelstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToAliasstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToEmailstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToLabelstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToProfileURLstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByAliasstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issueSourcestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].idinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToUserIDinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByUserIDinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextObjectIDinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isInviteCreditExemptboolean si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].invitePurposestring ["","beta_access","generic_invite","board_secretary","board_membership"] si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextTypestring ["","board"] si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].presetProfileIntentstring ["","buy","sell","socialize","location-partner"] si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayloadInviteContext si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0]object si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].boardIdinteger No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0]array No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[0][]string ["invite","read","write","delete","move","schedule","polls","moderate"] No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].* No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[0]boolean No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[1]integer No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].capabilities.anyOf[2].*.anyOf[2]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaIDDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]integer No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].*.anyOf[5].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1]array si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[0]null No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[1]string No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[2]number No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4]array No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[4][]InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[1][].anyOf[5].*InviteContextJSONValue No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByUserIDinteger si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAliasstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAvatarstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByProfileURLstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDatestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDateLabelstring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemSourcestring si
$.oneOf[0].allOf[1].Payload.redeemedCodes[].isSignupCreditGrantedboolean si
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "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": []
    }
}
Documentación del endpoint legible por máquinas