beta_program API reference | AppointmentTrader

Search all endpoints

/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.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/beta_program/get_invite_commission_preview' \
  --data-urlencode 'key={{API_KEY}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`beta_program_get_invite_commission_preview_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.headline`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.intro`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.friendColumnLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.earnColumnLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.totalLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.totalFormatted`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.footnote`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.statusNote`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.statusURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.examplePurchaseLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.total`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.examplePurchasePrice`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.standardFeePercent`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.rows`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.rows[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.rows[].key`	`string ["first_purchase","monthly_use","first_sale","recurring_sales"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.rows[].label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.rows[].amount`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.rows[].amountFormatted`	`string`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "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": []
    }
}

Machine-readable endpoint documentation

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.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/beta_program/get_invites' \
  --data-urlencode 'key={{API_KEY}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`beta_program_get_invites_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.baseCredits`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.signupCredits`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedReturnCredits`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.issuedInviteCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.unusedInviteCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.invitesLeft`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.invitesLeftLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sidebarLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.activeCodes[].code`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].formattedCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].inviteURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].createdDateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToEmail`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToProfileURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issueSource`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextObjectID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].isInviteCreditExempt`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].invitePurpose`	`string ["","beta_access","generic_invite","board_secretary","board_membership"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextType`	`string ["","board"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].presetProfileIntent`	`string ["","buy","sell","socialize","location-partner"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload`	`InviteContext`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].boardId`	`integer`	`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].profileImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]`	`integer`	`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`	`Yes`
`$.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.redeemedCodes`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].code`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].formattedCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].inviteURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToEmail`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToProfileURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issueSource`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextObjectID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].isInviteCreditExempt`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].invitePurpose`	`string ["","beta_access","generic_invite","board_secretary","board_membership"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextType`	`string ["","board"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].presetProfileIntent`	`string ["","buy","sell","socialize","location-partner"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload`	`InviteContext`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].boardId`	`integer`	`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].profileImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]`	`integer`	`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`	`Yes`
`$.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[].redeemedByUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAvatar`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByProfileURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemSource`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].isSignupCreditGranted`	`boolean`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "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": []
    }
}

Machine-readable endpoint documentation

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.

Parameters

Name	Type	Required	Default	Description
`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.

Request example (cURL)

curl --request POST \
  'https://ca.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}}'

Returns

JSON

See the shared response schema and synthetic example.

Parameters: contextPayloadJson

Field	Type	Required	Description
`contextPayloadJson`	`string (application/json)`	`No`
`contextPayloadJson`	`InviteContext (decoded JSON)`	`No`
`contextPayloadJson.oneOf[0]`	`object`	`No`
`contextPayloadJson.oneOf[0].boardId`	`integer`	`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].profileImageMediaID`	`DatabaseInteger`	`No`	Integer 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].bannerImageMediaID`	`DatabaseInteger`	`No`	Integer 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`

Response fields

Field	Type	Required	Description
`$`	`beta_program_set_create_contextual_invite_link_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.baseCredits`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.signupCredits`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedReturnCredits`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.issuedInviteCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.unusedInviteCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.invitesLeft`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.invitesLeftLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sidebarLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.activeCodes[].code`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].formattedCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].inviteURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].createdDateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToEmail`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToProfileURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issueSource`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextObjectID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].isInviteCreditExempt`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].invitePurpose`	`string ["","beta_access","generic_invite","board_secretary","board_membership"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextType`	`string ["","board"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].presetProfileIntent`	`string ["","buy","sell","socialize","location-partner"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload`	`InviteContext`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].boardId`	`integer`	`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].profileImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]`	`integer`	`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`	`Yes`
`$.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.redeemedCodes`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].code`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].formattedCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].inviteURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToEmail`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToProfileURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issueSource`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextObjectID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].isInviteCreditExempt`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].invitePurpose`	`string ["","beta_access","generic_invite","board_secretary","board_membership"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextType`	`string ["","board"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].presetProfileIntent`	`string ["","buy","sell","socialize","location-partner"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload`	`InviteContext`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].boardId`	`integer`	`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].profileImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]`	`integer`	`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`	`Yes`
`$.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[].redeemedByUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAvatar`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByProfileURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemSource`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].isSignupCreditGranted`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.createdInvite.code`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.formattedCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.inviteURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.createdDateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.issuedToAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.issuedToEmail`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.issuedToLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.issuedToProfileURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.issuedByAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.issueSource`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.issuedToUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.issuedByUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.contextObjectID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.isInviteCreditExempt`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.invitePurpose`	`string ["","beta_access","generic_invite","board_secretary","board_membership"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.contextType`	`string ["","board"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.presetProfileIntent`	`string ["","buy","sell","socialize","location-partner"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload`	`InviteContext`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].boardId`	`integer`	`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].profileImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].profileImageMediaID.oneOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].profileImageMediaID.oneOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].bannerImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]`	`integer`	`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`	`Yes`
`$.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`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "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": []
    }
}

Machine-readable endpoint documentation

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.

Parameters

Name	Type	Required	Default	Description
`isWritingRequest`	`bool`	`No`	`false`	Set true to actually create the invite code.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/beta_program/set_create_invite_code' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`beta_program_set_create_invite_code_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.baseCredits`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.signupCredits`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedReturnCredits`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.issuedInviteCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.unusedInviteCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.invitesLeft`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.invitesLeftLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sidebarLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.activeCodes[].code`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].formattedCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].inviteURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].createdDateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToEmail`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToProfileURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issueSource`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextObjectID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].isInviteCreditExempt`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].invitePurpose`	`string ["","beta_access","generic_invite","board_secretary","board_membership"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextType`	`string ["","board"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].presetProfileIntent`	`string ["","buy","sell","socialize","location-partner"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload`	`InviteContext`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].boardId`	`integer`	`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].profileImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]`	`integer`	`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`	`Yes`
`$.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.redeemedCodes`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].code`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].formattedCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].inviteURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToEmail`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToProfileURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issueSource`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextObjectID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].isInviteCreditExempt`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].invitePurpose`	`string ["","beta_access","generic_invite","board_secretary","board_membership"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextType`	`string ["","board"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].presetProfileIntent`	`string ["","buy","sell","socialize","location-partner"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload`	`InviteContext`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].boardId`	`integer`	`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].profileImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]`	`integer`	`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`	`Yes`
`$.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[].redeemedByUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAvatar`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByProfileURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemSource`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].isSignupCreditGranted`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.createdInvite.code`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.formattedCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.inviteURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.createdDateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.issuedToAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.issuedToEmail`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.issuedToLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.issuedToProfileURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.issuedByAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.issueSource`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.issuedToUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.issuedByUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.contextObjectID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.isInviteCreditExempt`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.invitePurpose`	`string ["","beta_access","generic_invite","board_secretary","board_membership"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.contextType`	`string ["","board"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.presetProfileIntent`	`string ["","buy","sell","socialize","location-partner"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload`	`InviteContext`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].boardId`	`integer`	`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].profileImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].profileImageMediaID.oneOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].profileImageMediaID.oneOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].bannerImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.createdInvite.contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]`	`integer`	`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`	`Yes`
`$.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`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "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": []
    }
}

Machine-readable endpoint documentation

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.

Parameters

Name	Type	Required	Default	Description
`inviteCodeID`	`int`	`Yes`	`—`	Invite code ID from get_invites.
`isWritingRequest`	`bool`	`No`	`false`	Set true to actually revoke the invite code.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/beta_program/set_revoke_invite_code' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'inviteCodeID={{inviteCodeID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`beta_program_set_revoke_invite_code_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.baseCredits`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.signupCredits`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedReturnCredits`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.issuedInviteCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.unusedInviteCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.invitesLeft`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.invitesLeftLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sidebarLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.activeCodes[].code`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].formattedCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].inviteURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].createdDateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToEmail`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToProfileURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issueSource`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedToUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].issuedByUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextObjectID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].isInviteCreditExempt`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].invitePurpose`	`string ["","beta_access","generic_invite","board_secretary","board_membership"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextType`	`string ["","board"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].presetProfileIntent`	`string ["","buy","sell","socialize","location-partner"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload`	`InviteContext`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].boardId`	`integer`	`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].profileImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.activeCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]`	`integer`	`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`	`Yes`
`$.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.redeemedCodes`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].code`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].formattedCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].inviteURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].createdDateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToEmail`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToProfileURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issueSource`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedToUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].issuedByUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextObjectID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].isInviteCreditExempt`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].invitePurpose`	`string ["","beta_access","generic_invite","board_secretary","board_membership"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextType`	`string ["","board"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].presetProfileIntent`	`string ["","buy","sell","socialize","location-partner"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload`	`InviteContext`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].boardId`	`integer`	`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].profileImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].profileImageMediaID.oneOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].contextPayload.oneOf[0].bannerImageMediaID.oneOf[0]`	`integer`	`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`	`Yes`
`$.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[].redeemedByUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByAvatar`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedByProfileURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemedDateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].redeemSource`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.redeemedCodes[].isSignupCreditGranted`	`boolean`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "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": []
    }
}

Machine-readable endpoint documentation