Online Now  

/v1/user/

Contains all user related functions
GET

/v1/user/get

#
Searches all user aliasses

Parameters

NameTypeRequiredDefaultDescription
searchFilter string No "" filter criteria
pageSize int No 50 Defines how many results will be return per request
pageNumber int No 0 Defines which page should be returned
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'searchFilter={{searchFilter}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Yes
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].userAvatarstring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].userAliasstring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].userLastSeen Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].userLastSeen.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].userLastSeen.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string No
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATResponseObjectType": "NestedKeyValueList",
        "ResponseBody": {
            "Name": "synthetic-example",
            "MetaInformation": [],
            "KeyValueList": [],
            "KeyValueFieldList": []
        }
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_address_manager

#
Read private saved addresses and phones. Only the owner or an AccessSpecialFunctions holder can read them. Identity documents, national identifiers and birth dates are never included. An unset legacy account phone uses the approved primary phone as its default; explicit defaults and address overrides remain separate.

Parameters

NameTypeRequiredDefaultDescription
userAlias string No "" Target alias; empty means the acting user.
start int No 0 Pagination offset.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_address_manager' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'start={{start}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_address_manager_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.userAliasstring Yes
$.oneOf[0].allOf[1].Payload.canEditboolean Yes
$.oneOf[0].allOf[1].Payload.defaultPhonestring Yes
$.oneOf[0].allOf[1].Payload.totalinteger Yes
$.oneOf[0].allOf[1].Payload.primary Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].addressIDinteger Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].reviewIDinteger Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].formattedAddressstring Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].phonestring Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].status = "IdentityConfirmed" Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.addressesarray Yes
$.oneOf[0].allOf[1].Payload.addresses[]object No
$.oneOf[0].allOf[1].Payload.addresses[].idinteger Yes
$.oneOf[0].allOf[1].Payload.addresses[].revisioninteger Yes
$.oneOf[0].allOf[1].Payload.addresses[].labelstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].addressPersonalAddress Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].formatted_addressstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_componentsarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[]object No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].long_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].short_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].typesarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].types[]string No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].source = "google" Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].unitstring No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].formatted_addressstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_componentsarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[]object No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].long_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].short_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].typesarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].types[]string No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].source = "photon" Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].osmobject Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].osm.typestring ["N","W","R"] Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].osm.idstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].coordinatesobject Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].coordinates.latitudenumber Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].coordinates.longitudenumber Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].resultTypestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].schemaVersion = 1 Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].unitstring No
$.oneOf[0].allOf[1].Payload.addresses[].formattedAddressstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].phoneOverride Yes
$.oneOf[0].allOf[1].Payload.addresses[].phoneOverride.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.addresses[].phoneOverride.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.addresses[].phonestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].statusstring ["NotReviewed","SubmittedForReview","Rejected","CancelledByUser","IdentityConfirmed"] Yes
$.oneOf[0].allOf[1].Payload.addresses[].reviewIDinteger Yes
$.oneOf[0].allOf[1].Payload.addresses[].rejectReasonstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].isPrimaryboolean Yes
$.oneOf[0].allOf[1].Payload.addresses[].isActiveSnapshotboolean Yes
$.oneOf[0].allOf[1].Payload.nextStartinteger Yes
$.oneOf[0].allOf[1].Payload.hasMoreboolean Yes
$.oneOf[0].allOf[1].Payload.reviewDefaultsobject No
$.oneOf[0].allOf[1].Payload.reviewDefaults.firstNamestring Yes
$.oneOf[0].allOf[1].Payload.reviewDefaults.lastNamestring Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_address_manager",
    "RequestUserAlias": "example-user",
    "Payload": {
        "userAlias": "synthetic-example",
        "canEdit": false,
        "defaultPhone": "synthetic-example",
        "total": 0,
        "primary": {
            "addressID": 0,
            "reviewID": 0,
            "formattedAddress": "synthetic-example",
            "phone": "synthetic-example",
            "status": "IdentityConfirmed"
        },
        "addresses": [],
        "nextStart": 0,
        "hasMore": false
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_community_verification_center

#
Returns the acting user's community verification center payload. This powers the native v2 account verification center. The invitee verification flow remains the existing /verify/{uuid} route; this endpoint only exposes the owner's current status, share link, editable verification details, and verifier strength list.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_community_verification_center' \
  --data-urlencode 'key={{API_KEY}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_community_verification_center_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.userobject Yes
$.oneOf[0].allOf[1].Payload.user.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.user.aliasstring Yes
$.oneOf[0].allOf[1].Payload.user.avatarstring Yes
$.oneOf[0].allOf[1].Payload.user.profileURLstring Yes
$.oneOf[0].allOf[1].Payload.user.communityVerificationStatusstring ["Unverified","Verified"] Yes
$.oneOf[0].allOf[1].Payload.user.communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.user.communityVerificationCountFormattedstring Yes
$.oneOf[0].allOf[1].Payload.user.firstNamestring Yes
$.oneOf[0].allOf[1].Payload.user.lastNamestring Yes
$.oneOf[0].allOf[1].Payload.user.professionstring Yes
$.oneOf[0].allOf[1].Payload.user.privacySettingstring ["do_not_publicly_share","share_name","share_profession","share_name_and_profession"] Yes
$.oneOf[0].allOf[1].Payload.verificationobject Yes
$.oneOf[0].allOf[1].Payload.verification.sharePathstring Yes
$.oneOf[0].allOf[1].Payload.verification.shareURLstring Yes
$.oneOf[0].allOf[1].Payload.verification.requiredNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.verification.remainingNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.verification.positiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.verification.negativeVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.verification.netPositiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.verification.verifierCountinteger Yes
$.oneOf[0].allOf[1].Payload.privacyOptionsarray Yes
$.oneOf[0].allOf[1].Payload.privacyOptions[]object No
$.oneOf[0].allOf[1].Payload.privacyOptions[].valuestring ["do_not_publicly_share","share_name","share_profession","share_name_and_profession"] Yes
$.oneOf[0].allOf[1].Payload.privacyOptions[].labelstring Yes
$.oneOf[0].allOf[1].Payload.verifiersarray Yes
$.oneOf[0].allOf[1].Payload.verifiers[]object No
$.oneOf[0].allOf[1].Payload.verifiers[].verificationIDinteger Yes
$.oneOf[0].allOf[1].Payload.verifiers[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.verifiers[].createdDateFormattedstring Yes
$.oneOf[0].allOf[1].Payload.verifiers[].messagestring Yes
$.oneOf[0].allOf[1].Payload.verifiers[].isPositiveVerificationboolean Yes
$.oneOf[0].allOf[1].Payload.verifiers[].verifierobject Yes
$.oneOf[0].allOf[1].Payload.verifiers[].verifier.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.verifiers[].verifier.aliasstring Yes
$.oneOf[0].allOf[1].Payload.verifiers[].verifier.avatarstring Yes
$.oneOf[0].allOf[1].Payload.verifiers[].verifier.profileURLstring Yes
$.oneOf[0].allOf[1].Payload.verifiers[].verifier.communityVerificationStatusstring ["","Unverified","Verified"] Yes
$.oneOf[0].allOf[1].Payload.verifiers[].verifier.communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.verifiers[].verifier.communityVerificationCountFormattedstring Yes
$.oneOf[0].allOf[1].Payload.verifiers[].verifier.importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.verifiers[].verifier.importancePointsFormattedstring Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_community_verification_center",
    "RequestUserAlias": "example-user",
    "Payload": {
        "user": {
            "userID": 0,
            "alias": "synthetic-example",
            "avatar": "synthetic-example",
            "profileURL": "synthetic-example",
            "communityVerificationStatus": "Unverified",
            "communityVerificationCount": 0,
            "communityVerificationCountFormatted": "synthetic-example",
            "firstName": "synthetic-example",
            "lastName": "synthetic-example",
            "profession": "synthetic-example",
            "privacySetting": "do_not_publicly_share"
        },
        "verification": {
            "sharePath": "synthetic-example",
            "shareURL": "synthetic-example",
            "requiredNetPositiveVerifications": 0,
            "remainingNetPositiveVerifications": 0,
            "positiveVerificationCount": 0,
            "negativeVerificationCount": 0,
            "netPositiveVerificationCount": 0,
            "verifierCount": 0
        },
        "privacyOptions": [],
        "verifiers": []
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_details

#
Returns details of the acting API User. Existing authorized impersonation selects the inspected user. Callers with AccessSpecialFunctions may select a user by ID, including signups without an alias. Only on RC, callers with AccessSpecialFunctions receive userLoginCode when an unused code was issued within five minutes and its attempt limits allow login. During impersonation, permission is checked against the original authenticated caller. The field is always omitted outside RC, for all other callers, or for absent codes. Production and preview never expose login codes through this endpoint. Clients must discard it after remainingSeconds minus elapsed request time. Responses are not cached.

Parameters

NameTypeRequiredDefaultDescription
userID int No 0 Optional user ID for privileged inspection; 0 uses the acting API user.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_details' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userID={{userID}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_details_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.userIdDatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.userId.oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.userId.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.userAliasstring Yes
$.oneOf[0].allOf[1].Payload.userEmailstring Yes
$.oneOf[0].allOf[1].Payload.userFirstNamestring Yes
$.oneOf[0].allOf[1].Payload.userLastNamestring Yes
$.oneOf[0].allOf[1].Payload.userProfession Yes
$.oneOf[0].allOf[1].Payload.userProfession.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.userProfession.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.userNumberLoginsDatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.userNumberLogins.oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.userNumberLogins.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.userAccountStatusstring ["Unverified","Verified","Suspended"] Yes
$.oneOf[0].allOf[1].Payload.userAccountPayoutDetailsStatusstring ["NotReviewed","SubmittedForReview","Rejected","CancelledByUser","IdentityConfirmed"] Yes
$.oneOf[0].allOf[1].Payload.userAccountPayoutDetailsStatusLastUpdateDate Yes
$.oneOf[0].allOf[1].Payload.userAccountPayoutDetailsStatusLastUpdateDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.userAccountPayoutDetailsStatusLastUpdateDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsDataLastUpdateDate Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsDataLastUpdateDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsDataLastUpdateDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*object No
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.PeriodTaxableAmountnumber Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.UserNetEarningAmountnumber Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.UserNetFeeAmountnumber Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetailsobject Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Completed, non Refunded TransactionsDatabaseNumber YesNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Completed, non Refunded Transactions.oneOf[0]number Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Completed, non Refunded Transactions.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Refunded FeesDatabaseNumber YesNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Refunded Fees.oneOf[0]number Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Refunded Fees.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Transfer Service Fees EarnedDatabaseNumber YesNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Transfer Service Fees Earned.oneOf[0]number Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Transfer Service Fees Earned.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Community USD EarnedDatabaseNumber YesNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Community USD Earned.oneOf[0]number Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Community USD Earned.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Community Points Earned (converted to USD)DatabaseNumber YesNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Community Points Earned (converted to USD).oneOf[0]number Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Community Points Earned (converted to USD).oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Support Commissions EarnedDatabaseNumber YesNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Support Commissions Earned.oneOf[0]number Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Support Commissions Earned.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Support Points Earned (converted to USD)DatabaseNumber YesNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Support Points Earned (converted to USD).oneOf[0]number Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Support Points Earned (converted to USD).oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Invited User Commissions EarnedDatabaseNumber YesNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Invited User Commissions Earned.oneOf[0]number Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.Invited User Commissions Earned.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.MLM Fees EarnedDatabaseNumber YesNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.MLM Fees Earned.oneOf[0]number Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.EarningDetails.MLM Fees Earned.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.ExpenseDetailsobject Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.ExpenseDetails.AppointmentTrader FeesDatabaseNumber YesNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.ExpenseDetails.AppointmentTrader Fees.oneOf[0]number Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.ExpenseDetails.AppointmentTrader Fees.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.ExpenseDetails.Payout FeesDatabaseNumber YesNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.ExpenseDetails.Payout Fees.oneOf[0]number Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.ExpenseDetails.Payout Fees.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.ExpenseDetails.InterestDatabaseNumber YesNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.ExpenseDetails.Interest.oneOf[0]number Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.ExpenseDetails.Interest.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.ExpenseDetails.MLM Commissions Paid To OthersDatabaseNumber YesNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.ExpenseDetails.MLM Commissions Paid To Others.oneOf[0]number Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[0].*.ExpenseDetails.MLM Commissions Paid To Others.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[1] = null Yes
$.oneOf[0].allOf[1].Payload.userTaxEarningsData.anyOf[2]array Yes
$.oneOf[0].allOf[1].Payload.userCommunityVerificationStatusstring ["Unverified","Verified"] Yes
$.oneOf[0].allOf[1].Payload.userCommunityVerifiedDataPrivacySettingstring ["do_not_publicly_share","share_name","share_profession","share_name_and_profession"] Yes
$.oneOf[0].allOf[1].Payload.userCommunityVerificationUsers Yes
$.oneOf[0].allOf[1].Payload.userCommunityVerificationUsers.anyOf[0]array Yes
$.oneOf[0].allOf[1].Payload.userCommunityVerificationUsers.anyOf[0][]object No
$.oneOf[0].allOf[1].Payload.userCommunityVerificationUsers.anyOf[0][].verificationCreatedDatestring Yes
$.oneOf[0].allOf[1].Payload.userCommunityVerificationUsers.anyOf[0][].verificationUserAvatarstring Yes
$.oneOf[0].allOf[1].Payload.userCommunityVerificationUsers.anyOf[0][].verificationUserAliasstring Yes
$.oneOf[0].allOf[1].Payload.userCommunityVerificationUsers.anyOf[0][].verificationMessage Yes
$.oneOf[0].allOf[1].Payload.userCommunityVerificationUsers.anyOf[0][].verificationMessage.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.userCommunityVerificationUsers.anyOf[0][].verificationMessage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.userCommunityVerificationUsers.anyOf[0][].isPositiveVerification Yes
$.oneOf[0].allOf[1].Payload.userCommunityVerificationUsers.anyOf[0][].isPositiveVerification.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.userCommunityVerificationUsers.anyOf[0][].isPositiveVerification.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.userCommunityVerificationUsers.anyOf[0][].isPositiveVerification.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.userCommunityVerificationUsers.anyOf[0][].isPositiveVerification.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.userCommunityVerificationUsers.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.userLoginCodeobject NoPresent only for authorized administrators on RC with a live development login code; absent in production. The example 0000 is fake.
$.oneOf[0].allOf[1].Payload.userLoginCode.codestring Yes
$.oneOf[0].allOf[1].Payload.userLoginCode.remainingSecondsinteger Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_details",
    "RequestUserAlias": "example-user",
    "Payload": {
        "userId": 0,
        "userAlias": "synthetic-example",
        "userEmail": "synthetic-example",
        "userFirstName": "synthetic-example",
        "userLastName": "synthetic-example",
        "userProfession": "synthetic-example",
        "userNumberLogins": 0,
        "userAccountStatus": "Unverified",
        "userAccountPayoutDetailsStatus": "NotReviewed",
        "userAccountPayoutDetailsStatusLastUpdateDate": "synthetic-example",
        "userTaxEarningsDataLastUpdateDate": "synthetic-example",
        "userTaxEarningsData": [],
        "userCommunityVerificationStatus": "Unverified",
        "userCommunityVerifiedDataPrivacySetting": "do_not_publicly_share",
        "userCommunityVerificationUsers": []
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_email_change

#
Read the original authenticated owner's latest email change, or inspect a target with AccessSpecialFunctions.

Parameters

NameTypeRequiredDefaultDescription
userID int No 0 0 selects the original caller, ignoring impersonation. Positive IDs require admin permission.
includeHistory bool No false Include the current email and retained change history. Default false keeps shell polling small.
beforeID int No 0 For history pagination, return requests older than this ID. 0 starts with the newest requests.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_email_change' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userID={{userID}}' \
  --data-urlencode 'includeHistory={{includeHistory}}' \
  --data-urlencode 'beforeID={{beforeID}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_email_change_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payload Yes
$.oneOf[0].allOf[1].Payload.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request.anyOf[0].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request.anyOf[0].oldEmailstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request.anyOf[0].newEmailstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request.anyOf[0].statusstring ["Preparing","Pending","Completed","Cancelled","Expired","Failed"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request.anyOf[0].reason Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request.anyOf[0].reason.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request.anyOf[0].reason.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request.anyOf[0].activeboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request.anyOf[0].requestedAtstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request.anyOf[0].resolvedAt Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request.anyOf[0].resolvedAt.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request.anyOf[0].resolvedAt.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request.anyOf[0].dueAt Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request.anyOf[0].dueAt.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request.anyOf[0].dueAt.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request.anyOf[0].verifiedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].request.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request.anyOf[0].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request.anyOf[0].oldEmailstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request.anyOf[0].newEmailstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request.anyOf[0].statusstring ["Preparing","Pending","Completed","Cancelled","Expired","Failed"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request.anyOf[0].reason Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request.anyOf[0].reason.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request.anyOf[0].reason.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request.anyOf[0].activeboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request.anyOf[0].requestedAtstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request.anyOf[0].resolvedAt Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request.anyOf[0].resolvedAt.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request.anyOf[0].resolvedAt.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request.anyOf[0].dueAt Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request.anyOf[0].dueAt.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request.anyOf[0].dueAt.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request.anyOf[0].verifiedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].request.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].currentEmailstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].historyarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].history[]object No
$.oneOf[0].allOf[1].Payload.anyOf[1].history[].idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].history[].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].history[].oldEmailstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].history[].newEmailstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].history[].statusstring ["Preparing","Pending","Completed","Cancelled","Expired","Failed"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].history[].reason Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].history[].reason.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].history[].reason.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].history[].activeboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].history[].requestedAtstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].history[].resolvedAt Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].history[].resolvedAt.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].history[].resolvedAt.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].history[].dueAt Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].history[].dueAt.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].history[].dueAt.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].history[].verifiedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].nextBeforeID Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].nextBeforeID.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].nextBeforeID.anyOf[1]null Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_email_change",
    "RequestUserAlias": "example-user",
    "Payload": {
        "request": {
            "id": 0,
            "userID": 0,
            "oldEmail": "old-owner@example.invalid",
            "newEmail": "new-owner@example.invalid",
            "status": "Preparing",
            "reason": "synthetic-example",
            "active": false,
            "requestedAt": "synthetic-example",
            "resolvedAt": "synthetic-example",
            "dueAt": "synthetic-example",
            "verified": false
        }
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_evaluate_permission

#
Returns the current value of the requested permission

Parameters

NameTypeRequiredDefaultDescription
permissionName string Yes — Name of Permission
userAlias string No "" Alias of user that the permission should be evaluated for. Note: AccessSpecialFunctions permission is required to check other users permissions.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_evaluate_permission' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'permissionName={{permissionName}}' \
  --data-urlencode 'userAlias={{userAlias}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_evaluate_permission_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].PayloadPermissionSettingValue Yes
$.oneOf[0].allOf[1].Payload.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[1].Payload.oneOf[1]array Yes
$.oneOf[0].allOf[1].Payload.oneOf[1][]PermissionSettingValue No
$.oneOf[0].allOf[1].Payload.oneOf[2]object Yes
$.oneOf[0].allOf[1].Payload.oneOf[2].*PermissionSettingValue No
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_evaluate_permission",
    "RequestUserAlias": "example-user",
    "Payload": true
}
Machine-readable endpoint documentation
GET

/v1/user/get_profile

#
Returns a public profile payload for a user, suitable for rendering a profile screen or sharing externally. The response is viewer-aware: sensitive metrics (chargeback rate, vendor balances, U2U transfers, ...) are only included when the calling API user has the AccessSpecialFunctions permission. Anonymous callers receive the public subset. Private addressManager contact details are included only for the profile owner, including when the viewer has administrative permissions. Inner Circle invitationShareURL is included only for the owner: it is empty until a saved intro and selected profile photo are available. Each medal includes a nullable sponsor with public identity, avatar, imageURL and profileURL, subject to both profiles' visibility. On another user's profile, customerSurveys.hasCompleted and completedURL expose access to questionnaires that user completed for the acting seller only. actions.canDeleteAllPosts is true only for GlobalCommunityAdministration viewers of another user. The preview is available before suspension, but execution requires the target to be Suspended. sellerVenueShowcase contains unrestricted venues/total and restrictedVenues/restrictedTotal, each capped at eight completed-request venues. Restricted entries omit trade and fill metrics. Public-by-design: profile pages are public unless the owner has set a visibility threshold; private/sensitive fields are gated before they are added to the response.

Parameters

NameTypeRequiredDefaultDescription
userAlias string Yes — Public alias of the user to view.
includeAdditionalStats bool No true Include expanded non-hero metrics and guidance for already-granted profile actions. V2 web profiles set this to false and lazy-load expanded metrics; locked-action guidance remains included.
includeMedalTracks bool No false Include self-only published medal track progress in the viewer payload.
sourceMentionId int No 0 Optional at_global_mid from the referring post. Only accessible mentions of this profile are returned in viewer.sourceMention.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_profile' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'includeAdditionalStats={{includeAdditionalStats}}' \
  --data-urlencode 'includeMedalTracks={{includeMedalTracks}}' \
  --data-urlencode 'sourceMentionId={{sourceMentionId}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_profile_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.identityobject Yes
$.oneOf[0].allOf[1].Payload.identity.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.identity.communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.identity.importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.identity.followerCountinteger Yes
$.oneOf[0].allOf[1].Payload.identity.followingCountinteger Yes
$.oneOf[0].allOf[1].Payload.identity.profileViewCountinteger Yes
$.oneOf[0].allOf[1].Payload.identity.aliasstring Yes
$.oneOf[0].allOf[1].Payload.identity.avatarstring Yes
$.oneOf[0].allOf[1].Payload.identity.profileURLstring Yes
$.oneOf[0].allOf[1].Payload.identity.communitiesURLstring Yes
$.oneOf[0].allOf[1].Payload.identity.accountStatusstring ["Unverified","Verified","Suspended"] Yes
$.oneOf[0].allOf[1].Payload.identity.profileIntentstring ["","buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.identity.communityVerificationStatus Yes
$.oneOf[0].allOf[1].Payload.identity.communityVerificationStatus.anyOf[0]string ["Unverified","Verified"] Yes
$.oneOf[0].allOf[1].Payload.identity.communityVerificationStatus.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.identity.firstOnline Yes
$.oneOf[0].allOf[1].Payload.identity.firstOnline.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.identity.firstOnline.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.identity.createdDate Yes
$.oneOf[0].allOf[1].Payload.identity.createdDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.identity.createdDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.identity.lastOnline Yes
$.oneOf[0].allOf[1].Payload.identity.lastOnline.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.identity.lastOnline.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.identity.firstOnlineEpoch Yes
$.oneOf[0].allOf[1].Payload.identity.firstOnlineEpoch.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.identity.firstOnlineEpoch.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.identity.createdDateEpoch Yes
$.oneOf[0].allOf[1].Payload.identity.createdDateEpoch.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.identity.createdDateEpoch.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.identity.lastOnlineEpoch Yes
$.oneOf[0].allOf[1].Payload.identity.lastOnlineEpoch.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.identity.lastOnlineEpoch.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.identity.wroteAppReviewboolean Yes
$.oneOf[0].allOf[1].Payload.identity.role Yes
$.oneOf[0].allOf[1].Payload.identity.role.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.identity.role.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].bodyPreviewstring Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].urlstring Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].authorobject Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].author.idinteger Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].author.aliasstring Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].author.avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].author.profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].boardobject Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].board.idinteger Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].board.namestring Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].board.slugstring Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].board.typestring Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].imageMediaCountinteger Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].mediaarray Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].media[]object No
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].media[].idinteger Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].media[].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].media[].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].media[].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].media[].widthinteger Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].media[].heightinteger Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].media[].titlestring Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].media[].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].media[].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].selectedProfileImageMediaIDinteger Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].selectedBannerImageMediaIDinteger Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].selectedProfileImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].selectedProfileImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].selectedProfileImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].selectedProfileImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].selectedBannerImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].selectedBannerImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].selectedBannerImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[0].selectedBannerImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.identity.aboutPost.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.identity.profileImageMedia Yes
$.oneOf[0].allOf[1].Payload.identity.profileImageMedia.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.identity.profileImageMedia.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.identity.profileImageMedia.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.identity.profileImageMedia.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.identity.profileImageMedia.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.identity.profileImageMedia.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.identity.profileImageMedia.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.identity.profileImageMedia.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.identity.profileImageMedia.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.identity.profileImageMedia.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.identity.profileImageMedia.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.identity.profileImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.identity.profileImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.identity.profileImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.identity.profileImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.identity.bannerImageMedia Yes
$.oneOf[0].allOf[1].Payload.identity.bannerImageMedia.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.identity.bannerImageMedia.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.identity.bannerImageMedia.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.identity.bannerImageMedia.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.identity.bannerImageMedia.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.identity.bannerImageMedia.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.identity.bannerImageMedia.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.identity.bannerImageMedia.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.identity.bannerImageMedia.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.identity.bannerImageMedia.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.identity.bannerImageMedia.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.identity.bannerImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.identity.bannerImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.identity.bannerImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.identity.bannerImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.identity.lastLocalization Yes
$.oneOf[0].allOf[1].Payload.identity.lastLocalization.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.identity.lastLocalization.anyOf[0].localeCodestring Yes
$.oneOf[0].allOf[1].Payload.identity.lastLocalization.anyOf[0].languageCodestring Yes
$.oneOf[0].allOf[1].Payload.identity.lastLocalization.anyOf[0].languageLabelstring Yes
$.oneOf[0].allOf[1].Payload.identity.lastLocalization.anyOf[0].regionCodestring Yes
$.oneOf[0].allOf[1].Payload.identity.lastLocalization.anyOf[0].sessionCountryCodestring Yes
$.oneOf[0].allOf[1].Payload.identity.lastLocalization.anyOf[0].sessionCountryNamestring Yes
$.oneOf[0].allOf[1].Payload.identity.lastLocalization.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.identity.lastLocalization.anyOf[0].displayLabelstring Yes
$.oneOf[0].allOf[1].Payload.identity.lastLocalization.anyOf[0].lastUpdateDate Yes
$.oneOf[0].allOf[1].Payload.identity.lastLocalization.anyOf[0].lastUpdateDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.identity.lastLocalization.anyOf[0].lastUpdateDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.identity.lastLocalization.anyOf[0].lastUpdateEpoch Yes
$.oneOf[0].allOf[1].Payload.identity.lastLocalization.anyOf[0].lastUpdateEpoch.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.identity.lastLocalization.anyOf[0].lastUpdateEpoch.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.identity.lastLocalization.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.identity.aliasHistoryarray Yes
$.oneOf[0].allOf[1].Payload.identity.aliasHistory[]object No
$.oneOf[0].allOf[1].Payload.identity.aliasHistory[].previousAliasstring Yes
$.oneOf[0].allOf[1].Payload.identity.aliasHistory[].newAliasstring Yes
$.oneOf[0].allOf[1].Payload.identity.aliasHistory[].changedDate Yes
$.oneOf[0].allOf[1].Payload.identity.aliasHistory[].changedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.identity.aliasHistory[].changedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.identity.aliasHistory[].changedDateEpoch Yes
$.oneOf[0].allOf[1].Payload.identity.aliasHistory[].changedDateEpoch.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.identity.aliasHistory[].changedDateEpoch.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.salesHistory Yes
$.oneOf[0].allOf[1].Payload.salesHistory.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.salesHistory.anyOf[0].positivePctnumber Yes
$.oneOf[0].allOf[1].Payload.salesHistory.anyOf[0].refundRatenumber Yes
$.oneOf[0].allOf[1].Payload.salesHistory.anyOf[0].salesCountinteger Yes
$.oneOf[0].allOf[1].Payload.salesHistory.anyOf[0].tonestring ["warning","negative","positive"] Yes
$.oneOf[0].allOf[1].Payload.salesHistory.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.salesHistory.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venuesarray Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[]object No
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].isRestrictedByRegulationboolean Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].globalATRankinteger Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].recentDemandCountinteger Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].completedTradeCountinteger Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].bidFillCountinteger Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].locationAliasstring Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].locationNamestring Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].locationURLstring Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].citystring Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].categoryNamestring Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].globalATRankLabelstring Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].lastFollowUpdateDatestring Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].lastFollowUpdateLabelstring Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].sourceKeysarray Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].sourceKeys[] = "exact" No
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].signalLabelsarray Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].signalLabels[]string No
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].proofLabelsarray Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].venues[].proofLabels[]string No
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].totalinteger Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].restrictedVenuesarray Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].restrictedVenues[]object No
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].restrictedVenues[].isRestrictedByRegulationboolean Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].restrictedVenues[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].restrictedVenues[].globalATRankinteger Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].restrictedVenues[].locationAliasstring Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].restrictedVenues[].locationNamestring Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].restrictedVenues[].locationURLstring Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].restrictedVenues[].citystring Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].restrictedVenues[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].restrictedVenues[].categoryNamestring Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].restrictedVenues[].globalATRankLabelstring Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[0].restrictedTotalinteger Yes
$.oneOf[0].allOf[1].Payload.sellerVenueShowcase.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.badgesobject Yes
$.oneOf[0].allOf[1].Payload.badges.medalsarray Yes
$.oneOf[0].allOf[1].Payload.badges.medals[]object No
$.oneOf[0].allOf[1].Payload.badges.medals[].name Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].name.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].name.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].description Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].description.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].description.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].iconURL Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].iconURL.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].iconURL.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].color Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].color.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].color.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].slug Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].slug.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].slug.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].medalCategoryName Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].medalCategoryName.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].medalCategoryName.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].medalCategorySlug Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].medalCategorySlug.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].medalCategorySlug.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].textColorstring Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].sponsor Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].sponsor.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].sponsor.anyOf[0].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].sponsor.anyOf[0].aliasstring Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].sponsor.anyOf[0].avatarstring Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].sponsor.anyOf[0].imageURLstring Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].sponsor.anyOf[0].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].sponsor.anyOf[0].displayHTMLstring Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].sponsor.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.badges.medals[].isNegativeboolean Yes
$.oneOf[0].allOf[1].Payload.ratingsobject Yes
$.oneOf[0].allOf[1].Payload.ratings.sellerobject Yes
$.oneOf[0].allOf[1].Payload.ratings.seller.rolestring ["seller","buyer"] Yes
$.oneOf[0].allOf[1].Payload.ratings.seller.rating Yes
$.oneOf[0].allOf[1].Payload.ratings.seller.rating.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.ratings.seller.rating.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ratings.seller.ratingCountinteger Yes
$.oneOf[0].allOf[1].Payload.ratings.seller.minimumRatingCountinteger Yes
$.oneOf[0].allOf[1].Payload.ratings.seller.hasPublicRatingboolean Yes
$.oneOf[0].allOf[1].Payload.ratings.seller.boardIDinteger Yes
$.oneOf[0].allOf[1].Payload.ratings.seller.boardURLstring Yes
$.oneOf[0].allOf[1].Payload.ratings.seller.latestReviewsarray Yes
$.oneOf[0].allOf[1].Payload.ratings.seller.latestReviews[]object No
$.oneOf[0].allOf[1].Payload.ratings.seller.latestReviews[].idinteger Yes
$.oneOf[0].allOf[1].Payload.ratings.seller.latestReviews[].ratinginteger Yes
$.oneOf[0].allOf[1].Payload.ratings.seller.latestReviews[].titlestring Yes
$.oneOf[0].allOf[1].Payload.ratings.seller.latestReviews[].textstring Yes
$.oneOf[0].allOf[1].Payload.ratings.seller.latestReviews[].authorAliasstring Yes
$.oneOf[0].allOf[1].Payload.ratings.seller.latestReviews[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.ratings.seller.latestReviews[].urlstring Yes
$.oneOf[0].allOf[1].Payload.ratings.buyerobject Yes
$.oneOf[0].allOf[1].Payload.ratings.buyer.rolestring ["seller","buyer"] Yes
$.oneOf[0].allOf[1].Payload.ratings.buyer.rating Yes
$.oneOf[0].allOf[1].Payload.ratings.buyer.rating.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.ratings.buyer.rating.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ratings.buyer.ratingCountinteger Yes
$.oneOf[0].allOf[1].Payload.ratings.buyer.minimumRatingCountinteger Yes
$.oneOf[0].allOf[1].Payload.ratings.buyer.hasPublicRatingboolean Yes
$.oneOf[0].allOf[1].Payload.ratings.buyer.boardIDinteger Yes
$.oneOf[0].allOf[1].Payload.ratings.buyer.boardURLstring Yes
$.oneOf[0].allOf[1].Payload.ratings.buyer.latestReviewsarray Yes
$.oneOf[0].allOf[1].Payload.ratings.buyer.latestReviews[]object No
$.oneOf[0].allOf[1].Payload.ratings.buyer.latestReviews[].idinteger Yes
$.oneOf[0].allOf[1].Payload.ratings.buyer.latestReviews[].ratinginteger Yes
$.oneOf[0].allOf[1].Payload.ratings.buyer.latestReviews[].titlestring Yes
$.oneOf[0].allOf[1].Payload.ratings.buyer.latestReviews[].textstring Yes
$.oneOf[0].allOf[1].Payload.ratings.buyer.latestReviews[].authorAliasstring Yes
$.oneOf[0].allOf[1].Payload.ratings.buyer.latestReviews[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.ratings.buyer.latestReviews[].urlstring Yes
$.oneOf[0].allOf[1].Payload.activeRating Yes
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[0].rolestring ["seller","buyer"] Yes
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[0].rating Yes
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[0].rating.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[0].rating.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[0].ratingCountinteger Yes
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[0].minimumRatingCountinteger Yes
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[0].hasPublicRatingboolean Yes
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[0].boardIDinteger Yes
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[0].boardURLstring Yes
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[0].latestReviewsarray Yes
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[0].latestReviews[]object No
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[0].latestReviews[].idinteger Yes
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[0].latestReviews[].ratinginteger Yes
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[0].latestReviews[].titlestring Yes
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[0].latestReviews[].textstring Yes
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[0].latestReviews[].authorAliasstring Yes
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[0].latestReviews[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[0].latestReviews[].urlstring Yes
$.oneOf[0].allOf[1].Payload.activeRating.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewerobject Yes
$.oneOf[0].allOf[1].Payload.viewer.isSelfboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.isAuthenticatedboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.isFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.targetFollowsViewerboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.isPinnedboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.canHireDirectlyboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.hasPurchasedFromTargetboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.hasSoldToTargetboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.recentReimbursementEligibleboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.canEditProfileboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.canViewTransactionsboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.canChangeUsernameboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.canViewProfileVisitorsboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.directHireFeeDiscountPct Yes
$.oneOf[0].allOf[1].Payload.viewer.directHireFeeDiscountPct.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.viewer.directHireFeeDiscountPct.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.customerCountinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.numberListingsBoughtFromTargetinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.numberListingsSoldToTargetinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoardIDinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.lastTransactionTimestamp Yes
$.oneOf[0].allOf[1].Payload.viewer.lastTransactionTimestamp.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.viewer.lastTransactionTimestamp.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.accountAccessobject Yes
$.oneOf[0].allOf[1].Payload.viewer.accountAccess.canGrantAccessboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.accountAccess.grantedAccessCountinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.accountAccess.accessibleAccountCountinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.accountAccess.showActionboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.allowChatRequests Yes
$.oneOf[0].allOf[1].Payload.viewer.allowChatRequests.anyOf[0]boolean Yes
$.oneOf[0].allOf[1].Payload.viewer.allowChatRequests.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].permissionExistsboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].permissionID Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].permissionID.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].permissionID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].permissionNamestring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].permissionDescriptionstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].defaultSettingPayload Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].defaultSettingPayload.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].defaultSettingPayload.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].hasPermissionboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroupsarray Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[]object No
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].idinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].userGroupIDinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].importanceinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].namestring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].slugstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].iconstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].colorstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].textColorstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].medalCategoryNamestring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].medalCategorySlugstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].statusURLstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].permissionPayloadstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].medalID Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].medalID.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].medalID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].medalCategoryID Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].medalCategoryID.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].requiredUserGroups[].medalCategoryID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccessarray Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[]object No
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].avatarstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].topUserGroupNamestring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].topMedalCategoryNamestring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageMedia Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageMedia.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageMedia.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageMedia.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageMedia.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageMedia.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageMedia.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageMedia.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageMedia.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageMedia.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageMedia.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageMedia.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageMedia.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageMedia.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageMedia.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageMedia.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageMedia.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageMedia Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageMedia.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageMedia.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageMedia.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageMedia.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageMedia.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageMedia.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageMedia.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageMedia.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageMedia.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageMedia.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageMedia.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageMedia.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageMedia.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageMedia.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageMedia.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageMedia.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageFrame Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageFrame.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageFrame.anyOf[0].positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageFrame.anyOf[0].positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageFrame.anyOf[0].zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].profileImageFrame.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageFrame Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageFrame.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageFrame.anyOf[0].positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageFrame.anyOf[0].positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageFrame.anyOf[0].zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].bannerImageFrame.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].aliasstring | null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].avatarstring | null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].avatarEmojistring | null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileImageUrlstring | null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileImageURLstring | null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileUrlstring | null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileURLstring | null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].customColorstring | null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].customTextColorstring | null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].avatarModestring | null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].htmlstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].idinteger | null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].userIDinteger | null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].isRichboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileImage Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].profileImage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].medalsarray Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].medals[]object No
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].medals[].Namestring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].medals[].URLstring Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].identityHiddenboolean NoAn anonymized author has no profile or follow action.
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[0].identityHiddenUntilinteger | null NoCurrent response-race closing timestamp in Unix seconds.
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].membersWithAccess[].display.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[0].totalMemberCountinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisitorsPermissionGate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.relationshipControls Yes
$.oneOf[0].allOf[1].Payload.viewer.relationshipControls.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.viewer.relationshipControls.anyOf[0].actorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.relationshipControls.anyOf[0].targetUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.relationshipControls.anyOf[0].isBlockedboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.relationshipControls.anyOf[0].blockedDate Yes
$.oneOf[0].allOf[1].Payload.viewer.relationshipControls.anyOf[0].blockedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.viewer.relationshipControls.anyOf[0].blockedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.relationshipControls.anyOf[0].isMutedboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.relationshipControls.anyOf[0].mutedDate Yes
$.oneOf[0].allOf[1].Payload.viewer.relationshipControls.anyOf[0].mutedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.viewer.relationshipControls.anyOf[0].mutedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.relationshipControls.anyOf[0].reasonstring Yes
$.oneOf[0].allOf[1].Payload.viewer.relationshipControls.anyOf[0].personalNotestring Yes
$.oneOf[0].allOf[1].Payload.viewer.relationshipControls.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.targetRelationshipControls Yes
$.oneOf[0].allOf[1].Payload.viewer.targetRelationshipControls.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.viewer.targetRelationshipControls.anyOf[0].actorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.targetRelationshipControls.anyOf[0].targetUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.targetRelationshipControls.anyOf[0].isBlockedboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.targetRelationshipControls.anyOf[0].blockedDate Yes
$.oneOf[0].allOf[1].Payload.viewer.targetRelationshipControls.anyOf[0].blockedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.viewer.targetRelationshipControls.anyOf[0].blockedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.targetRelationshipControls.anyOf[0].isMutedboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.targetRelationshipControls.anyOf[0].mutedDate Yes
$.oneOf[0].allOf[1].Payload.viewer.targetRelationshipControls.anyOf[0].mutedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.viewer.targetRelationshipControls.anyOf[0].mutedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.targetRelationshipControls.anyOf[0].reasonstring Yes
$.oneOf[0].allOf[1].Payload.viewer.targetRelationshipControls.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].summaryobject Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].summary.publishedCountinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].summary.earnedCountinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].summary.inProgressCountinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].summary.highestCountinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracksarray Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[]object No
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].categoryobject Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].category.idinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].category.namestring Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].category.slugstring Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].category.descriptionstring Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].category.iconURLstring Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].category.colorstring Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].category.textColorstring Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].category.isNegativeboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].currentTier Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].currentTier.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].currentTier.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].currentTier.anyOf[0].namestring Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].currentTier.anyOf[0].slugstring Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].currentTier.anyOf[0].iconURLstring Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].currentTier.anyOf[0].colorstring Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].currentTier.anyOf[0].textColorstring Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].currentTier.anyOf[0].importanceinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].currentTier.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].targetTier Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].targetTier.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].targetTier.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].targetTier.anyOf[0].namestring Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].targetTier.anyOf[0].slugstring Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].targetTier.anyOf[0].iconURLstring Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].targetTier.anyOf[0].colorstring Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].targetTier.anyOf[0].textColorstring Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].targetTier.anyOf[0].importanceinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].targetTier.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].statusKeystring ["not_started","in_progress","highest"] Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].progressPercentinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].tierCountinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[0].tracks[].overviewURLstring Yes
$.oneOf[0].allOf[1].Payload.viewer.medalTracks.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.sourceMention No
$.oneOf[0].allOf[1].Payload.viewer.sourceMention.anyOf[0]object No
$.oneOf[0].allOf[1].Payload.viewer.sourceMention.anyOf[0].mentionIdinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.sourceMention.anyOf[0].postIdinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.sourceMention.anyOf[0].targetUserIdinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.sourceMention.anyOf[1]null No
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoard No
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoard.anyOf[0]object No
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoard.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoard.anyOf[0].boardIDinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoard.anyOf[0].countinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoard.anyOf[0].slugstring Yes
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoard.anyOf[0].namestring Yes
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoard.anyOf[0].citystring Yes
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoard.anyOf[0].cityGroupCodestring Yes
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoard.anyOf[0].intentstring Yes
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoard.anyOf[0].callbackstring Yes
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoard.anyOf[0].unitLabelstring Yes
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoard.anyOf[0].routingDescriptionstring Yes
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoard.anyOf[0].createsRegularBoardPostboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoard.anyOf[0].isDefaultRequestBoardboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoard.anyOf[0].isDefaultListingBoardboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoard.anyOf[0].routingEnabledboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoard.anyOf[0].selectedboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.selfWallBoard.anyOf[1]null No
$.oneOf[0].allOf[1].Payload.viewer.profileVisibilitySettings No
$.oneOf[0].allOf[1].Payload.viewer.profileVisibilitySettings.anyOf[0]object No
$.oneOf[0].allOf[1].Payload.viewer.profileVisibilitySettings.anyOf[0].profileVisibleImportancePointsThresholdinteger Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisibilitySettings.anyOf[0].profileVisibilityModestring ["public","rich_lock","full_lock"] Yes
$.oneOf[0].allOf[1].Payload.viewer.profileVisibilitySettings.anyOf[1]null No
$.oneOf[0].allOf[1].Payload.heroStatsarray Yes
$.oneOf[0].allOf[1].Payload.heroStats[]object No
$.oneOf[0].allOf[1].Payload.heroStats[].keystring Yes
$.oneOf[0].allOf[1].Payload.heroStats[].labelstring Yes
$.oneOf[0].allOf[1].Payload.heroStats[].formattedValuestring Yes
$.oneOf[0].allOf[1].Payload.heroStats[].value Yes
$.oneOf[0].allOf[1].Payload.heroStats[].value.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.heroStats[].value.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.heroStats[].formatstring ["abbreviated-usd","abbreviated-number","decimal-percentage","short-percentage","usd","short-usd","short-number","raw"] Yes
$.oneOf[0].allOf[1].Payload.heroStats[].tonestring ["neutral","negative","warning","positive"] Yes
$.oneOf[0].allOf[1].Payload.heroStats[].iconURL Yes
$.oneOf[0].allOf[1].Payload.heroStats[].iconURL.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.heroStats[].iconURL.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.heroStats[].infoboxTitle Yes
$.oneOf[0].allOf[1].Payload.heroStats[].infoboxTitle.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.heroStats[].infoboxTitle.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.heroStats[].infoboxContent Yes
$.oneOf[0].allOf[1].Payload.heroStats[].infoboxContent.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.heroStats[].infoboxContent.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.heroStats[].detail Yes
$.oneOf[0].allOf[1].Payload.heroStats[].detail.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.heroStats[].detail.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.heroStats[].infoboxRowsarray Yes
$.oneOf[0].allOf[1].Payload.heroStats[].infoboxRows[] No
$.oneOf[0].allOf[1].Payload.heroStats[].infoboxRows[].anyOf[0]object No
$.oneOf[0].allOf[1].Payload.heroStats[].infoboxRows[].anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.heroStats[].infoboxRows[].anyOf[0].valuestring Yes
$.oneOf[0].allOf[1].Payload.heroStats[].infoboxRows[].anyOf[1]object No
$.oneOf[0].allOf[1].Payload.heroStats[].infoboxRows[].anyOf[1].type = "heading" Yes
$.oneOf[0].allOf[1].Payload.heroStats[].infoboxRows[].anyOf[1].labelstring Yes
$.oneOf[0].allOf[1].Payload.additionalStatsarray Yes
$.oneOf[0].allOf[1].Payload.additionalStats[]object No
$.oneOf[0].allOf[1].Payload.additionalStats[].keystring Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].labelstring Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].formattedValuestring Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].value Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].value.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].value.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].formatstring ["abbreviated-usd","abbreviated-number","decimal-percentage","short-percentage","usd","short-usd","short-number","raw"] Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].tonestring ["neutral","negative","warning","positive"] Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].iconURL Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].iconURL.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].iconURL.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].infoboxTitle Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].infoboxTitle.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].infoboxTitle.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].infoboxContent Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].infoboxContent.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].infoboxContent.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].detail Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].detail.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].detail.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].infoboxRowsarray Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].infoboxRows[] No
$.oneOf[0].allOf[1].Payload.additionalStats[].infoboxRows[].anyOf[0]object No
$.oneOf[0].allOf[1].Payload.additionalStats[].infoboxRows[].anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].infoboxRows[].anyOf[0].valuestring Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].infoboxRows[].anyOf[1]object No
$.oneOf[0].allOf[1].Payload.additionalStats[].infoboxRows[].anyOf[1].type = "heading" Yes
$.oneOf[0].allOf[1].Payload.additionalStats[].infoboxRows[].anyOf[1].labelstring Yes
$.oneOf[0].allOf[1].Payload.additionalMetricCount Yes
$.oneOf[0].allOf[1].Payload.additionalMetricCount.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.additionalMetricCount.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.actions Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].canDeleteAllPostsboolean Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].canFollowboolean Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].canMessageboolean Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].canSponsorMedalboolean Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].canRequestSponsorshipboolean Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].canSendReimbursementboolean Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].canCreateSupportRequestboolean Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].canLinkReferrerboolean Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].canViewAdminAccountDetailsboolean Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].canViewSalesHistoryboolean Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].canOpenSupportRefundCaseboolean Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].canViewProfileVisitorsboolean Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].salesHistoryScopestring ["all","shared"] Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].existingChatTagID Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].existingChatTagID.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].existingChatTagID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].existingSupportTagID Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].existingSupportTagID.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].existingSupportTagID.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].existingSupportTagID.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[0].existingSupportTagID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.actions.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.recentPosts Yes
$.oneOf[0].allOf[1].Payload.recentPosts.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.recentPosts.anyOf[0].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.recentPosts.anyOf[0].legacyEndpointstring Yes
$.oneOf[0].allOf[1].Payload.recentPosts.anyOf[0].legacyParamsobject Yes
$.oneOf[0].allOf[1].Payload.recentPosts.anyOf[0].legacyParams.viewtype = "UserThreads" Yes
$.oneOf[0].allOf[1].Payload.recentPosts.anyOf[0].legacyParams.ThreadsUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.recentPosts.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.innerCircle Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].countinteger Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].requiredNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].netPositiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].remainingNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].countFormattedstring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].previewLimit = 12 Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].membersarray Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[]object No
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].avatarstring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].communityVerificationCountFormattedstring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].importancePointsFormattedstring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].latestVerificationDatestring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].latestVerificationDateFormattedstring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].displayobject Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.aliasstring | null Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.avatarstring | null Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.avatarEmojistring | null Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileImageUrlstring | null Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileImageURLstring | null Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.labelstring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileUrlstring | null Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileURLstring | null Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.titlestring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.customColorstring | null Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.customTextColorstring | null Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.avatarModestring | null Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.htmlstring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.idinteger | null Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.userIDinteger | null Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.isRichboolean Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileImage Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.profileImage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.medalsarray Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.medals[]object No
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.medals[].Namestring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.medals[].URLstring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.identityHiddenboolean NoAn anonymized author has no profile or follow action.
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].display.identityHiddenUntilinteger | null NoCurrent response-race closing timestamp in Unix seconds.
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].profileImageMedia Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].profileImageMedia.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].profileImageMedia.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].profileImageMedia.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].profileImageMedia.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].profileImageMedia.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].profileImageMedia.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].profileImageMedia.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].profileImageMedia.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].profileImageMedia.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].profileImageMedia.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].profileImageMedia.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].profileImageMedia.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].profileImageMedia.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].profileImageMedia.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].profileImageMedia.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].profileImageMedia.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].medalsarray Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].medals[]object No
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].medals[].Namestring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].medals[].URLstring Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].communityVerificationStatusstring ["","Unverified","Verified"] Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].verifiedTargetboolean Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].members[].wasVerifiedByTargetboolean Yes
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[0].invitationShareURLstring No
$.oneOf[0].allOf[1].Payload.innerCircle.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.visibilityobject Yes
$.oneOf[0].allOf[1].Payload.visibility.canViewProfileboolean Yes
$.oneOf[0].allOf[1].Payload.visibility.lockedboolean Yes
$.oneOf[0].allOf[1].Payload.visibility.isAnyboolean Yes
$.oneOf[0].allOf[1].Payload.visibility.isPublicboolean Yes
$.oneOf[0].allOf[1].Payload.visibility.isSelfboolean Yes
$.oneOf[0].allOf[1].Payload.visibility.canBypassboolean Yes
$.oneOf[0].allOf[1].Payload.visibility.viewerMeetsThresholdboolean Yes
$.oneOf[0].allOf[1].Payload.visibility.lockModestring ["","public","rich_lock","full_lock"] Yes
$.oneOf[0].allOf[1].Payload.visibility.profileVisibilityModestring ["public","rich_lock","full_lock"] Yes
$.oneOf[0].allOf[1].Payload.visibility.profileVisibleImportancePointsThresholdinteger Yes
$.oneOf[0].allOf[1].Payload.visibility.modestring ["public","rich_lock","full_lock"] Yes
$.oneOf[0].allOf[1].Payload.visibility.thresholdinteger Yes
$.oneOf[0].allOf[1].Payload.visibility.maxThreshold = 10000000 Yes
$.oneOf[0].allOf[1].Payload.visibility.viewerUserID Yes
$.oneOf[0].allOf[1].Payload.visibility.viewerUserID.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.visibility.viewerUserID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.visibility.viewerImportancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.addressManagerobject No
$.oneOf[0].allOf[1].Payload.addressManager.canView = true Yes
$.oneOf[0].allOf[1].Payload.addressManager.canEditboolean Yes
$.oneOf[0].allOf[1].Payload.addressManager.defaultPhonestring Yes
$.oneOf[0].allOf[1].Payload.addressManager.primary Yes
$.oneOf[0].allOf[1].Payload.addressManager.primary.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.addressManager.primary.anyOf[0].addressIDinteger Yes
$.oneOf[0].allOf[1].Payload.addressManager.primary.anyOf[0].reviewIDinteger Yes
$.oneOf[0].allOf[1].Payload.addressManager.primary.anyOf[0].formattedAddressstring Yes
$.oneOf[0].allOf[1].Payload.addressManager.primary.anyOf[0].phonestring Yes
$.oneOf[0].allOf[1].Payload.addressManager.primary.anyOf[0].status = "IdentityConfirmed" Yes
$.oneOf[0].allOf[1].Payload.addressManager.primary.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.addressManager.totalinteger Yes
$.oneOf[0].allOf[1].Payload.customerSurveysobject No
$.oneOf[0].allOf[1].Payload.customerSurveys.urlstring Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.hasCompletedboolean Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.completedURL Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.completedURL.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.completedURL.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fieldsobject Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.canForgetboolean Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.itemsarray Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[]object No
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].fieldIDinteger Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].labelstring Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].typestring ["text","longtext","number","boolean","single_select","multi_select"] Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].valueSurveyAnswerValue YesValue follows the question type: text or selected key, decimal numeric string, boolean, selected-key list, or null when unanswered.
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].value.anyOf[0]null Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].value.anyOf[1]string Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].value.anyOf[2]number Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].value.anyOf[3]boolean Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].value.anyOf[4]array Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].value.anyOf[4][]string No
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].optionsarray Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].options[]object No
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].options[].keystring Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].options[].labelstring Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].confirmedDate Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].confirmedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].confirmedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].requestIDinteger Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].sourceTitlestring Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.fields.items[].revisioninteger Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.requestsobject Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.requests.itemsarray Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.requests.items[]object No
$.oneOf[0].allOf[1].Payload.customerSurveys.requests.items[].idinteger Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.requests.items[].revisioninteger Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.requests.items[].customerIDinteger Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.requests.items[].sellerIDinteger Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.requests.items[].chatIDinteger Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.requests.items[].bidIDinteger Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.requests.items[].transactionIDinteger Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.requests.items[].titlestring Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.requests.items[].statusstring ["sent","in_progress","submitted","cancelled"] Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.requests.items[].submittedDate Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.requests.items[].submittedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.requests.items[].submittedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.requests.items[].urlstring Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.requests.items[].buyerIdentityHiddenboolean NoTrue when the authenticated viewer cannot see the buyer during the current response race.
$.oneOf[0].allOf[1].Payload.customerSurveys.requests.items[].buyerIdentityHiddenUntilinteger | null NoSaved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
$.oneOf[0].allOf[1].Payload.customerSurveys.requests.hasMoreboolean Yes
$.oneOf[0].allOf[1].Payload.customerSurveys.requests.beforeIDinteger Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_profile",
    "RequestUserAlias": "example-user",
    "Payload": {
        "identity": {
            "userID": 0,
            "communityVerificationCount": 0,
            "importancePoints": 0,
            "followerCount": 0,
            "followingCount": 0,
            "profileViewCount": 0,
            "alias": "synthetic-example",
            "avatar": "synthetic-example",
            "profileURL": "synthetic-example",
            "communitiesURL": "synthetic-example",
            "accountStatus": "Unverified",
            "profileIntent": "",
            "communityVerificationStatus": "Unverified",
            "firstOnline": "synthetic-example",
            "createdDate": "synthetic-example",
            "lastOnline": "synthetic-example",
            "firstOnlineEpoch": 0,
            "createdDateEpoch": 0,
            "lastOnlineEpoch": 0,
            "wroteAppReview": false,
            "role": "synthetic-example",
            "aboutPost": {
                "id": 0,
                "title": "synthetic-example",
                "bodyPreview": "synthetic-example",
                "url": "synthetic-example",
                "createdDate": "synthetic-example",
                "author": {
                    "id": 0,
                    "alias": "synthetic-example",
                    "avatarEmoji": "synthetic-example",
                    "profileUrl": "synthetic-example"
                },
                "board": {
                    "id": 0,
                    "name": "synthetic-example",
                    "slug": "synthetic-example",
                    "type": "synthetic-example"
                },
                "imageMediaCount": 0,
                "media": [],
                "selectedProfileImageMediaID": 0,
                "selectedBannerImageMediaID": 0,
                "selectedProfileImageFrame": {
                    "positionXPercent": 0,
                    "positionYPercent": 0,
                    "zoomPercent": 100
                },
                "selectedBannerImageFrame": {
                    "positionXPercent": 0,
                    "positionYPercent": 0,
                    "zoomPercent": 100
                }
            },
            "profileImageMedia": {
                "id": 0,
                "thumbUrl": "synthetic-example",
                "mediaUrl": "synthetic-example",
                "mediaType": "synthetic-example",
                "width": 0,
                "height": 0,
                "title": "synthetic-example",
                "isImage": false,
                "isEmbedded": false
            },
            "profileImageFrame": {
                "positionXPercent": 0,
                "positionYPercent": 0,
                "zoomPercent": 100
            },
            "bannerImageMedia": {
                "id": 0,
                "thumbUrl": "synthetic-example",
                "mediaUrl": "synthetic-example",
                "mediaType": "synthetic-example",
                "width": 0,
                "height": 0,
                "title": "synthetic-example",
                "isImage": false,
                "isEmbedded": false
            },
            "bannerImageFrame": {
                "positionXPercent": 0,
                "positionYPercent": 0,
                "zoomPercent": 100
            },
            "lastLocalization": {
                "localeCode": "synthetic-example",
                "languageCode": "synthetic-example",
                "languageLabel": "synthetic-example",
                "regionCode": "synthetic-example",
                "sessionCountryCode": "synthetic-example",
                "sessionCountryName": "synthetic-example",
                "label": "synthetic-example",
                "displayLabel": "synthetic-example",
                "lastUpdateDate": "synthetic-example",
                "lastUpdateEpoch": 0
            },
            "aliasHistory": []
        },
        "salesHistory": {
            "positivePct": 0,
            "refundRate": 0,
            "salesCount": 0,
            "tone": "warning",
            "label": "synthetic-example"
        },
        "sellerVenueShowcase": {
            "venues": [],
            "total": 0,
            "restrictedVenues": [],
            "restrictedTotal": 0
        },
        "badges": {
            "medals": []
        },
        "ratings": {
            "seller": {
                "role": "seller",
                "rating": 0,
                "ratingCount": 0,
                "minimumRatingCount": 0,
                "hasPublicRating": false,
                "boardID": 0,
                "boardURL": "synthetic-example",
                "latestReviews": []
            },
            "buyer": {
                "role": "seller",
                "rating": 0,
                "ratingCount": 0,
                "minimumRatingCount": 0,
                "hasPublicRating": false,
                "boardID": 0,
                "boardURL": "synthetic-example",
                "latestReviews": []
            }
        },
        "activeRating": {
            "role": "seller",
            "rating": 0,
            "ratingCount": 0,
            "minimumRatingCount": 0,
            "hasPublicRating": false,
            "boardID": 0,
            "boardURL": "synthetic-example",
            "latestReviews": []
        },
        "viewer": {
            "isSelf": false,
            "isAuthenticated": false,
            "isFollowing": false,
            "targetFollowsViewer": false,
            "isPinned": false,
            "canHireDirectly": false,
            "hasPurchasedFromTarget": false,
            "hasSoldToTarget": false,
            "recentReimbursementEligible": false,
            "canEditProfile": false,
            "canViewTransactions": false,
            "canChangeUsername": false,
            "canViewProfileVisitors": false,
            "directHireFeeDiscountPct": 0,
            "customerCount": 0,
            "numberListingsBoughtFromTarget": 0,
            "numberListingsSoldToTarget": 0,
            "selfWallBoardID": 0,
            "lastTransactionTimestamp": 0,
            "accountAccess": {
                "canGrantAccess": false,
                "grantedAccessCount": 0,
                "accessibleAccountCount": 0,
                "showAction": false
            },
            "allowChatRequests": false,
            "profileVisitorsPermissionGate": {
                "permissionExists": false,
                "permissionID": 0,
                "permissionName": "synthetic-example",
                "permissionDescription": "synthetic-example",
                "defaultSettingPayload": "synthetic-example",
                "hasPermission": false,
                "requiredUserGroups": [],
                "membersWithAccess": [],
                "totalMemberCount": 0
            },
            "relationshipControls": {
                "actorUserID": 0,
                "targetUserID": 0,
                "isBlocked": false,
                "blockedDate": "synthetic-example",
                "isMuted": false,
                "mutedDate": "synthetic-example",
                "reason": "synthetic-example",
                "personalNote": "synthetic-example"
            },
            "targetRelationshipControls": {
                "actorUserID": 0,
                "targetUserID": 0,
                "isBlocked": false,
                "blockedDate": "synthetic-example",
                "isMuted": false,
                "mutedDate": "synthetic-example",
                "reason": "synthetic-example"
            },
            "medalTracks": {
                "summary": {
                    "publishedCount": 0,
                    "earnedCount": 0,
                    "inProgressCount": 0,
                    "highestCount": 0
                },
                "tracks": []
            }
        },
        "heroStats": [],
        "additionalStats": [],
        "additionalMetricCount": 0,
        "actions": {
            "canDeleteAllPosts": false,
            "canFollow": false,
            "canMessage": false,
            "canSponsorMedal": false,
            "canRequestSponsorship": false,
            "canSendReimbursement": false,
            "canCreateSupportRequest": false,
            "canLinkReferrer": false,
            "canViewAdminAccountDetails": false,
            "canViewSalesHistory": false,
            "canOpenSupportRefundCase": false,
            "canViewProfileVisitors": false,
            "salesHistoryScope": "all",
            "existingChatTagID": "synthetic-example",
            "existingSupportTagID": 0
        },
        "recentPosts": {
            "userID": 0,
            "legacyEndpoint": "synthetic-example",
            "legacyParams": {
                "viewtype": "UserThreads",
                "ThreadsUserID": 0
            }
        },
        "innerCircle": {
            "count": 0,
            "requiredNetPositiveVerifications": 0,
            "netPositiveVerificationCount": 0,
            "remainingNetPositiveVerifications": 0,
            "countFormatted": "synthetic-example",
            "previewLimit": 12,
            "members": []
        },
        "visibility": {
            "canViewProfile": false,
            "locked": false,
            "isAny": false,
            "isPublic": false,
            "isSelf": false,
            "canBypass": false,
            "viewerMeetsThreshold": false,
            "lockMode": "",
            "profileVisibilityMode": "public",
            "profileVisibleImportancePointsThreshold": 0,
            "mode": "public",
            "threshold": 0,
            "maxThreshold": 10000000,
            "viewerUserID": 0,
            "viewerImportancePoints": 0
        }
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_profile_about_post_candidates

#
Finds public community posts that can be selected as the current user's profile/About Me post.

Parameters

NameTypeRequiredDefaultDescription
searchFilter string No "" Search text for public top-level posts with image media by title, body, or author alias.
postID int No 0 Exact ATDiscussionPosts.ID to preview. Exact lookup may target any public post or reply with enough image media.
pageSize int No 8 Maximum candidates to return for text search.
ownPostsOnly bool No false When true, only return public image-media posts authored by the current API user.
includeMediaLessOwnedPosts bool No false When true, include current-user posts even before image media has been attached.
minimumImageMediaCount int No 1 Minimum attached image-media items required.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_profile_about_post_candidates' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'searchFilter={{searchFilter}}' \
  --data-urlencode 'postID={{postID}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'ownPostsOnly={{ownPostsOnly}}' \
  --data-urlencode 'includeMediaLessOwnedPosts={{includeMediaLessOwnedPosts}}' \
  --data-urlencode 'minimumImageMediaCount={{minimumImageMediaCount}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_profile_about_post_candidates_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.Candidatesarray Yes
$.oneOf[0].allOf[1].Payload.Candidates[]object No
$.oneOf[0].allOf[1].Payload.Candidates[].idinteger Yes
$.oneOf[0].allOf[1].Payload.Candidates[].titlestring Yes
$.oneOf[0].allOf[1].Payload.Candidates[].bodyPreviewstring Yes
$.oneOf[0].allOf[1].Payload.Candidates[].urlstring Yes
$.oneOf[0].allOf[1].Payload.Candidates[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.Candidates[].authorAboutPostAuthor Yes
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[0].aliasstring Yes
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[0].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[0].profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1].idnull Yes
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1].aliasnull Yes
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1].avatarEmojinull Yes
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1].profileUrlnull Yes
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1].identityHidden = true Yes
$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1].identityHiddenUntilinteger Yes
$.oneOf[0].allOf[1].Payload.Candidates[].boardobject Yes
$.oneOf[0].allOf[1].Payload.Candidates[].board.idinteger Yes
$.oneOf[0].allOf[1].Payload.Candidates[].board.namestring Yes
$.oneOf[0].allOf[1].Payload.Candidates[].board.slugstring Yes
$.oneOf[0].allOf[1].Payload.Candidates[].board.typestring Yes
$.oneOf[0].allOf[1].Payload.Candidates[].imageMediaCountinteger Yes
$.oneOf[0].allOf[1].Payload.Candidates[].mediaarray Yes
$.oneOf[0].allOf[1].Payload.Candidates[].media[]object No
$.oneOf[0].allOf[1].Payload.Candidates[].media[].idinteger Yes
$.oneOf[0].allOf[1].Payload.Candidates[].media[].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.Candidates[].media[].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.Candidates[].media[].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.Candidates[].media[].widthinteger Yes
$.oneOf[0].allOf[1].Payload.Candidates[].media[].heightinteger Yes
$.oneOf[0].allOf[1].Payload.Candidates[].media[].titlestring Yes
$.oneOf[0].allOf[1].Payload.Candidates[].media[].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.Candidates[].media[].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.Pageobject Yes
$.oneOf[0].allOf[1].Payload.Page.pageSizeinteger Yes
$.oneOf[0].allOf[1].Payload.Page.ownPostsOnlyinteger [0,1] Yes
$.oneOf[0].allOf[1].Payload.Page.requiresImageMediainteger [0,1] Yes
$.oneOf[0].allOf[1].Payload.Page.includeMediaLessOwnedPostsinteger [0,1] Yes
$.oneOf[0].allOf[1].Payload.Page.minimumImageMediaCountinteger Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_profile_about_post_candidates",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Candidates": [],
        "Page": {
            "pageSize": 0,
            "ownPostsOnly": 0,
            "requiresImageMedia": 0,
            "includeMediaLessOwnedPosts": 0,
            "minimumImageMediaCount": 0
        }
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_profile_about_post_profiles

#
Returns the public profiles currently using a community post as their profile/About Me post. Public-by-design: the newsfeed already exposes the aggregate profile-use count on public post cards. This endpoint only returns profiles the current viewer is allowed to open under the profile visibility settings.

Parameters

NameTypeRequiredDefaultDescription
postID int No 0 Public ATDiscussionPosts.ID shown in the newsfeed.
limit int No 50 Maximum profiles to return, capped at 100.
offset int No 0 Paging offset for the profile list.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_profile_about_post_profiles' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'postID={{postID}}' \
  --data-urlencode 'limit={{limit}}' \
  --data-urlencode 'offset={{offset}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_profile_about_post_profiles_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.PostIDinteger Yes
$.oneOf[0].allOf[1].Payload.TotalCountinteger Yes
$.oneOf[0].allOf[1].Payload.VisibleCountinteger Yes
$.oneOf[0].allOf[1].Payload.HiddenCountinteger Yes
$.oneOf[0].allOf[1].Payload.Profilesarray Yes
$.oneOf[0].allOf[1].Payload.Profiles[]object No
$.oneOf[0].allOf[1].Payload.Profiles[].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.Profiles[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.Profiles[].avatarstring Yes
$.oneOf[0].allOf[1].Payload.Profiles[].profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.Profiles[].importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.Pageobject Yes
$.oneOf[0].allOf[1].Payload.Page.limitinteger Yes
$.oneOf[0].allOf[1].Payload.Page.offsetinteger Yes
$.oneOf[0].allOf[1].Payload.Page.hasMoreboolean Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_profile_about_post_profiles",
    "RequestUserAlias": "example-user",
    "Payload": {
        "PostID": 0,
        "TotalCount": 0,
        "VisibleCount": 0,
        "HiddenCount": 0,
        "Profiles": [],
        "Page": {
            "limit": 0,
            "offset": 0,
            "hasMore": false
        }
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_profile_additional_metrics

#
Returns the expanded, non-hero metrics for a profile. Public-by-design: this mirrors the public profile metric rules unless the owner has set a visibility threshold. Sensitive metrics remain gated by the existing AccessSpecialFunctions checks inside LoadProfileContent.

Parameters

NameTypeRequiredDefaultDescription
userAlias string Yes — Public alias of the user to view.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_profile_additional_metrics' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_profile_additional_metrics_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.countinteger Yes
$.oneOf[0].allOf[1].Payload.metricsarray Yes
$.oneOf[0].allOf[1].Payload.metrics[]object No
$.oneOf[0].allOf[1].Payload.metrics[].keystring Yes
$.oneOf[0].allOf[1].Payload.metrics[].labelstring Yes
$.oneOf[0].allOf[1].Payload.metrics[].formattedValuestring Yes
$.oneOf[0].allOf[1].Payload.metrics[].value Yes
$.oneOf[0].allOf[1].Payload.metrics[].value.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.metrics[].value.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.metrics[].formatstring ["abbreviated-usd","abbreviated-number","decimal-percentage","short-percentage","usd","short-usd","short-number","raw"] Yes
$.oneOf[0].allOf[1].Payload.metrics[].tonestring ["neutral","negative","warning","positive"] Yes
$.oneOf[0].allOf[1].Payload.metrics[].iconURL Yes
$.oneOf[0].allOf[1].Payload.metrics[].iconURL.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.metrics[].iconURL.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.metrics[].infoboxTitle Yes
$.oneOf[0].allOf[1].Payload.metrics[].infoboxTitle.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.metrics[].infoboxTitle.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.metrics[].infoboxContent Yes
$.oneOf[0].allOf[1].Payload.metrics[].infoboxContent.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.metrics[].infoboxContent.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.metrics[].detail Yes
$.oneOf[0].allOf[1].Payload.metrics[].detail.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.metrics[].detail.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.metrics[].infoboxRowsarray Yes
$.oneOf[0].allOf[1].Payload.metrics[].infoboxRows[] No
$.oneOf[0].allOf[1].Payload.metrics[].infoboxRows[].anyOf[0]object No
$.oneOf[0].allOf[1].Payload.metrics[].infoboxRows[].anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.metrics[].infoboxRows[].anyOf[0].valuestring Yes
$.oneOf[0].allOf[1].Payload.metrics[].infoboxRows[].anyOf[1]object No
$.oneOf[0].allOf[1].Payload.metrics[].infoboxRows[].anyOf[1].type = "heading" Yes
$.oneOf[0].allOf[1].Payload.metrics[].infoboxRows[].anyOf[1].labelstring Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_profile_additional_metrics",
    "RequestUserAlias": "example-user",
    "Payload": {
        "count": 0,
        "metrics": []
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_profile_medal_tracks

#
Returns published medal progress for the authenticated account only. No target account parameter is accepted. Progress is calculated fresh.

Parameters

NameTypeRequiredDefaultDescription
includeHTML bool No false Include the localized web fragment alongside native data.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_profile_medal_tracks' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'includeHTML={{includeHTML}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_profile_medal_tracks_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.summaryobject Yes
$.oneOf[0].allOf[1].Payload.summary.publishedCountinteger Yes
$.oneOf[0].allOf[1].Payload.summary.earnedCountinteger Yes
$.oneOf[0].allOf[1].Payload.summary.inProgressCountinteger Yes
$.oneOf[0].allOf[1].Payload.summary.highestCountinteger Yes
$.oneOf[0].allOf[1].Payload.tracksarray Yes
$.oneOf[0].allOf[1].Payload.tracks[]object No
$.oneOf[0].allOf[1].Payload.tracks[].categoryobject Yes
$.oneOf[0].allOf[1].Payload.tracks[].category.idinteger Yes
$.oneOf[0].allOf[1].Payload.tracks[].category.namestring Yes
$.oneOf[0].allOf[1].Payload.tracks[].category.slugstring Yes
$.oneOf[0].allOf[1].Payload.tracks[].category.descriptionstring Yes
$.oneOf[0].allOf[1].Payload.tracks[].category.iconURLstring Yes
$.oneOf[0].allOf[1].Payload.tracks[].category.colorstring Yes
$.oneOf[0].allOf[1].Payload.tracks[].category.textColorstring Yes
$.oneOf[0].allOf[1].Payload.tracks[].category.isNegativeboolean Yes
$.oneOf[0].allOf[1].Payload.tracks[].currentTier Yes
$.oneOf[0].allOf[1].Payload.tracks[].currentTier.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.tracks[].currentTier.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.tracks[].currentTier.anyOf[0].namestring Yes
$.oneOf[0].allOf[1].Payload.tracks[].currentTier.anyOf[0].slugstring Yes
$.oneOf[0].allOf[1].Payload.tracks[].currentTier.anyOf[0].iconURLstring Yes
$.oneOf[0].allOf[1].Payload.tracks[].currentTier.anyOf[0].colorstring Yes
$.oneOf[0].allOf[1].Payload.tracks[].currentTier.anyOf[0].textColorstring Yes
$.oneOf[0].allOf[1].Payload.tracks[].currentTier.anyOf[0].importanceinteger Yes
$.oneOf[0].allOf[1].Payload.tracks[].currentTier.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.tracks[].targetTier Yes
$.oneOf[0].allOf[1].Payload.tracks[].targetTier.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.tracks[].targetTier.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.tracks[].targetTier.anyOf[0].namestring Yes
$.oneOf[0].allOf[1].Payload.tracks[].targetTier.anyOf[0].slugstring Yes
$.oneOf[0].allOf[1].Payload.tracks[].targetTier.anyOf[0].iconURLstring Yes
$.oneOf[0].allOf[1].Payload.tracks[].targetTier.anyOf[0].colorstring Yes
$.oneOf[0].allOf[1].Payload.tracks[].targetTier.anyOf[0].textColorstring Yes
$.oneOf[0].allOf[1].Payload.tracks[].targetTier.anyOf[0].importanceinteger Yes
$.oneOf[0].allOf[1].Payload.tracks[].targetTier.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.tracks[].statusKeystring ["not_started","in_progress","highest"] Yes
$.oneOf[0].allOf[1].Payload.tracks[].progressPercentinteger Yes
$.oneOf[0].allOf[1].Payload.tracks[].tierCountinteger Yes
$.oneOf[0].allOf[1].Payload.tracks[].overviewURLstring Yes
$.oneOf[0].allOf[1].Payload.htmlstring No
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_profile_medal_tracks",
    "RequestUserAlias": "example-user",
    "Payload": {
        "summary": {
            "publishedCount": 0,
            "earnedCount": 0,
            "inProgressCount": 0,
            "highestCount": 0
        },
        "tracks": []
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_profile_sales_history

#
Returns v2 profile sales history scoped for the acting viewer. AccessSpecialFunctions users see all buyer/seller trades for the target user. Normal users see only trades where they were the counterparty, or all of their own trades when inspecting their own profile.

Parameters

NameTypeRequiredDefaultDescription
userAlias string Yes — Alias of the profile user to inspect.
pageSize int No 50 Maximum rows to return.
pageNumber int No 0 Zero-based page number.
peerUserAlias string No "" Optional counterparty filter; only allowed on the acting user's own profile, including for administrators.
refundSalesOnly bool No false Staff refund picker: completed sales by the profile concierge only. Requires RefundAppointments; cannot combine with a peer filter.
refundPurchasesOnly bool No false Deprecated compatibility alias for refundSalesOnly. Always returns completed sales, never purchases.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_profile_sales_history' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}' \
  --data-urlencode 'peerUserAlias={{peerUserAlias}}' \
  --data-urlencode 'refundSalesOnly={{refundSalesOnly}}' \
  --data-urlencode 'refundPurchasesOnly={{refundPurchasesOnly}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_profile_sales_history_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.targetUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.targetAliasstring Yes
$.oneOf[0].allOf[1].Payload.targetProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.peerAliasstring Yes
$.oneOf[0].allOf[1].Payload.scopeLabelstring Yes
$.oneOf[0].allOf[1].Payload.peerUserID Yes
$.oneOf[0].allOf[1].Payload.peerUserID.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.peerUserID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.scopestring ["all","shared"] Yes
$.oneOf[0].allOf[1].Payload.summaryobject Yes
$.oneOf[0].allOf[1].Payload.summary.totalCountinteger Yes
$.oneOf[0].allOf[1].Payload.summary.sellerCountinteger Yes
$.oneOf[0].allOf[1].Payload.summary.buyerCountinteger Yes
$.oneOf[0].allOf[1].Payload.summary.totalAmountCentsinteger Yes
$.oneOf[0].allOf[1].Payload.summary.totalAmountFormattedstring Yes
$.oneOf[0].allOf[1].Payload.summary.rangeLabelstring Yes
$.oneOf[0].allOf[1].Payload.pageobject Yes
$.oneOf[0].allOf[1].Payload.page.pageSizeinteger Yes
$.oneOf[0].allOf[1].Payload.page.pageNumberinteger Yes
$.oneOf[0].allOf[1].Payload.page.hasMoreboolean Yes
$.oneOf[0].allOf[1].Payload.rowsarray Yes
$.oneOf[0].allOf[1].Payload.rows[]object No
$.oneOf[0].allOf[1].Payload.rows[].transactionIDinteger Yes
$.oneOf[0].allOf[1].Payload.rows[].appointmentIDinteger Yes
$.oneOf[0].allOf[1].Payload.rows[].bidIDinteger Yes
$.oneOf[0].allOf[1].Payload.rows[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.rows[].amountCentsinteger Yes
$.oneOf[0].allOf[1].Payload.rows[].counterpartyUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.rows[].buyerUserIDinteger | null Yes
$.oneOf[0].allOf[1].Payload.rows[].sellerUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.rows[].targetRolestring ["seller","buyer"] Yes
$.oneOf[0].allOf[1].Payload.rows[].targetRoleLabelstring Yes
$.oneOf[0].allOf[1].Payload.rows[].typeLabelstring Yes
$.oneOf[0].allOf[1].Payload.rows[].statusLabelstring Yes
$.oneOf[0].allOf[1].Payload.rows[].amountFormattedstring Yes
$.oneOf[0].allOf[1].Payload.rows[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.rows[].completedDatestring Yes
$.oneOf[0].allOf[1].Payload.rows[].activityDatestring Yes
$.oneOf[0].allOf[1].Payload.rows[].activityDateFormattedstring Yes
$.oneOf[0].allOf[1].Payload.rows[].counterpartyAliasstring Yes
$.oneOf[0].allOf[1].Payload.rows[].counterpartyProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.rows[].buyerAliasstring | null Yes
$.oneOf[0].allOf[1].Payload.rows[].sellerAliasstring Yes
$.oneOf[0].allOf[1].Payload.rows[].locationNamestring Yes
$.oneOf[0].allOf[1].Payload.rows[].locationAliasstring Yes
$.oneOf[0].allOf[1].Payload.rows[].locationURLstring Yes
$.oneOf[0].allOf[1].Payload.rows[].locationCategoryNamestring Yes
$.oneOf[0].allOf[1].Payload.rows[].inventoryTypeNamestring Yes
$.oneOf[0].allOf[1].Payload.rows[].cityGroupCodestring Yes
$.oneOf[0].allOf[1].Payload.rows[].listingUUIDstring Yes
$.oneOf[0].allOf[1].Payload.rows[].appointmentTimestring Yes
$.oneOf[0].allOf[1].Payload.rows[].historyURLstring Yes
$.oneOf[0].allOf[1].Payload.rows[].statusstring ["PENDING","COMPLETED","CANCELLED","EXPIRED"] Yes
$.oneOf[0].allOf[1].Payload.rows[].statusTonestring ["warning","positive","neutral","negative"] Yes
$.oneOf[0].allOf[1].Payload.rows[].refundCaseStatestring ["unavailable","open","reopen","new"] No
$.oneOf[0].allOf[1].Payload.rows[].buyerIdentityHiddenboolean NoTrue when the authenticated viewer cannot see the buyer during the current response race.
$.oneOf[0].allOf[1].Payload.rows[].buyerIdentityHiddenUntilinteger | null NoSaved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_profile_sales_history",
    "RequestUserAlias": "example-user",
    "Payload": {
        "targetUserID": 0,
        "targetAlias": "synthetic-example",
        "targetProfileURL": "synthetic-example",
        "peerAlias": "synthetic-example",
        "scopeLabel": "synthetic-example",
        "peerUserID": 0,
        "scope": "all",
        "summary": {
            "totalCount": 0,
            "sellerCount": 0,
            "buyerCount": 0,
            "totalAmountCents": 0,
            "totalAmountFormatted": "synthetic-example",
            "rangeLabel": "synthetic-example"
        },
        "page": {
            "pageSize": 0,
            "pageNumber": 0,
            "hasMore": false
        },
        "rows": []
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_profile_setup

#
Returns the acting user's reusable v2 profile setup onboarding payload.

Parameters

NameTypeRequiredDefaultDescription
includeRenderedFragments bool No false Include server-rendered fragments needed by lazy UI embeds.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_profile_setup' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'includeRenderedFragments={{includeRenderedFragments}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_profile_setup_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].PayloadProfileSetup YesCurrent setup state. get_profile_setup reads without marking completion; the setup embedded in successful writes can synchronize stored completion.
$.oneOf[0].allOf[1].Payload.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].isLoggedIn = true Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].hasDisplayableOpenItemsboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].requiresOnboardingboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].collapsedByDefaultboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].profileIntentstring ["","buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].intentOptionsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].intentOptions[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].intentOptions[].valuestring ["buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].intentOptions[].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].intentOptions[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].intentOptions[].spritestring ["buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].intentOptions[].flowIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].intentOptions[].usesFlowCopy = true Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].citySlugstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].regionstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].countrystring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].cityGroupCodestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].iconstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].imageBasePathstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].sourcestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].isSavedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].isRecommendedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].distanceMetersinteger No
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebaseSuggestionsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebaseSuggestions[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].homebaseSuggestions[].citySlugstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebaseSuggestions[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebaseSuggestions[].regionstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebaseSuggestions[].countrystring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebaseSuggestions[].cityGroupCodestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebaseSuggestions[].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebaseSuggestions[].iconstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebaseSuggestions[].imageBasePathstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebaseSuggestions[].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebaseSuggestions[].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebaseSuggestions[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebaseSuggestions[].sourcestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebaseSuggestions[].isSavedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebaseSuggestions[].isRecommendedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebaseSuggestions[].distanceMetersinteger No
$.oneOf[0].allOf[1].Payload.anyOf[0].followCountsobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].followCounts.userFollowCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].followCounts.boardFollowCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestionsobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.usersarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].avatarstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].profileIntentstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].recommendationTypestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].communityVerificationStatusstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].followerCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].publicPostCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].isViewerFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].isProfileSetupFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].hasAboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].profileImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].profileImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].profileImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].profileImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].bannerImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].bannerImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].bannerImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.users[].bannerImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boardsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[].namestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[].urlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[].boardIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[].followerCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[].recentPostCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[].isViewerFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[].isProfileSetupFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[].hasAboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[].profileImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[].profileImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[].profileImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[].profileImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[].bannerImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[].bannerImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[].bannerImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boards[].bannerImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.locationsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.locations[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.locations[].namestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.locations[].locationAliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.locations[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.locations[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.locations[].stateShortstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.locations[].countryShortstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.locations[].categoryDescriptorstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.locations[].categoryIconstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.locations[].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.locations[].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.locations[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.locations[].localRankinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.locations[].rankinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.locations[].userTradesinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.locations[].bidsLast30Dayinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.locations[].isViewerFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].homebaseCitySlugstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].renderTypestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].stepKeystring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].hasParametersboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].includeUsersboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].includeBoardsboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].includeLocationsboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].isTrendingboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].profileIntentstring ["","buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].completionobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].completion.requiredCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].completion.presentedCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].completion.presentedUserCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].completion.presentedBoardCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].completion.presentedLocationCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].completion.followedCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].completion.followedUserCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].completion.followedBoardCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].completion.followedLocationCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].completion.isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].isWaitingForMinimumContextboolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].missingContextKeysarray No
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[0].missingContextKeys[]string ["profileIntent","homebase"] No
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.anyOf[1].isConfigured = false Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenuesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenues[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenues[].namestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenues[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenues[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenues[].partnerAccountNamestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenues[].rolestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenues[].sourcestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenues[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenues[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenues[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenues[].partnerAccountID Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenues[].partnerAccountID.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenues[].partnerAccountID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaimsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].namestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].statusstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].chatURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].requestIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].chatIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].applicationStatusstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].applicationChatIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].applicationChatURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].applicationUnreadCount Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].sidebarStatus Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[0]string ["answer-required","pending"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].hasManagedVenuePathboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].schemaobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].schema.readyboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].schema.missingTablesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].schema.missingTables[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].managedVenuesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].managedVenues[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].managedVenues[].namestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].managedVenues[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].managedVenues[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountNamestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].managedVenues[].rolestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].managedVenues[].sourcestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].managedVenues[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].managedVenues[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].managedVenues[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountID Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountID.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaimsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].namestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].statusstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].chatURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].requestIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].chatIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationStatusstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationChatIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationChatURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationUnreadCount Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].sidebarStatus Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[0]string ["answer-required","pending"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].hasManagedVenuePathboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[0].managedVenuesURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPostobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.postIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.hasAboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].bodyPreviewstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].urlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].authorAboutPostAuthor Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].aliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].idnull Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].aliasnull Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].avatarEmojinull Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].profileUrlnull Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].identityHidden = true Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].identityHiddenUntilinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].boardobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].board.idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].board.namestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].board.slugstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].board.typestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].imageMediaCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].mediaarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].media[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].media[].idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].media[].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].media[].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].media[].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].media[].widthinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].media[].heightinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].media[].titlestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].media[].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[0].media[].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.post.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoardIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoard Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoard.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoard.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoard.anyOf[0].boardIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoard.anyOf[0].countinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoard.anyOf[0].slugstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoard.anyOf[0].namestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoard.anyOf[0].citystring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoard.anyOf[0].cityGroupCodestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoard.anyOf[0].intentstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoard.anyOf[0].callbackstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoard.anyOf[0].unitLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoard.anyOf[0].routingDescriptionstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoard.anyOf[0].createsRegularBoardPostboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoard.anyOf[0].isDefaultRequestBoardboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoard.anyOf[0].isDefaultListingBoardboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoard.anyOf[0].routingEnabledboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoard.anyOf[0].selectedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoard.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircleobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.statusstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.positiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.netPositiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.requiredNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.remainingNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verifierCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.hasTrustSignalboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].userobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].user.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].user.aliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].user.avatarstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].user.profileURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].user.communityVerificationStatusstring ["Unverified","Verified"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].user.communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].user.communityVerificationCountFormattedstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].user.firstNamestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].user.lastNamestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].user.professionstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].user.privacySettingstring ["do_not_publicly_share","share_name","share_profession","share_name_and_profession"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verificationobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verification.sharePathstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verification.shareURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verification.requiredNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verification.remainingNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verification.positiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verification.negativeVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verification.netPositiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verification.verifierCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].privacyOptionsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].privacyOptions[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].privacyOptions[].valuestring ["do_not_publicly_share","share_name","share_profession","share_name_and_profession"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].privacyOptions[].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verifiersarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verifiers[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verificationIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].createdDateFormattedstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].messagestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].isPositiveVerificationboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifierobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.aliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.avatarstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.profileURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.communityVerificationStatusstring ["","Unverified","Verified"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.communityVerificationCountFormattedstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.importancePointsFormattedstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verification.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].completionobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].completion.intentboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].completion.homebaseboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].completion.interestsboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].completion.managedVenueboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].completion.aboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].completion.innerCircleboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flowobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.flowIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.sourcestring ["intent-only","active","fallback","status"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.intentTypestring ["","buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.namestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.descriptionstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actionsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].renderTypestring ["intent_picker","homebase_picker","follow_recommendations","about_me_post","managed_venue_claim","verification_invites"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].orderinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].displayOrderinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].headlinestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parametersOnboardingParameters YesDecoded ActionParametersJSON. Empty or invalid configuration is serialized as []; objects and JSON lists are preserved.
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].intentSourcestring No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].Homebasestring No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].homebasestring No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].homebaseSourcestring No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAsarray No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtasarray No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctasarray No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[0]null No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[1]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[2]number No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[4]array No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[5]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parametersJSONstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].completeboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].completeForProgressboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].visibleboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].lockedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].hasDisplayConditionboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].displayConditionSatisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].hasGateboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventSatisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].displayConditionCallbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].displayConditionStatusobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].displayConditionStatus.callbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].displayConditionStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].displayConditionStatus.deferredUntilGateSatisfiedboolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].displayConditionStatus.reasonstring ["missing_user","unknown_callback"] No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].displayConditionStatus.activePendingBidCountinteger No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventNames[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventMatchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventHeadlinestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventDescriptionstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventCTAsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventCTAs[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventCTAs[].stylestring ["primary","secondary"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventCTAs[].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventCTAs[].javascriptstring YesConfigured client action code. Documentation treats this as text and never executes it.
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatusobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.eventNamesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.eventNames[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.matchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.eventCounts Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.eventCounts.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.eventCounts.anyOf[0].*integer No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.eventCounts.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.matchedEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.matchedEventNames[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].adminNotesstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.stepKeysarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.stepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.visibleStepKeysarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.visibleStepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].targetActionobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].targetAction.actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].targetAction.stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].headlinestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].ctasarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].ctas[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].ctas[].stylestring ["primary","secondary"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].ctas[].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].ctas[].javascriptstring YesConfigured client action code. Documentation treats this as text and never executes it.
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventNames[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventMatchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatusobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventNamesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventNames[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.matchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts.anyOf[0].*integer No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.matchedEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.matchedEventNames[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGatesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].targetActionobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].targetAction.actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].targetAction.stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].headlinestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].ctasarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].ctas[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].ctas[].stylestring ["primary","secondary"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].ctas[].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].ctas[].javascriptstring YesConfigured client action code. Documentation treats this as text and never executes it.
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventNames[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventMatchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatusobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventNamesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventNames[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.matchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts.anyOf[0].*integer No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.matchedEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.matchedEventNames[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].acknowledgeAfterStepKeysarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].acknowledgeAfterStepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventSatisfied = true Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionCallbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatusobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.callbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.deferredUntilGateSatisfiedboolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.reasonstring ["missing_user","unknown_callback"] No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.activePendingBidCountinteger No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.hasDisplayableOpenItemsboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.progressobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.progress.completedinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.progress.totalinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.progress.isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpointsobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpoints.refreshstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpoints.setIntentstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpoints.cityOptionsstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpoints.setHomebasestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpoints.setFollowsstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpoints.partnerLocationOptionsstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpoints.partnerSetClaimstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpoints.managedVenuesstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpoints.verificationCenterstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].renderedFragments No
$.oneOf[0].allOf[1].Payload.anyOf[0].renderedFragments.anyOf[0]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].renderedFragments.anyOf[0].verificationCenterstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].renderedFragments.anyOf[1]array No
$.oneOf[0].allOf[1].Payload.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].isLoggedIn = false Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_profile_setup",
    "RequestUserAlias": "example-user",
    "Payload": {
        "isLoggedIn": true,
        "isComplete": false,
        "hasDisplayableOpenItems": false,
        "requiresOnboarding": false,
        "collapsedByDefault": false,
        "profileIntent": "",
        "intentOptions": [],
        "homebase": {
            "citySlug": "synthetic-example",
            "cityName": "synthetic-example",
            "region": "synthetic-example",
            "country": "synthetic-example",
            "cityGroupCode": "synthetic-example",
            "label": "synthetic-example",
            "icon": "synthetic-example",
            "imageBasePath": "synthetic-example",
            "imageURL256": "synthetic-example",
            "imageURL512": "synthetic-example",
            "bannerImageURL": "synthetic-example",
            "source": "synthetic-example",
            "isSaved": false,
            "isRecommended": false
        },
        "homebaseSuggestions": [],
        "followCounts": {
            "userFollowCount": 0,
            "boardFollowCount": 0
        },
        "suggestions": {
            "users": [],
            "boards": [],
            "locations": [],
            "context": {
                "homebaseCitySlug": "synthetic-example",
                "renderType": "synthetic-example",
                "stepKey": "synthetic-example",
                "hasParameters": false,
                "includeUsers": false,
                "includeBoards": false,
                "includeLocations": false,
                "isTrending": false,
                "profileIntent": "",
                "completion": {
                    "requiredCount": 0,
                    "presentedCount": 0,
                    "presentedUserCount": 0,
                    "presentedBoardCount": 0,
                    "presentedLocationCount": 0,
                    "followedCount": 0,
                    "followedUserCount": 0,
                    "followedBoardCount": 0,
                    "followedLocationCount": 0,
                    "isComplete": false
                }
            }
        },
        "managedVenues": [],
        "pendingVenueClaims": [],
        "hasManagedVenuePath": false,
        "managedVenueState": {
            "schema": {
                "ready": false,
                "missingTables": []
            },
            "managedVenues": [],
            "pendingVenueClaims": [],
            "hasManagedVenuePath": false,
            "managedVenuesURL": "synthetic-example"
        },
        "aboutPost": {
            "postID": 0,
            "hasAboutPost": false,
            "post": {
                "id": 0,
                "title": "synthetic-example",
                "bodyPreview": "synthetic-example",
                "url": "synthetic-example",
                "createdDate": "synthetic-example",
                "author": {
                    "id": 0,
                    "alias": "synthetic-example",
                    "avatarEmoji": "synthetic-example",
                    "profileUrl": "synthetic-example"
                },
                "board": {
                    "id": 0,
                    "name": "synthetic-example",
                    "slug": "synthetic-example",
                    "type": "synthetic-example"
                },
                "imageMediaCount": 0,
                "media": []
            },
            "wallBoardID": 0,
            "wallBoard": {
                "id": 0,
                "boardID": 0,
                "count": 0,
                "slug": "synthetic-example",
                "name": "synthetic-example",
                "city": "synthetic-example",
                "cityGroupCode": "synthetic-example",
                "intent": "synthetic-example",
                "callback": "synthetic-example",
                "unitLabel": "synthetic-example",
                "routingDescription": "synthetic-example",
                "createsRegularBoardPost": false,
                "isDefaultRequestBoard": false,
                "isDefaultListingBoard": false,
                "routingEnabled": false,
                "selected": false
            }
        },
        "innerCircle": {
            "status": "synthetic-example",
            "positiveVerificationCount": 0,
            "netPositiveVerificationCount": 0,
            "requiredNetPositiveVerifications": 0,
            "remainingNetPositiveVerifications": 0,
            "verifierCount": 0,
            "hasTrustSignal": false,
            "verification": {
                "user": {
                    "userID": 0,
                    "alias": "synthetic-example",
                    "avatar": "synthetic-example",
                    "profileURL": "synthetic-example",
                    "communityVerificationStatus": "Unverified",
                    "communityVerificationCount": 0,
                    "communityVerificationCountFormatted": "synthetic-example",
                    "firstName": "synthetic-example",
                    "lastName": "synthetic-example",
                    "profession": "synthetic-example",
                    "privacySetting": "do_not_publicly_share"
                },
                "verification": {
                    "sharePath": "synthetic-example",
                    "shareURL": "synthetic-example",
                    "requiredNetPositiveVerifications": 0,
                    "remainingNetPositiveVerifications": 0,
                    "positiveVerificationCount": 0,
                    "negativeVerificationCount": 0,
                    "netPositiveVerificationCount": 0,
                    "verifierCount": 0
                },
                "privacyOptions": [],
                "verifiers": []
            }
        },
        "completion": {
            "intent": false,
            "homebase": false,
            "interests": false,
            "managedVenue": false,
            "aboutPost": false,
            "innerCircle": false
        },
        "flow": {
            "flowID": 0,
            "source": "intent-only",
            "intentType": "",
            "name": "synthetic-example",
            "description": "synthetic-example",
            "actions": [],
            "stepKeys": [],
            "visibleStepKeys": [],
            "currentGate": {
                "actionKey": "SELECT_INTENT",
                "stepKey": "intent",
                "targetAction": {
                    "actionKey": "SELECT_INTENT",
                    "stepKey": "intent"
                },
                "headline": "synthetic-example",
                "description": "synthetic-example",
                "ctas": [],
                "requiredEventNames": [],
                "requiredEventMatchMode": "Any",
                "requiredEventStatus": {
                    "satisfied": false,
                    "eventNames": [],
                    "matchMode": "Any",
                    "eventCounts": [],
                    "matchedEventNames": []
                }
            },
            "acknowledgementGates": [],
            "displayConditionSuppressedAction": {
                "actionKey": "SELECT_INTENT",
                "stepKey": "intent",
                "displayConditionCallback": "",
                "displayConditionStatus": {
                    "callback": "",
                    "satisfied": false
                }
            },
            "hasDisplayableOpenItems": false,
            "progress": {
                "completed": 0,
                "total": 0,
                "isComplete": false
            },
            "isComplete": false
        },
        "endpoints": {
            "refresh": "synthetic-example",
            "setIntent": "synthetic-example",
            "cityOptions": "synthetic-example",
            "setHomebase": "synthetic-example",
            "setFollows": "synthetic-example",
            "partnerLocationOptions": "synthetic-example",
            "partnerSetClaim": "synthetic-example",
            "managedVenues": "synthetic-example",
            "verificationCenter": "synthetic-example"
        }
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_profile_setup_city_options

#
Searches city homebase options for the reusable profile setup insert.

Parameters

NameTypeRequiredDefaultDescription
q string No "" City search text.
pageSize int No 10 Maximum options to return.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_profile_setup_city_options' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'q={{q}}' \
  --data-urlencode 'pageSize={{pageSize}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_profile_setup_city_options_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.optionsarray Yes
$.oneOf[0].allOf[1].Payload.options[]object No
$.oneOf[0].allOf[1].Payload.options[].citySlugstring Yes
$.oneOf[0].allOf[1].Payload.options[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.options[].regionstring Yes
$.oneOf[0].allOf[1].Payload.options[].countrystring Yes
$.oneOf[0].allOf[1].Payload.options[].cityGroupCodestring Yes
$.oneOf[0].allOf[1].Payload.options[].labelstring Yes
$.oneOf[0].allOf[1].Payload.options[].iconstring Yes
$.oneOf[0].allOf[1].Payload.options[].imageBasePathstring Yes
$.oneOf[0].allOf[1].Payload.options[].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.options[].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.options[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.options[].sourcestring Yes
$.oneOf[0].allOf[1].Payload.options[].isSavedboolean Yes
$.oneOf[0].allOf[1].Payload.options[].isRecommendedboolean Yes
$.oneOf[0].allOf[1].Payload.options[].distanceMetersinteger No
$.oneOf[0].allOf[1].Payload.querystring Yes
$.oneOf[0].allOf[1].Payload.pageSizeinteger Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_profile_setup_city_options",
    "RequestUserAlias": "example-user",
    "Payload": {
        "options": [],
        "query": "synthetic-example",
        "pageSize": 1
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_profile_setup_status

#
Returns the acting user's lightweight v2 profile setup status. This intentionally skips display context such as suggested users, communities, venues, verifier lists, and venue detail cards.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_profile_setup_status' \
  --data-urlencode 'key={{API_KEY}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_profile_setup_status_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].PayloadProfileSetupStatus Yes
$.oneOf[0].allOf[1].Payload.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].isLoggedIn = true Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].hasDisplayableOpenItemsboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].requiresOnboardingboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].collapsedByDefaultboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].profileIntentstring ["","buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].intentOptionsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].intentOptions[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].intentOptions[].valuestring ["buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].intentOptions[].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].intentOptions[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].intentOptions[].spritestring ["buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].intentOptions[].flowIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].intentOptions[].usesFlowCopy = true Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].citySlugstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].regionstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].countrystring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].sourcestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[0].isSavedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebase.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebaseSuggestionsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].followCountsobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].followCounts.userFollowCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].followCounts.boardFollowCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestionsobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.usersarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.boardsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.locationsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.contextobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.isWaitingForHydration = true Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.isWaitingForMinimumContextboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.missingContextKeysarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.missingContextKeys[]string ["profileIntent","homebase"] No
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.completionobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.completion.requiredCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.completion.presentedCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.completion.followedCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].suggestions.context.completion.isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenuesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingVenueClaimsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].hasManagedVenuePathboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueStateobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.managedVenuesURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].managedVenueState.hasManagedVenuePathboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPostobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.postID = 0 Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.hasAboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.postnull Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoardID = 0 Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].aboutPost.wallBoardnull Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircleobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.statusstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.positiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.netPositiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.requiredNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.remainingNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verifierCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.hasTrustSignalboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].innerCircle.verificationarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].completionobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].completion.intentboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].completion.homebaseboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].completion.interestsboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].completion.managedVenueboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].completion.aboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].completion.innerCircleboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flowobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.flowIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.sourcestring ["intent-only","active","fallback","status"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.intentTypestring ["","buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.namestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.descriptionstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actionsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].renderTypestring ["intent_picker","homebase_picker","follow_recommendations","about_me_post","managed_venue_claim","verification_invites"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].orderinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].displayOrderinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].headlinestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parametersOnboardingParameters YesDecoded ActionParametersJSON. Empty or invalid configuration is serialized as []; objects and JSON lists are preserved.
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].intentSourcestring No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].Homebasestring No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].homebasestring No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].homebaseSourcestring No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAsarray No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtasarray No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctasarray No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[0]null No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[1]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[2]number No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[4]array No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[5]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].parametersJSONstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].completeboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].completeForProgressboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].visibleboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].lockedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].hasDisplayConditionboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].displayConditionSatisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].hasGateboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventSatisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].displayConditionCallbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].displayConditionStatusobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].displayConditionStatus.callbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].displayConditionStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].displayConditionStatus.deferredUntilGateSatisfiedboolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].displayConditionStatus.reasonstring ["missing_user","unknown_callback"] No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].displayConditionStatus.activePendingBidCountinteger No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventNames[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventMatchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventHeadlinestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventDescriptionstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventCTAsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventCTAs[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventCTAs[].stylestring ["primary","secondary"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventCTAs[].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventCTAs[].javascriptstring YesConfigured client action code. Documentation treats this as text and never executes it.
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatusobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.eventNamesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.eventNames[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.matchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.eventCounts Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.eventCounts.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.eventCounts.anyOf[0].*integer No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.eventCounts.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.matchedEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].requiredEventStatus.matchedEventNames[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.actions[].adminNotesstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.stepKeysarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.stepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.visibleStepKeysarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.visibleStepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].targetActionobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].targetAction.actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].targetAction.stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].headlinestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].ctasarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].ctas[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].ctas[].stylestring ["primary","secondary"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].ctas[].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].ctas[].javascriptstring YesConfigured client action code. Documentation treats this as text and never executes it.
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventNames[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventMatchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatusobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventNamesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventNames[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.matchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts.anyOf[0].*integer No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.matchedEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.matchedEventNames[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.currentGate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGatesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].targetActionobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].targetAction.actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].targetAction.stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].headlinestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].ctasarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].ctas[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].ctas[].stylestring ["primary","secondary"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].ctas[].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].ctas[].javascriptstring YesConfigured client action code. Documentation treats this as text and never executes it.
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventNames[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventMatchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatusobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventNamesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventNames[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.matchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts.anyOf[0].*integer No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.matchedEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.matchedEventNames[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].acknowledgeAfterStepKeysarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].acknowledgeAfterStepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.acknowledgementGates[].requiredEventSatisfied = true Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionCallbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatusobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.callbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.deferredUntilGateSatisfiedboolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.reasonstring ["missing_user","unknown_callback"] No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.activePendingBidCountinteger No
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.displayConditionSuppressedAction.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.hasDisplayableOpenItemsboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.progressobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.progress.completedinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.progress.totalinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.progress.isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].flow.isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpointsobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpoints.refreshstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpoints.setIntentstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpoints.cityOptionsstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpoints.setHomebasestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpoints.setFollowsstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpoints.partnerLocationOptionsstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpoints.partnerSetClaimstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpoints.managedVenuesstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpoints.verificationCenterstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].endpoints.statusstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].renderedFragments Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].renderedFragments.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].renderedFragments.anyOf[0].verificationCenterstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].renderedFragments.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].hasOpenItemsboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].minimumStateobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].minimumState.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].minimumState.profileIntentstring ["","buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].minimumState.homebaseCitySlugstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].minimumState.hasProfileIntentboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].minimumState.hasHomebaseboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].minimumState.isMinimumReadyboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].minimumState.missingKeysarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].minimumState.missingKeys[]string ["profileIntent","homebase"] No
$.oneOf[0].allOf[1].Payload.anyOf[0].stepKeysarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].stepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.anyOf[0].openStepKeysarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].openStepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.anyOf[0].currentStepKeystring ["","intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].homebaseCitySlugstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].followedLocationCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].verificationStatusstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].verificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].requiredVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].remainingVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].requiresOnboardingStoredboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].isLoggedIn = false Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_profile_setup_status",
    "RequestUserAlias": "example-user",
    "Payload": {
        "isLoggedIn": true,
        "isComplete": false,
        "hasDisplayableOpenItems": false,
        "requiresOnboarding": false,
        "collapsedByDefault": false,
        "profileIntent": "",
        "intentOptions": [],
        "homebase": {
            "citySlug": "synthetic-example",
            "label": "synthetic-example",
            "cityName": "synthetic-example",
            "region": "synthetic-example",
            "country": "synthetic-example",
            "source": "synthetic-example",
            "isSaved": false
        },
        "homebaseSuggestions": [],
        "followCounts": {
            "userFollowCount": 0,
            "boardFollowCount": 0
        },
        "suggestions": {
            "users": [],
            "boards": [],
            "locations": [],
            "context": {
                "isWaitingForHydration": true,
                "isWaitingForMinimumContext": false,
                "missingContextKeys": [],
                "completion": {
                    "requiredCount": 0,
                    "presentedCount": 0,
                    "followedCount": 0,
                    "isComplete": false
                }
            }
        },
        "managedVenues": [],
        "pendingVenueClaims": [],
        "hasManagedVenuePath": false,
        "managedVenueState": {
            "managedVenuesURL": "synthetic-example",
            "hasManagedVenuePath": false
        },
        "aboutPost": {
            "postID": 0,
            "hasAboutPost": false,
            "post": null,
            "wallBoardID": 0,
            "wallBoard": null
        },
        "innerCircle": {
            "status": "synthetic-example",
            "positiveVerificationCount": 0,
            "netPositiveVerificationCount": 0,
            "requiredNetPositiveVerifications": 0,
            "remainingNetPositiveVerifications": 0,
            "verifierCount": 0,
            "hasTrustSignal": false,
            "verification": []
        },
        "completion": {
            "intent": false,
            "homebase": false,
            "interests": false,
            "managedVenue": false,
            "aboutPost": false,
            "innerCircle": false
        },
        "flow": {
            "flowID": 0,
            "source": "intent-only",
            "intentType": "",
            "name": "synthetic-example",
            "description": "synthetic-example",
            "actions": [],
            "stepKeys": [],
            "visibleStepKeys": [],
            "currentGate": {
                "actionKey": "SELECT_INTENT",
                "stepKey": "intent",
                "targetAction": {
                    "actionKey": "SELECT_INTENT",
                    "stepKey": "intent"
                },
                "headline": "synthetic-example",
                "description": "synthetic-example",
                "ctas": [],
                "requiredEventNames": [],
                "requiredEventMatchMode": "Any",
                "requiredEventStatus": {
                    "satisfied": false,
                    "eventNames": [],
                    "matchMode": "Any",
                    "eventCounts": [],
                    "matchedEventNames": []
                }
            },
            "acknowledgementGates": [],
            "displayConditionSuppressedAction": {
                "actionKey": "SELECT_INTENT",
                "stepKey": "intent",
                "displayConditionCallback": "",
                "displayConditionStatus": {
                    "callback": "",
                    "satisfied": false
                }
            },
            "hasDisplayableOpenItems": false,
            "progress": {
                "completed": 0,
                "total": 0,
                "isComplete": false
            },
            "isComplete": false
        },
        "endpoints": {
            "refresh": "synthetic-example",
            "setIntent": "synthetic-example",
            "cityOptions": "synthetic-example",
            "setHomebase": "synthetic-example",
            "setFollows": "synthetic-example",
            "partnerLocationOptions": "synthetic-example",
            "partnerSetClaim": "synthetic-example",
            "managedVenues": "synthetic-example",
            "verificationCenter": "synthetic-example",
            "status": "synthetic-example"
        },
        "renderedFragments": {
            "verificationCenter": "synthetic-example"
        },
        "userID": 0,
        "hasOpenItems": false,
        "minimumState": {
            "userID": 0,
            "profileIntent": "",
            "homebaseCitySlug": "synthetic-example",
            "hasProfileIntent": false,
            "hasHomebase": false,
            "isMinimumReady": false,
            "missingKeys": []
        },
        "stepKeys": [],
        "openStepKeys": [],
        "currentStepKey": "",
        "homebaseCitySlug": "synthetic-example",
        "followedLocationCount": 0,
        "verificationStatus": "synthetic-example",
        "verificationCount": 0,
        "requiredVerificationCount": 0,
        "remainingVerificationCount": 0,
        "requiresOnboardingStored": false
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_profile_visibility_preview

#
Previews which public medal/usergroup tiers can see a profile at a given importance-points threshold, including the highest-ranked verified users by total importance points.

Parameters

NameTypeRequiredDefaultDescription
profileVisibleImportancePointsThreshold int No 0 Minimum total importance points required.
limitPerGroup int No 20 Maximum ranked verified users returned.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_profile_visibility_preview' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'profileVisibleImportancePointsThreshold={{profileVisibleImportancePointsThreshold}}' \
  --data-urlencode 'limitPerGroup={{limitPerGroup}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_profile_visibility_preview_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.thresholdinteger Yes
$.oneOf[0].allOf[1].Payload.maxThreshold = 10000000 Yes
$.oneOf[0].allOf[1].Payload.isAnyboolean Yes
$.oneOf[0].allOf[1].Payload.totalVisibleUserCountinteger Yes
$.oneOf[0].allOf[1].Payload.topUsersarray Yes
$.oneOf[0].allOf[1].Payload.topUsers[]object No
$.oneOf[0].allOf[1].Payload.topUsers[].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.topUsers[].importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.topUsers[].topUserGroupImportanceinteger Yes
$.oneOf[0].allOf[1].Payload.topUsers[].aliasstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.topUsers[].avatarstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.topUsers[].topUserGroupNamestring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.topUsers[].topMedalCategoryNamestring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.topUsers[].profileURLstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.groupsarray Yes
$.oneOf[0].allOf[1].Payload.groups[]object No
$.oneOf[0].allOf[1].Payload.groups[].userGroupIDinteger Yes
$.oneOf[0].allOf[1].Payload.groups[].importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.groups[].medalCategoryIDinteger Yes
$.oneOf[0].allOf[1].Payload.groups[].qualifyingUserCountinteger Yes
$.oneOf[0].allOf[1].Payload.groups[].namestring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.groups[].slugstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.groups[].descriptionstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.groups[].iconURLstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.groups[].colorstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.groups[].textColorstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.groups[].medalCategoryNamestring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.groups[].medalCategorySlugstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.groups[].topUsersarray Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_profile_visibility_preview",
    "RequestUserAlias": "example-user",
    "Payload": {
        "threshold": 0,
        "maxThreshold": 10000000,
        "isAny": false,
        "totalVisibleUserCount": 0,
        "topUsers": [],
        "groups": []
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_profile_visitors

#
Returns signed-in visitors for a profile. Auth: the profile owner needs Permission::SeeProfileInsights to see their own visitor identities. Administrators with Permission::AccessSpecialFunctions can inspect other profiles. Anonymous or IP-only profile views are counted in the aggregate but are never exposed here. Owner responses also include notifyOnProfileVisit, profileVisitNotificationPriority (Normal or Priority), and each visitor's tradeContext (totalTransactionCount, latestCompletedTransaction, description). Administrator inspection of another profile never includes that owner's private trade context or setting. Visitors are ordered by their most recent visit, newest first, with user ID descending as the tie-breaker. Follow relationships do not change the order, including across pages.

Parameters

NameTypeRequiredDefaultDescription
userAlias string Yes — Public alias of the profile owner.
start int No 0 Result offset for pagination.
pageLength int No 50 Maximum visitors to return, capped at 100.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_profile_visitors' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'start={{start}}' \
  --data-urlencode 'pageLength={{pageLength}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_profile_visitors_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.visitorsarray Yes
$.oneOf[0].allOf[1].Payload.visitors[]object No
$.oneOf[0].allOf[1].Payload.visitors[].userIdinteger Yes
$.oneOf[0].allOf[1].Payload.visitors[].aliasstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.visitors[].avatarEmojistring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.visitors[].profileUrlstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.visitors[].firstViewDatestring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.visitors[].lastViewDatestring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.visitors[].lastViewLabelstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.visitors[].personalNotestring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.visitors[].minutesAgo Yes
$.oneOf[0].allOf[1].Payload.visitors[].minutesAgo.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.visitors[].minutesAgo.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.visitors[].viewerIsFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.visitors[].viewCountinteger Yes
$.oneOf[0].allOf[1].Payload.visitors[].tradeContext No
$.oneOf[0].allOf[1].Payload.visitors[].tradeContext.anyOf[0]object No
$.oneOf[0].allOf[1].Payload.visitors[].tradeContext.anyOf[0].totalTransactionCountinteger Yes
$.oneOf[0].allOf[1].Payload.visitors[].tradeContext.anyOf[0].latestCompletedTransaction Yes
$.oneOf[0].allOf[1].Payload.visitors[].tradeContext.anyOf[0].latestCompletedTransaction.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.visitors[].tradeContext.anyOf[0].latestCompletedTransaction.anyOf[0].transactionIDinteger Yes
$.oneOf[0].allOf[1].Payload.visitors[].tradeContext.anyOf[0].latestCompletedTransaction.anyOf[0].rolestring ["buyer","seller"] Yes
$.oneOf[0].allOf[1].Payload.visitors[].tradeContext.anyOf[0].latestCompletedTransaction.anyOf[0].itemstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.visitors[].tradeContext.anyOf[0].latestCompletedTransaction.anyOf[0].venuestring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.visitors[].tradeContext.anyOf[0].latestCompletedTransaction.anyOf[0].completedDate Yes
$.oneOf[0].allOf[1].Payload.visitors[].tradeContext.anyOf[0].latestCompletedTransaction.anyOf[0].completedDate.anyOf[0]string YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.visitors[].tradeContext.anyOf[0].latestCompletedTransaction.anyOf[0].completedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.visitors[].tradeContext.anyOf[0].latestCompletedTransaction.anyOf[0].isRefundedboolean Yes
$.oneOf[0].allOf[1].Payload.visitors[].tradeContext.anyOf[0].latestCompletedTransaction.anyOf[0].isNoShowRefundboolean Yes
$.oneOf[0].allOf[1].Payload.visitors[].tradeContext.anyOf[0].latestCompletedTransaction.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.visitors[].tradeContext.anyOf[0].descriptionstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.visitors[].tradeContext.anyOf[1]null No
$.oneOf[0].allOf[1].Payload.totalCountinteger Yes
$.oneOf[0].allOf[1].Payload.startinteger Yes
$.oneOf[0].allOf[1].Payload.pageLengthinteger Yes
$.oneOf[0].allOf[1].Payload.hasMoreboolean Yes
$.oneOf[0].allOf[1].Payload.notifyOnProfileVisitboolean No
$.oneOf[0].allOf[1].Payload.profileVisitNotificationPrioritystring ["Normal","Priority"] No
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_profile_visitors",
    "RequestUserAlias": "example-user",
    "Payload": {
        "visitors": [],
        "totalCount": 0,
        "start": 0,
        "pageLength": 0,
        "hasMore": false
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_purchase_contact_options

#
Lists the acting buyer's completed purchases from a seller and authorized purchase conversations. Does not create, reopen or grant access to chats. Closed or unavailable chats use the authorized reservation help page.

Parameters

NameTypeRequiredDefaultDescription
userAlias string Yes — Seller profile alias.
start int No 0 Pagination offset; use nextStart until null, including after an empty page.
transactionID int No 0 Optional purchase to revalidate before opening a conversation.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_purchase_contact_options' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'start={{start}}' \
  --data-urlencode 'transactionID={{transactionID}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_purchase_contact_options_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.itemsarray Yes
$.oneOf[0].allOf[1].Payload.items[]object No
$.oneOf[0].allOf[1].Payload.items[].transactionIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].labelstring Yes
$.oneOf[0].allOf[1].Payload.items[].reservationURLstring Yes
$.oneOf[0].allOf[1].Payload.items[].chatID Yes
$.oneOf[0].allOf[1].Payload.items[].chatID.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.items[].chatID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.items[].chatNamestring Yes
$.oneOf[0].allOf[1].Payload.items[].chatURLstring Yes
$.oneOf[0].allOf[1].Payload.nextStart Yes
$.oneOf[0].allOf[1].Payload.nextStart.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.nextStart.anyOf[1]null Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_purchase_contact_options",
    "RequestUserAlias": "example-user",
    "Payload": {
        "items": [],
        "nextStart": 0
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_relationship_block_list

#
Returns users blocked by the current viewer.

Parameters

NameTypeRequiredDefaultDescription
limit int No 100 Maximum users to return, capped at 200.
offset int No 0 Pagination offset.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_relationship_block_list' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'limit={{limit}}' \
  --data-urlencode 'offset={{offset}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_relationship_block_list_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.BlockedUsersarray Yes
$.oneOf[0].allOf[1].Payload.BlockedUsers[]object No
$.oneOf[0].allOf[1].Payload.BlockedUsers[].UserIDinteger Yes
$.oneOf[0].allOf[1].Payload.BlockedUsers[].Aliasstring Yes
$.oneOf[0].allOf[1].Payload.BlockedUsers[].Avatarstring Yes
$.oneOf[0].allOf[1].Payload.BlockedUsers[].Reasonstring Yes
$.oneOf[0].allOf[1].Payload.BlockedUsers[].BlockedDate Yes
$.oneOf[0].allOf[1].Payload.BlockedUsers[].BlockedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.BlockedUsers[].BlockedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.Pageobject Yes
$.oneOf[0].allOf[1].Payload.Page.Limitinteger Yes
$.oneOf[0].allOf[1].Payload.Page.Offsetinteger Yes
$.oneOf[0].allOf[1].Payload.Page.NextOffsetinteger Yes
$.oneOf[0].allOf[1].Payload.Page.HasMoreboolean Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_relationship_block_list",
    "RequestUserAlias": "example-user",
    "Payload": {
        "BlockedUsers": [],
        "Page": {
            "Limit": 0,
            "Offset": 0,
            "NextOffset": 0,
            "HasMore": false
        }
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_relationship_controls

#
Returns the current viewer's block/mute controls for a target user.

Parameters

NameTypeRequiredDefaultDescription
userAlias string Yes — Alias of the target user.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_relationship_controls' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_relationship_controls_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.actorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.targetUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.isBlockedboolean Yes
$.oneOf[0].allOf[1].Payload.blockedDate Yes
$.oneOf[0].allOf[1].Payload.blockedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.blockedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.isMutedboolean Yes
$.oneOf[0].allOf[1].Payload.mutedDate Yes
$.oneOf[0].allOf[1].Payload.mutedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.mutedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.reasonstring Yes
$.oneOf[0].allOf[1].Payload.personalNotestring Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_relationship_controls",
    "RequestUserAlias": "example-user",
    "Payload": {
        "actorUserID": 0,
        "targetUserID": 0,
        "isBlocked": false,
        "blockedDate": "synthetic-example",
        "isMuted": false,
        "mutedDate": "synthetic-example",
        "reason": "synthetic-example",
        "personalNote": "synthetic-example"
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_transaction_history

#
Returns transaction history for the user

Parameters

NameTypeRequiredDefaultDescription
userAlias string No "" Alias of user to return transaction history for **Note:** Only administrators are able to access other users transaction history details other than transactions that they have facilitated with each other
peerUserAlias string No "" Alias of user that was transacted with (e.g. the Seller Alias in case user wants to find the buyer history or Buyer Alias in the seller history)
locationAlias string No "" Slug found after the slash when opening a location in the portal
returnCreatedAppointmentTransactionsOnly bool No false Defines if only sales that were also created by the user are returned. The AT Trackrecord is calculated based on this parameter being true
transactionType string No "SELLER" Transaction Type - Can be 'SELLER' or 'BUYER'
status string No "COMPLETED" Transaction State. Can be COMPLETED, PENDING or CANCELLED
dateTimeRangeStart string No "" Time Range Start Date, will be ignored if empty format: YYYY-MM-DD HH:MM:SS
dateTimeRangeEnd string No "" Time Range End Date, will be ignored if empty format: YYYY-MM-DD HH:MM:SS
pageSize int No 200 Defines how many results will be return per request
pageNumber int No 0 Defines which page should be returned
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_transaction_history' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'peerUserAlias={{peerUserAlias}}' \
  --data-urlencode 'locationAlias={{locationAlias}}' \
  --data-urlencode 'returnCreatedAppointmentTransactionsOnly={{returnCreatedAppointmentTransactionsOnly}}' \
  --data-urlencode 'transactionType={{transactionType}}' \
  --data-urlencode 'status={{status}}' \
  --data-urlencode 'dateTimeRangeStart={{dateTimeRangeStart}}' \
  --data-urlencode 'dateTimeRangeEnd={{dateTimeRangeEnd}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_transaction_history_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Yes
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationobject Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalNumberTransactionsDatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalNumberTransactions.oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalNumberTransactions.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalAmountUSDDatabaseNumber YesNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalAmountUSD.oneOf[0]number Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalAmountUSD.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.pageNumberstring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].transactionStatusstring ["PENDING","COMPLETED","CANCELLED"] Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].transactionAmountDatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].transactionAmount.oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].transactionAmount.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingUUID Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingUUID.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingUUID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingDatestring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].Notes Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].Notes.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].Notes.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].CreatorAlias Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].CreatorAlias.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].CreatorAlias.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].SellerAlias Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].SellerAlias.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].SellerAlias.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].BuyerAlias Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].BuyerAlias.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].BuyerAlias.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingSoldDate Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingSoldDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingSoldDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accessCode Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accessCode.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accessCode.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidID Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidID.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidID.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidID.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidSecondsToFirstResponse Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidSecondsToFirstResponse.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidSecondsToFirstResponse.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidSecondsToFirstResponse.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidSecondsToFirstResponse.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidSecondsToCompletion Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidSecondsToCompletion.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidSecondsToCompletion.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidSecondsToCompletion.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidSecondsToCompletion.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingCustomerRefundAccountLedgerID Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingCustomerRefundAccountLedgerID.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingCustomerRefundAccountLedgerID.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingCustomerRefundAccountLedgerID.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingCustomerRefundAccountLedgerID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingSellerNoShowRefundAccountLedgerID Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingSellerNoShowRefundAccountLedgerID.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingSellerNoShowRefundAccountLedgerID.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingSellerNoShowRefundAccountLedgerID.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingSellerNoShowRefundAccountLedgerID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].buyerIdentityHiddenboolean NoResponse projection adds this flag when a bid context is present; true hides the buyer during the current race.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].buyerIdentityHiddenUntilinteger | null NoSaved race closing timestamp in Unix seconds, or null when identity is visible.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string No
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_transaction_history",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATResponseObjectType": "NestedKeyValueList",
        "ResponseBody": {
            "Name": "synthetic-example",
            "MetaInformation": {
                "totalNumberTransactions": 0,
                "totalAmountUSD": 0,
                "pageNumber": "synthetic-example"
            },
            "KeyValueList": [],
            "KeyValueFieldList": []
        }
    }
}
Machine-readable endpoint documentation
GET

/v1/user/get_user_to_user_chat_tag_id

#
Returns the chat id for the user-to-user chat

Parameters

NameTypeRequiredDefaultDescription
userAlias string Yes — useralias
dateTimeExpiry string No "" Deprecated and ignored. Direct chats never expire.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_user_to_user_chat_tag_id' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'dateTimeExpiry={{dateTimeExpiry}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_user_to_user_chat_tag_id_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[1].ErrorReasonstring NoEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_user_to_user_chat_tag_id",
    "RequestUserAlias": "example-user",
    "Payload": "synthetic-example"
}
Machine-readable endpoint documentation
GET

/v1/user/get_verification_invite

#
Returns the public invite payload for a /verify/{uuid} community verification link. Public-by-design: possession of the verification UUID is the invite authorization. This endpoint exposes only the target identity details already shown to anyone opening the invite and the acting viewer's ability to cast a verification vote.

Parameters

NameTypeRequiredDefaultDescription
uuid string Yes — Verification UUID from /verify/{uuid}.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/user/get_verification_invite' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'uuid={{uuid}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_get_verification_invite_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.targetobject Yes
$.oneOf[0].allOf[1].Payload.target.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.target.aliasstring Yes
$.oneOf[0].allOf[1].Payload.target.avatarstring Yes
$.oneOf[0].allOf[1].Payload.target.profileURLstring Yes
$.oneOf[0].allOf[1].Payload.target.communityVerificationStatusstring ["Unverified","Verified"] Yes
$.oneOf[0].allOf[1].Payload.target.communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.target.communityVerificationCountFormattedstring Yes
$.oneOf[0].allOf[1].Payload.target.firstNamestring Yes
$.oneOf[0].allOf[1].Payload.target.lastNamestring Yes
$.oneOf[0].allOf[1].Payload.target.displayNamestring Yes
$.oneOf[0].allOf[1].Payload.target.professionstring Yes
$.oneOf[0].allOf[1].Payload.viewerobject Yes
$.oneOf[0].allOf[1].Payload.viewer.isLoggedInboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.isSelfTargetboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.alreadyVotedboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.canSubmitboolean Yes
$.oneOf[0].allOf[1].Payload.viewer.userID Yes
$.oneOf[0].allOf[1].Payload.viewer.userID.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.viewer.userID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.viewer.existingVoteIsPositive Yes
$.oneOf[0].allOf[1].Payload.viewer.existingVoteIsPositive.anyOf[0]boolean Yes
$.oneOf[0].allOf[1].Payload.viewer.existingVoteIsPositive.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.verificationobject Yes
$.oneOf[0].allOf[1].Payload.verification.uuidstring Yes
$.oneOf[0].allOf[1].Payload.verification.sharePathstring Yes
$.oneOf[0].allOf[1].Payload.verification.shareURLstring Yes
$.oneOf[0].allOf[1].Payload.verification.messagestring Yes
$.oneOf[0].allOf[1].Payload.verification.requiredNetPositiveVerifications = 3 Yes
$.oneOf[0].allOf[1].Payload.impactobject Yes
$.oneOf[0].allOf[1].Payload.impact.transactionCountinteger Yes
$.oneOf[0].allOf[1].Payload.impact.transactionCountRoundedinteger Yes
$.oneOf[0].allOf[1].Payload.impact.tradingVolumeCentsinteger Yes
$.oneOf[0].allOf[1].Payload.impact.userCountinteger Yes
$.oneOf[0].allOf[1].Payload.impact.locationCountinteger Yes
$.oneOf[0].allOf[1].Payload.impact.tradingVolumenumber Yes
$.oneOf[0].allOf[1].Payload.impact.averagePricenumber Yes
$.oneOf[0].allOf[1].Payload.impact.transactionCountFormattedstring Yes
$.oneOf[0].allOf[1].Payload.impact.tradingVolumeFormattedstring Yes
$.oneOf[0].allOf[1].Payload.impact.averagePriceFormattedstring Yes
$.oneOf[0].allOf[1].Payload.impact.userCountFormattedstring Yes
$.oneOf[0].allOf[1].Payload.impact.locationCountFormattedstring Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/get_verification_invite",
    "RequestUserAlias": "example-user",
    "Payload": {
        "target": {
            "userID": 0,
            "alias": "synthetic-example",
            "avatar": "synthetic-example",
            "profileURL": "synthetic-example",
            "communityVerificationStatus": "Unverified",
            "communityVerificationCount": 0,
            "communityVerificationCountFormatted": "synthetic-example",
            "firstName": "synthetic-example",
            "lastName": "synthetic-example",
            "displayName": "synthetic-example",
            "profession": "synthetic-example"
        },
        "viewer": {
            "isLoggedIn": false,
            "isSelfTarget": false,
            "alreadyVoted": false,
            "canSubmit": false,
            "userID": 0,
            "existingVoteIsPositive": false
        },
        "verification": {
            "uuid": "synthetic-example",
            "sharePath": "synthetic-example",
            "shareURL": "synthetic-example",
            "message": "synthetic-example",
            "requiredNetPositiveVerifications": 3
        },
        "impact": {
            "transactionCount": 0,
            "transactionCountRounded": 0,
            "tradingVolumeCents": 0,
            "userCount": 0,
            "locationCount": 0,
            "tradingVolume": 0,
            "averagePrice": 0,
            "transactionCountFormatted": "synthetic-example",
            "tradingVolumeFormatted": "synthetic-example",
            "averagePriceFormatted": "synthetic-example",
            "userCountFormatted": "synthetic-example",
            "locationCountFormatted": "synthetic-example"
        }
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_account_phone

#
Set the acting user's default phone using POST. Inheriting addresses require review of the new phone; the approved payout snapshot remains active.

Parameters

NameTypeRequiredDefaultDescription
phone string Yes — International number including country code.
expectedPhone string No "" Previous default phone returned by get_address_manager; prevents overwriting a concurrent edit. Empty or omitted is valid only when no default phone exists.
isWritingRequest bool No false Explicit write confirmation.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_account_phone' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'phone={{phone}}' \
  --data-urlencode 'expectedPhone={{expectedPhone}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_account_phone_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.userAliasstring Yes
$.oneOf[0].allOf[1].Payload.canEditboolean Yes
$.oneOf[0].allOf[1].Payload.defaultPhonestring Yes
$.oneOf[0].allOf[1].Payload.totalinteger Yes
$.oneOf[0].allOf[1].Payload.primary Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].addressIDinteger Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].reviewIDinteger Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].formattedAddressstring Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].phonestring Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].status = "IdentityConfirmed" Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.addressesarray Yes
$.oneOf[0].allOf[1].Payload.addresses[]object No
$.oneOf[0].allOf[1].Payload.addresses[].idinteger Yes
$.oneOf[0].allOf[1].Payload.addresses[].revisioninteger Yes
$.oneOf[0].allOf[1].Payload.addresses[].labelstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].addressPersonalAddress Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].formatted_addressstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_componentsarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[]object No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].long_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].short_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].typesarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].types[]string No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].source = "google" Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].unitstring No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].formatted_addressstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_componentsarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[]object No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].long_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].short_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].typesarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].types[]string No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].source = "photon" Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].osmobject Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].osm.typestring ["N","W","R"] Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].osm.idstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].coordinatesobject Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].coordinates.latitudenumber Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].coordinates.longitudenumber Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].resultTypestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].schemaVersion = 1 Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].unitstring No
$.oneOf[0].allOf[1].Payload.addresses[].formattedAddressstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].phoneOverride Yes
$.oneOf[0].allOf[1].Payload.addresses[].phoneOverride.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.addresses[].phoneOverride.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.addresses[].phonestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].statusstring ["NotReviewed","SubmittedForReview","Rejected","CancelledByUser","IdentityConfirmed"] Yes
$.oneOf[0].allOf[1].Payload.addresses[].reviewIDinteger Yes
$.oneOf[0].allOf[1].Payload.addresses[].rejectReasonstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].isPrimaryboolean Yes
$.oneOf[0].allOf[1].Payload.addresses[].isActiveSnapshotboolean Yes
$.oneOf[0].allOf[1].Payload.nextStartinteger Yes
$.oneOf[0].allOf[1].Payload.hasMoreboolean Yes
$.oneOf[0].allOf[1].Payload.reviewDefaultsobject No
$.oneOf[0].allOf[1].Payload.reviewDefaults.firstNamestring Yes
$.oneOf[0].allOf[1].Payload.reviewDefaults.lastNamestring Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_account_phone",
    "RequestUserAlias": "example-user",
    "Payload": {
        "userAlias": "synthetic-example",
        "canEdit": false,
        "defaultPhone": "synthetic-example",
        "total": 0,
        "primary": {
            "addressID": 0,
            "reviewID": 0,
            "formattedAddress": "synthetic-example",
            "phone": "synthetic-example",
            "status": "IdentityConfirmed"
        },
        "addresses": [],
        "nextStart": 0,
        "hasMore": false
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_address

#
Create or edit an address owned by the acting user using POST. Label-only changes retain review status.

Parameters

NameTypeRequiredDefaultDescription
addressJSON string Yes — JSON address from location/get_address_suggestions, with optional unit. Never infer a phone country from it.
label string No "" Optional private label, up to 80 characters.
phoneOverride string No "" Optional international phone; empty uses the default account phone.
addressID int No 0 Existing address ID, or zero to create.
revision int No 0 Existing revision from get_address_manager, or zero to create.
isWritingRequest bool No false Explicit write confirmation.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_address' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'addressJSON={{addressJSON}}' \
  --data-urlencode 'label={{label}}' \
  --data-urlencode 'phoneOverride={{phoneOverride}}' \
  --data-urlencode 'addressID={{addressID}}' \
  --data-urlencode 'revision={{revision}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Parameters: addressJSON
FieldTypeRequiredDescription
addressJSONstring (application/json) Yes
addressJSONPersonalAddressInput (decoded JSON) YesCanonical fields and supported provider aliases. Source defaults to google. Photon requires osm and coordinates; normalized output uses snake_case components. Extra provider fields are discarded.
addressJSON.anyOf[0]object Yes
addressJSON.anyOf[0].formatted_addressstring Yes
addressJSON.anyOf[0].address_componentsarray Yes
addressJSON.anyOf[0].address_components[]object No
addressJSON.anyOf[0].address_components[].long_namestring No
addressJSON.anyOf[0].address_components[].short_namestring No
addressJSON.anyOf[0].address_components[].longTextstring No
addressJSON.anyOf[0].address_components[].shortTextstring No
addressJSON.anyOf[0].address_components[].typesarray Yes
addressJSON.anyOf[0].address_components[].types[]string No
addressJSON.anyOf[0].sourcestring ["google","photon"] No
addressJSON.anyOf[0].osmobject No
addressJSON.anyOf[0].osm.typestring ["N","W","R"] Yes
addressJSON.anyOf[0].osm.id Yes
addressJSON.anyOf[0].osm.id.anyOf[0]integer Yes
addressJSON.anyOf[0].osm.id.anyOf[1]string Yes
addressJSON.anyOf[0].coordinatesobject No
addressJSON.anyOf[0].coordinates.latitude Yes
addressJSON.anyOf[0].coordinates.latitude.anyOf[0]number Yes
addressJSON.anyOf[0].coordinates.latitude.anyOf[1]string Yes
addressJSON.anyOf[0].coordinates.longitude Yes
addressJSON.anyOf[0].coordinates.longitude.anyOf[0]number Yes
addressJSON.anyOf[0].coordinates.longitude.anyOf[1]string Yes
addressJSON.anyOf[0].resultTypestring No
addressJSON.anyOf[0].schemaVersion = 1 No
addressJSON.anyOf[0].unitstring No
addressJSON.anyOf[0].formattedAddressstring No
addressJSON.anyOf[0].addressComponentsarray No
addressJSON.anyOf[0].addressComponents[]object No
addressJSON.anyOf[0].addressComponents[].long_namestring No
addressJSON.anyOf[0].addressComponents[].short_namestring No
addressJSON.anyOf[0].addressComponents[].longTextstring No
addressJSON.anyOf[0].addressComponents[].shortTextstring No
addressJSON.anyOf[0].addressComponents[].typesarray Yes
addressJSON.anyOf[0].addressComponents[].types[]string No
addressJSON.anyOf[1]object Yes
addressJSON.anyOf[1].formatted_addressstring Yes
addressJSON.anyOf[1].address_componentsarray No
addressJSON.anyOf[1].address_components[]object No
addressJSON.anyOf[1].address_components[].long_namestring No
addressJSON.anyOf[1].address_components[].short_namestring No
addressJSON.anyOf[1].address_components[].longTextstring No
addressJSON.anyOf[1].address_components[].shortTextstring No
addressJSON.anyOf[1].address_components[].typesarray Yes
addressJSON.anyOf[1].address_components[].types[]string No
addressJSON.anyOf[1].sourcestring ["google","photon"] No
addressJSON.anyOf[1].osmobject No
addressJSON.anyOf[1].osm.typestring ["N","W","R"] Yes
addressJSON.anyOf[1].osm.id Yes
addressJSON.anyOf[1].osm.id.anyOf[0]integer Yes
addressJSON.anyOf[1].osm.id.anyOf[1]string Yes
addressJSON.anyOf[1].coordinatesobject No
addressJSON.anyOf[1].coordinates.latitude Yes
addressJSON.anyOf[1].coordinates.latitude.anyOf[0]number Yes
addressJSON.anyOf[1].coordinates.latitude.anyOf[1]string Yes
addressJSON.anyOf[1].coordinates.longitude Yes
addressJSON.anyOf[1].coordinates.longitude.anyOf[0]number Yes
addressJSON.anyOf[1].coordinates.longitude.anyOf[1]string Yes
addressJSON.anyOf[1].resultTypestring No
addressJSON.anyOf[1].schemaVersion = 1 No
addressJSON.anyOf[1].unitstring No
addressJSON.anyOf[1].formattedAddressstring No
addressJSON.anyOf[1].addressComponentsarray Yes
addressJSON.anyOf[1].addressComponents[]object No
addressJSON.anyOf[1].addressComponents[].long_namestring No
addressJSON.anyOf[1].addressComponents[].short_namestring No
addressJSON.anyOf[1].addressComponents[].longTextstring No
addressJSON.anyOf[1].addressComponents[].shortTextstring No
addressJSON.anyOf[1].addressComponents[].typesarray Yes
addressJSON.anyOf[1].addressComponents[].types[]string No
addressJSON.anyOf[2]object Yes
addressJSON.anyOf[2].formatted_addressstring No
addressJSON.anyOf[2].address_componentsarray Yes
addressJSON.anyOf[2].address_components[]object No
addressJSON.anyOf[2].address_components[].long_namestring No
addressJSON.anyOf[2].address_components[].short_namestring No
addressJSON.anyOf[2].address_components[].longTextstring No
addressJSON.anyOf[2].address_components[].shortTextstring No
addressJSON.anyOf[2].address_components[].typesarray Yes
addressJSON.anyOf[2].address_components[].types[]string No
addressJSON.anyOf[2].sourcestring ["google","photon"] No
addressJSON.anyOf[2].osmobject No
addressJSON.anyOf[2].osm.typestring ["N","W","R"] Yes
addressJSON.anyOf[2].osm.id Yes
addressJSON.anyOf[2].osm.id.anyOf[0]integer Yes
addressJSON.anyOf[2].osm.id.anyOf[1]string Yes
addressJSON.anyOf[2].coordinatesobject No
addressJSON.anyOf[2].coordinates.latitude Yes
addressJSON.anyOf[2].coordinates.latitude.anyOf[0]number Yes
addressJSON.anyOf[2].coordinates.latitude.anyOf[1]string Yes
addressJSON.anyOf[2].coordinates.longitude Yes
addressJSON.anyOf[2].coordinates.longitude.anyOf[0]number Yes
addressJSON.anyOf[2].coordinates.longitude.anyOf[1]string Yes
addressJSON.anyOf[2].resultTypestring No
addressJSON.anyOf[2].schemaVersion = 1 No
addressJSON.anyOf[2].unitstring No
addressJSON.anyOf[2].formattedAddressstring Yes
addressJSON.anyOf[2].addressComponentsarray No
addressJSON.anyOf[2].addressComponents[]object No
addressJSON.anyOf[2].addressComponents[].long_namestring No
addressJSON.anyOf[2].addressComponents[].short_namestring No
addressJSON.anyOf[2].addressComponents[].longTextstring No
addressJSON.anyOf[2].addressComponents[].shortTextstring No
addressJSON.anyOf[2].addressComponents[].typesarray Yes
addressJSON.anyOf[2].addressComponents[].types[]string No
addressJSON.anyOf[3]object Yes
addressJSON.anyOf[3].formatted_addressstring No
addressJSON.anyOf[3].address_componentsarray No
addressJSON.anyOf[3].address_components[]object No
addressJSON.anyOf[3].address_components[].long_namestring No
addressJSON.anyOf[3].address_components[].short_namestring No
addressJSON.anyOf[3].address_components[].longTextstring No
addressJSON.anyOf[3].address_components[].shortTextstring No
addressJSON.anyOf[3].address_components[].typesarray Yes
addressJSON.anyOf[3].address_components[].types[]string No
addressJSON.anyOf[3].sourcestring ["google","photon"] No
addressJSON.anyOf[3].osmobject No
addressJSON.anyOf[3].osm.typestring ["N","W","R"] Yes
addressJSON.anyOf[3].osm.id Yes
addressJSON.anyOf[3].osm.id.anyOf[0]integer Yes
addressJSON.anyOf[3].osm.id.anyOf[1]string Yes
addressJSON.anyOf[3].coordinatesobject No
addressJSON.anyOf[3].coordinates.latitude Yes
addressJSON.anyOf[3].coordinates.latitude.anyOf[0]number Yes
addressJSON.anyOf[3].coordinates.latitude.anyOf[1]string Yes
addressJSON.anyOf[3].coordinates.longitude Yes
addressJSON.anyOf[3].coordinates.longitude.anyOf[0]number Yes
addressJSON.anyOf[3].coordinates.longitude.anyOf[1]string Yes
addressJSON.anyOf[3].resultTypestring No
addressJSON.anyOf[3].schemaVersion = 1 No
addressJSON.anyOf[3].unitstring No
addressJSON.anyOf[3].formattedAddressstring Yes
addressJSON.anyOf[3].addressComponentsarray Yes
addressJSON.anyOf[3].addressComponents[]object No
addressJSON.anyOf[3].addressComponents[].long_namestring No
addressJSON.anyOf[3].addressComponents[].short_namestring No
addressJSON.anyOf[3].addressComponents[].longTextstring No
addressJSON.anyOf[3].addressComponents[].shortTextstring No
addressJSON.anyOf[3].addressComponents[].typesarray Yes
addressJSON.anyOf[3].addressComponents[].types[]string No
Response fields
FieldTypeRequiredDescription
$user_set_address_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.addressIDinteger Yes
$.oneOf[0].allOf[1].Payload.managerobject Yes
$.oneOf[0].allOf[1].Payload.manager.userAliasstring Yes
$.oneOf[0].allOf[1].Payload.manager.canEditboolean Yes
$.oneOf[0].allOf[1].Payload.manager.defaultPhonestring Yes
$.oneOf[0].allOf[1].Payload.manager.totalinteger Yes
$.oneOf[0].allOf[1].Payload.manager.primary Yes
$.oneOf[0].allOf[1].Payload.manager.primary.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.manager.primary.anyOf[0].addressIDinteger Yes
$.oneOf[0].allOf[1].Payload.manager.primary.anyOf[0].reviewIDinteger Yes
$.oneOf[0].allOf[1].Payload.manager.primary.anyOf[0].formattedAddressstring Yes
$.oneOf[0].allOf[1].Payload.manager.primary.anyOf[0].phonestring Yes
$.oneOf[0].allOf[1].Payload.manager.primary.anyOf[0].status = "IdentityConfirmed" Yes
$.oneOf[0].allOf[1].Payload.manager.primary.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.manager.addressesarray Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[]object No
$.oneOf[0].allOf[1].Payload.manager.addresses[].idinteger Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].revisioninteger Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].labelstring Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].addressPersonalAddress Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[0].formatted_addressstring Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[0].address_componentsarray Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[0].address_components[]object No
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[0].address_components[].long_namestring Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[0].address_components[].short_namestring Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[0].address_components[].typesarray Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[0].address_components[].types[]string No
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[0].source = "google" Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[0].unitstring No
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[1].formatted_addressstring Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[1].address_componentsarray Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[1].address_components[]object No
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[1].address_components[].long_namestring Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[1].address_components[].short_namestring Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[1].address_components[].typesarray Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[1].address_components[].types[]string No
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[1].source = "photon" Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[1].osmobject Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[1].osm.typestring ["N","W","R"] Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[1].osm.idstring Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[1].coordinatesobject Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[1].coordinates.latitudenumber Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[1].coordinates.longitudenumber Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[1].resultTypestring Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[1].schemaVersion = 1 Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].address.anyOf[1].unitstring No
$.oneOf[0].allOf[1].Payload.manager.addresses[].formattedAddressstring Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].phoneOverride Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].phoneOverride.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].phoneOverride.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].phonestring Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].statusstring ["NotReviewed","SubmittedForReview","Rejected","CancelledByUser","IdentityConfirmed"] Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].reviewIDinteger Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].rejectReasonstring Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].isPrimaryboolean Yes
$.oneOf[0].allOf[1].Payload.manager.addresses[].isActiveSnapshotboolean Yes
$.oneOf[0].allOf[1].Payload.manager.nextStartinteger Yes
$.oneOf[0].allOf[1].Payload.manager.hasMoreboolean Yes
$.oneOf[0].allOf[1].Payload.manager.reviewDefaultsobject No
$.oneOf[0].allOf[1].Payload.manager.reviewDefaults.firstNamestring Yes
$.oneOf[0].allOf[1].Payload.manager.reviewDefaults.lastNamestring Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_address",
    "RequestUserAlias": "example-user",
    "Payload": {
        "addressID": 0,
        "manager": {
            "userAlias": "synthetic-example",
            "canEdit": false,
            "defaultPhone": "synthetic-example",
            "total": 0,
            "primary": {
                "addressID": 0,
                "reviewID": 0,
                "formattedAddress": "synthetic-example",
                "phone": "synthetic-example",
                "status": "IdentityConfirmed"
            },
            "addresses": [],
            "nextStart": 0,
            "hasMore": false
        }
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_avatar

#
Sets the user's avatar (an emoji). Replaces the legacy /modules/community/changeprofile.php flow with a v2-friendly apiv1 surface that the v2 user-profile "MY ACCOUNT" panel can call directly. The v1 page stays in place as the non-v2 fallback. Reuses \AT\User::SetUserAvatar(), which already strips non-emoji characters and writes only when a single grapheme remains -- we do not re-implement that validation here.

Parameters

NameTypeRequiredDefaultDescription
avatar string Yes — Avatar value (typically a single emoji). Non-emoji characters are stripped server-side.
isWritingRequest bool No false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_avatar' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'avatar={{avatar}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_avatar_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payload = true Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_avatar",
    "RequestUserAlias": "example-user",
    "Payload": true
}
Machine-readable endpoint documentation
POST

/v1/user/set_bid_user_to_user_chat_request

#
Starts or reopens a bid customer chat after checking bid chat availability. Preserves the legacy customer-chat rule: the viewer must be the buyer or current holder of the bid, the target must be the bid counterparty. Existing bid participants can reopen before expiry. Each bid/buyer/seller pair has a separate chat, expiring three days after EndDate. Opening a bid chat does not create or approve a direct-chat request. Active selection on any of the customer's bids pauses incoming personal messages, including proposals; ErrorReason=active_bid_selection. Existing history remains readable.

Parameters

NameTypeRequiredDefaultDescription
userAlias string Yes — Alias of the bid counterparty to message.
bidID int No 0 Bid ID that grants the temporary customer-chat relationship.
isWritingRequest bool No false Required true to create or reopen the chat.
changeProposalNote string No "" Optional seller note explaining the proposal.
changeProposalLocationAlias string No "" Seller-proposed alternate venue alias.
changeProposalStartDateTime string No "" Seller-proposed alternate start date/time.
changeProposalInventoryTypeID int No 0 Seller-proposed inventory type ID for the proposed venue.
changeProposalVenue string No "" Deprecated free-text proposal venue; structured proposal fields are required.
changeProposalTime string No "" Deprecated free-text proposal time; structured proposal fields are required.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_bid_user_to_user_chat_request' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}' \
  --data-urlencode 'changeProposalNote={{changeProposalNote}}' \
  --data-urlencode 'changeProposalLocationAlias={{changeProposalLocationAlias}}' \
  --data-urlencode 'changeProposalStartDateTime={{changeProposalStartDateTime}}' \
  --data-urlencode 'changeProposalInventoryTypeID={{changeProposalInventoryTypeID}}' \
  --data-urlencode 'changeProposalVenue={{changeProposalVenue}}' \
  --data-urlencode 'changeProposalTime={{changeProposalTime}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_bid_user_to_user_chat_request_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.ChatIDinteger Yes
$.oneOf[0].allOf[1].Payload.Namestring Yes
$.oneOf[0].allOf[1].Payload.EncodedTagstring Yes
$.oneOf[0].allOf[1].Payload.Urlstring Yes
$.oneOf[0].allOf[1].Payload.ChatUrlstring Yes
$.oneOf[0].allOf[1].Payload.BidChat Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].bidIDinteger Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].buyerUserIDinteger | null Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].sellerUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].otherUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].bidUUIDstring Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].otherUserAlias Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].otherUserAlias.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].otherUserAlias.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].reasonCodestring Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].reasonstring Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].expiresAt Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].expiresAt.anyOf[0]string YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].expiresAt.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].expiredboolean Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].canSendboolean Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].buyerIdentityHiddenboolean NoTrue when the authenticated viewer cannot see the buyer during the current response race.
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].buyerIdentityHiddenUntilinteger | null NoSaved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.UserToUser Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].chatIDinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].otherUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestingUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].destinationUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestMessageBodyIDinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestMessageCountinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestMessageLimitinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestMessagesRemaininginteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestMessageCooldownHoursinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestMessageSecondsUntilNextinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].otherAliasstring Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].otherAvatarstring Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].reasonCodestring Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].reasonstring Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].statusstring ["accepted","blocked-by-viewer","blocked-by-other","denied","pending"] Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].viewerRolestring ["requester","destination","participant"] Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].acceptedDate Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].acceptedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].acceptedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].deniedDate Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].deniedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].deniedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].lastRequestDate Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].lastRequestDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].lastRequestDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].nextRequestMessageDate Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].nextRequestMessageDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].nextRequestMessageDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].canSendNextRequestMessageboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].viewerBlockedOtherboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].otherBlockedViewerboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].viewerMutedOtherboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].otherMutedViewerboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].recipientAllowsChatRequestsboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].canAcceptboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].canDenyboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].canSendboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ChangeProposalSentboolean Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[1].ErrorReasonstring NoEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_bid_user_to_user_chat_request",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ChatID": 0,
        "Name": "synthetic-example",
        "EncodedTag": "synthetic-example",
        "Url": "synthetic-example",
        "ChatUrl": "synthetic-example",
        "BidChat": {
            "bidID": 900001,
            "buyerUserID": null,
            "sellerUserID": 900002,
            "otherUserID": 900003,
            "bidUUID": "00000000000000000000000000000001",
            "otherUserAlias": null,
            "reasonCode": "synthetic-example",
            "reason": "Synthetic customer privacy fixture.",
            "expiresAt": null,
            "expired": false,
            "canSend": false,
            "buyerIdentityHidden": true,
            "buyerIdentityHiddenUntil": 2100000000
        },
        "UserToUser": {
            "chatID": 0,
            "otherUserID": 0,
            "requestingUserID": 0,
            "destinationUserID": 0,
            "requestMessageBodyID": 0,
            "requestMessageCount": 0,
            "requestMessageLimit": 0,
            "requestMessagesRemaining": 0,
            "requestMessageCooldownHours": 0,
            "requestMessageSecondsUntilNext": 0,
            "otherAlias": "synthetic-example",
            "otherAvatar": "synthetic-example",
            "reasonCode": "synthetic-example",
            "reason": "synthetic-example",
            "status": "accepted",
            "viewerRole": "requester",
            "acceptedDate": "synthetic-example",
            "deniedDate": "synthetic-example",
            "lastRequestDate": "synthetic-example",
            "nextRequestMessageDate": "synthetic-example",
            "canSendNextRequestMessage": false,
            "viewerBlockedOther": false,
            "otherBlockedViewer": false,
            "viewerMutedOther": false,
            "otherMutedViewer": false,
            "recipientAllowsChatRequests": false,
            "canAccept": false,
            "canDeny": false,
            "canSend": false
        },
        "ChangeProposalSent": false
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_cancel_email_change

#
Cancel the owner's pending change, or an explicitly selected target's change with AccessSpecialFunctions.

Parameters

NameTypeRequiredDefaultDescription
requestID int Yes — Pending request ID.
userID int No 0 0 selects the original caller; explicit targets require admin permission.
isWritingRequest bool No false Must be true. POST only.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_cancel_email_change' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'requestID={{requestID}}' \
  --data-urlencode 'userID={{userID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_cancel_email_change_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.requestobject Yes
$.oneOf[0].allOf[1].Payload.request.idinteger Yes
$.oneOf[0].allOf[1].Payload.request.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.request.oldEmailstring Yes
$.oneOf[0].allOf[1].Payload.request.newEmailstring Yes
$.oneOf[0].allOf[1].Payload.request.statusstring ["Preparing","Pending","Completed","Cancelled","Expired","Failed"] Yes
$.oneOf[0].allOf[1].Payload.request.reason Yes
$.oneOf[0].allOf[1].Payload.request.reason.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.request.reason.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.request.activeboolean Yes
$.oneOf[0].allOf[1].Payload.request.requestedAtstring Yes
$.oneOf[0].allOf[1].Payload.request.resolvedAt Yes
$.oneOf[0].allOf[1].Payload.request.resolvedAt.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.request.resolvedAt.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.request.dueAt Yes
$.oneOf[0].allOf[1].Payload.request.dueAt.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.request.dueAt.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.request.verifiedboolean Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_cancel_email_change",
    "RequestUserAlias": "example-user",
    "Payload": {
        "request": {
            "id": 0,
            "userID": 0,
            "oldEmail": "old-owner@example.invalid",
            "newEmail": "new-owner@example.invalid",
            "status": "Preparing",
            "reason": "synthetic-example",
            "active": false,
            "requestedAt": "synthetic-example",
            "resolvedAt": "synthetic-example",
            "dueAt": "synthetic-example",
            "verified": false
        }
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_community_verifiable_details

#
Sets the users community verifable details, each change will reset all community verifications

Parameters

NameTypeRequiredDefaultDescription
firstName string Yes — First Name of the User
lastName string Yes — Last Name of the User
profession string Yes — Profession of the user
privacySetting string No "do_not_publicly_share" Values can be: do_not_publicly_share, share_name, share_profession, share_name_and_profession
isWritingRequest bool No false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_community_verifiable_details' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'firstName={{firstName}}' \
  --data-urlencode 'lastName={{lastName}}' \
  --data-urlencode 'profession={{profession}}' \
  --data-urlencode 'privacySetting={{privacySetting}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_community_verifiable_details_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payload = true Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_community_verifiable_details",
    "RequestUserAlias": "example-user",
    "Payload": true
}
Machine-readable endpoint documentation
POST

/v1/user/set_delete_address

#
Remove an owned address using POST while retaining its review history. The active payout address must first be replaced.

Parameters

NameTypeRequiredDefaultDescription
addressID int Yes — Owned address ID.
revision int Yes — Current address revision.
isWritingRequest bool No false Explicit write confirmation.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_delete_address' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'addressID={{addressID}}' \
  --data-urlencode 'revision={{revision}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_delete_address_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.userAliasstring Yes
$.oneOf[0].allOf[1].Payload.canEditboolean Yes
$.oneOf[0].allOf[1].Payload.defaultPhonestring Yes
$.oneOf[0].allOf[1].Payload.totalinteger Yes
$.oneOf[0].allOf[1].Payload.primary Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].addressIDinteger Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].reviewIDinteger Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].formattedAddressstring Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].phonestring Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].status = "IdentityConfirmed" Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.addressesarray Yes
$.oneOf[0].allOf[1].Payload.addresses[]object No
$.oneOf[0].allOf[1].Payload.addresses[].idinteger Yes
$.oneOf[0].allOf[1].Payload.addresses[].revisioninteger Yes
$.oneOf[0].allOf[1].Payload.addresses[].labelstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].addressPersonalAddress Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].formatted_addressstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_componentsarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[]object No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].long_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].short_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].typesarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].types[]string No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].source = "google" Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].unitstring No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].formatted_addressstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_componentsarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[]object No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].long_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].short_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].typesarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].types[]string No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].source = "photon" Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].osmobject Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].osm.typestring ["N","W","R"] Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].osm.idstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].coordinatesobject Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].coordinates.latitudenumber Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].coordinates.longitudenumber Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].resultTypestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].schemaVersion = 1 Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].unitstring No
$.oneOf[0].allOf[1].Payload.addresses[].formattedAddressstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].phoneOverride Yes
$.oneOf[0].allOf[1].Payload.addresses[].phoneOverride.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.addresses[].phoneOverride.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.addresses[].phonestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].statusstring ["NotReviewed","SubmittedForReview","Rejected","CancelledByUser","IdentityConfirmed"] Yes
$.oneOf[0].allOf[1].Payload.addresses[].reviewIDinteger Yes
$.oneOf[0].allOf[1].Payload.addresses[].rejectReasonstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].isPrimaryboolean Yes
$.oneOf[0].allOf[1].Payload.addresses[].isActiveSnapshotboolean Yes
$.oneOf[0].allOf[1].Payload.nextStartinteger Yes
$.oneOf[0].allOf[1].Payload.hasMoreboolean Yes
$.oneOf[0].allOf[1].Payload.reviewDefaultsobject No
$.oneOf[0].allOf[1].Payload.reviewDefaults.firstNamestring Yes
$.oneOf[0].allOf[1].Payload.reviewDefaults.lastNamestring Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_delete_address",
    "RequestUserAlias": "example-user",
    "Payload": {
        "userAlias": "synthetic-example",
        "canEdit": false,
        "defaultPhone": "synthetic-example",
        "total": 0,
        "primary": {
            "addressID": 0,
            "reviewID": 0,
            "formattedAddress": "synthetic-example",
            "phone": "synthetic-example",
            "status": "IdentityConfirmed"
        },
        "addresses": [],
        "nextStart": 0,
        "hasMore": false
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_listing_personal_info_prefill

#
Saves the acting user's account-wide personal-information prefill preference for bid fills and listings. Enabled by default. Newly opened forms on every device use the saved value; existing drafts are preserved.

Parameters

NameTypeRequiredDefaultDescription
enabled bool Yes — Whether new forms prefill first name, last name, email and phone.
isWritingRequest bool No false Required true to save.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_listing_personal_info_prefill' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'enabled={{enabled}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_listing_personal_info_prefill_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.enabledboolean Yes
$.oneOf[0].allOf[1].Payload.sellerDefaultsobject Yes
$.oneOf[0].allOf[1].Payload.sellerDefaults.firstNamestring Yes
$.oneOf[0].allOf[1].Payload.sellerDefaults.lastNamestring Yes
$.oneOf[0].allOf[1].Payload.sellerDefaults.emailAddressstring Yes
$.oneOf[0].allOf[1].Payload.sellerDefaults.phoneNumberstring Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_listing_personal_info_prefill",
    "RequestUserAlias": "example-user",
    "Payload": {
        "enabled": false,
        "sellerDefaults": {
            "firstName": "synthetic-example",
            "lastName": "synthetic-example",
            "emailAddress": "synthetic-example",
            "phoneNumber": "synthetic-example"
        }
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_primary_address

#
Explicitly select an owned approved revision for payouts using POST. Other saved addresses never change payout details automatically.

Parameters

NameTypeRequiredDefaultDescription
addressID int Yes — Owned verified address ID.
revision int Yes — Current verified revision.
isWritingRequest bool No false Explicit write confirmation.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_primary_address' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'addressID={{addressID}}' \
  --data-urlencode 'revision={{revision}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_primary_address_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.userAliasstring Yes
$.oneOf[0].allOf[1].Payload.canEditboolean Yes
$.oneOf[0].allOf[1].Payload.defaultPhonestring Yes
$.oneOf[0].allOf[1].Payload.totalinteger Yes
$.oneOf[0].allOf[1].Payload.primary Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].addressIDinteger Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].reviewIDinteger Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].formattedAddressstring Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].phonestring Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].status = "IdentityConfirmed" Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.addressesarray Yes
$.oneOf[0].allOf[1].Payload.addresses[]object No
$.oneOf[0].allOf[1].Payload.addresses[].idinteger Yes
$.oneOf[0].allOf[1].Payload.addresses[].revisioninteger Yes
$.oneOf[0].allOf[1].Payload.addresses[].labelstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].addressPersonalAddress Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].formatted_addressstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_componentsarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[]object No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].long_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].short_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].typesarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].types[]string No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].source = "google" Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].unitstring No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].formatted_addressstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_componentsarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[]object No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].long_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].short_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].typesarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].types[]string No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].source = "photon" Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].osmobject Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].osm.typestring ["N","W","R"] Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].osm.idstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].coordinatesobject Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].coordinates.latitudenumber Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].coordinates.longitudenumber Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].resultTypestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].schemaVersion = 1 Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].unitstring No
$.oneOf[0].allOf[1].Payload.addresses[].formattedAddressstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].phoneOverride Yes
$.oneOf[0].allOf[1].Payload.addresses[].phoneOverride.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.addresses[].phoneOverride.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.addresses[].phonestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].statusstring ["NotReviewed","SubmittedForReview","Rejected","CancelledByUser","IdentityConfirmed"] Yes
$.oneOf[0].allOf[1].Payload.addresses[].reviewIDinteger Yes
$.oneOf[0].allOf[1].Payload.addresses[].rejectReasonstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].isPrimaryboolean Yes
$.oneOf[0].allOf[1].Payload.addresses[].isActiveSnapshotboolean Yes
$.oneOf[0].allOf[1].Payload.nextStartinteger Yes
$.oneOf[0].allOf[1].Payload.hasMoreboolean Yes
$.oneOf[0].allOf[1].Payload.reviewDefaultsobject No
$.oneOf[0].allOf[1].Payload.reviewDefaults.firstNamestring Yes
$.oneOf[0].allOf[1].Payload.reviewDefaults.lastNamestring Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_primary_address",
    "RequestUserAlias": "example-user",
    "Payload": {
        "userAlias": "synthetic-example",
        "canEdit": false,
        "defaultPhone": "synthetic-example",
        "total": 0,
        "primary": {
            "addressID": 0,
            "reviewID": 0,
            "formattedAddress": "synthetic-example",
            "phone": "synthetic-example",
            "status": "IdentityConfirmed"
        },
        "addresses": [],
        "nextStart": 0,
        "hasMore": false
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_profile_about_post

#
Sets or clears the current user's profile/About Me community post and optional image selections from that post's attached media.

Parameters

NameTypeRequiredDefaultDescription
postID int No 0 Public ATDiscussionPosts.ID with at least two attached images to use as the profile post. Pass 0 to clear.
profileImageMediaID int No 0 Attached image ATMedia.ID to use as the profile picture. Pass 0 for emoji-only fallback.
bannerImageMediaID int No 0 Attached image ATMedia.ID to use as the profile banner. Pass 0 for no banner.
profileImagePositionXPercent int No 50 Profile image horizontal framing position, 0-100.
profileImagePositionYPercent int No 50 Profile image vertical framing position, 0-100.
profileImageZoomPercent int No 100 Profile image zoom percentage, 100-300.
bannerImagePositionXPercent int No 50 Banner image horizontal framing position, 0-100.
bannerImagePositionYPercent int No 50 Banner image vertical framing position, 0-100.
bannerImageZoomPercent int No 100 Banner image zoom percentage, 100-300.
updatePostTitle int No 0 Pass 1 to update the selected post title when saving the profile intro.
postTitle string No "" Replacement selected-post title. Only the post author can change it.
isWritingRequest bool No false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_profile_about_post' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'postID={{postID}}' \
  --data-urlencode 'profileImageMediaID={{profileImageMediaID}}' \
  --data-urlencode 'bannerImageMediaID={{bannerImageMediaID}}' \
  --data-urlencode 'profileImagePositionXPercent={{profileImagePositionXPercent}}' \
  --data-urlencode 'profileImagePositionYPercent={{profileImagePositionYPercent}}' \
  --data-urlencode 'profileImageZoomPercent={{profileImageZoomPercent}}' \
  --data-urlencode 'bannerImagePositionXPercent={{bannerImagePositionXPercent}}' \
  --data-urlencode 'bannerImagePositionYPercent={{bannerImagePositionYPercent}}' \
  --data-urlencode 'bannerImageZoomPercent={{bannerImageZoomPercent}}' \
  --data-urlencode 'updatePostTitle={{updatePostTitle}}' \
  --data-urlencode 'postTitle={{postTitle}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_profile_about_post_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.aboutPost Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].bodyPreviewstring Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].urlstring Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].authorobject Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].author.idinteger Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].author.aliasstring Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].author.avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].author.profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].boardobject Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].board.idinteger Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].board.namestring Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].board.slugstring Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].board.typestring Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].imageMediaCountinteger Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].mediaarray Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].media[]object No
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].media[].idinteger Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].media[].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].media[].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].media[].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].media[].widthinteger Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].media[].heightinteger Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].media[].titlestring Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].media[].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].media[].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].selectedProfileImageMediaIDinteger Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].selectedBannerImageMediaIDinteger Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].selectedProfileImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].selectedProfileImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].selectedProfileImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].selectedProfileImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].selectedBannerImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].selectedBannerImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].selectedBannerImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[0].selectedBannerImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.aboutPost.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.profileImageMedia Yes
$.oneOf[0].allOf[1].Payload.profileImageMedia.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.profileImageMedia.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.profileImageMedia.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.profileImageMedia.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.profileImageMedia.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.profileImageMedia.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.profileImageMedia.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.profileImageMedia.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.profileImageMedia.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.profileImageMedia.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.profileImageMedia.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.profileImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.profileImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.profileImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.profileImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.bannerImageMedia Yes
$.oneOf[0].allOf[1].Payload.bannerImageMedia.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.bannerImageMedia.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.bannerImageMedia.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.bannerImageMedia.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.bannerImageMedia.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.bannerImageMedia.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.bannerImageMedia.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.bannerImageMedia.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.bannerImageMedia.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.bannerImageMedia.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.bannerImageMedia.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.bannerImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.bannerImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.bannerImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.bannerImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.postIDinteger Yes
$.oneOf[0].allOf[1].Payload.profileUseCountinteger Yes
$.oneOf[0].allOf[1].Payload.previousPostIDinteger Yes
$.oneOf[0].allOf[1].Payload.previousProfileUseCount Yes
$.oneOf[0].allOf[1].Payload.previousProfileUseCount.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.previousProfileUseCount.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setupProfileSetup NoCurrent setup state. get_profile_setup reads without marking completion; the setup embedded in successful writes can synchronize stored completion.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].isLoggedIn = true Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].hasDisplayableOpenItemsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].requiresOnboardingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].collapsedByDefaultboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].profileIntentstring ["","buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptionsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].valuestring ["buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].spritestring ["buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].flowIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].usesFlowCopy = true Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].citySlugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].regionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].countrystring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].cityGroupCodestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].iconstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].imageBasePathstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].sourcestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].isSavedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].isRecommendedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].distanceMetersinteger No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestionsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].citySlugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].regionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].countrystring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].cityGroupCodestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].iconstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].imageBasePathstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].sourcestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].isSavedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].isRecommendedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].distanceMetersinteger No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].followCountsobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].followCounts.userFollowCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].followCounts.boardFollowCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestionsobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.usersarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].avatarstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileIntentstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].recommendationTypestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].communityVerificationStatusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].followerCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].publicPostCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].isViewerFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].isProfileSetupFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].hasAboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boardsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].urlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].boardIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].followerCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].recentPostCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].isViewerFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].isProfileSetupFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].hasAboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locationsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].locationAliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].stateShortstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].countryShortstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].categoryDescriptorstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].categoryIconstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].localRankinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].rankinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].userTradesinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].bidsLast30Dayinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].isViewerFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].homebaseCitySlugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].renderTypestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].stepKeystring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].hasParametersboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].includeUsersboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].includeBoardsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].includeLocationsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].isTrendingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].profileIntentstring ["","buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completionobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.requiredCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.presentedCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.presentedUserCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.presentedBoardCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.presentedLocationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.followedCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.followedUserCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.followedBoardCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.followedLocationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].isWaitingForMinimumContextboolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].missingContextKeysarray No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].missingContextKeys[]string ["profileIntent","homebase"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[1].isConfigured = false Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenuesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].partnerAccountNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].rolestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].sourcestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].partnerAccountID Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].partnerAccountID.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].partnerAccountID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaimsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].statusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].chatURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].requestIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].chatIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationStatusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationChatIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationChatURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationUnreadCount Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].sidebarStatus Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[0]string ["answer-required","pending"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].hasManagedVenuePathboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].schemaobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].schema.readyboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].schema.missingTablesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].schema.missingTables[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenuesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].rolestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].sourcestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountID Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountID.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaimsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].statusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].chatURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].requestIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].chatIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationStatusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationChatIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationChatURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationUnreadCount Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].sidebarStatus Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[0]string ["answer-required","pending"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].hasManagedVenuePathboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenuesURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPostobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.postIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.hasAboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].bodyPreviewstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].urlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].authorAboutPostAuthor Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].idnull Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].aliasnull Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].avatarEmojinull Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].profileUrlnull Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].identityHidden = true Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].identityHiddenUntilinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].boardobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].board.idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].board.namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].board.slugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].board.typestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].imageMediaCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].mediaarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].widthinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].heightinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].titlestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoardIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].boardIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].countinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].slugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].citystring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].cityGroupCodestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].intentstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].callbackstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].unitLabelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].routingDescriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].createsRegularBoardPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].isDefaultRequestBoardboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].isDefaultListingBoardboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].routingEnabledboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].selectedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircleobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.statusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.positiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.netPositiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.requiredNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.remainingNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verifierCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.hasTrustSignalboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].userobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.avatarstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.communityVerificationStatusstring ["Unverified","Verified"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.communityVerificationCountFormattedstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.firstNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.lastNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.professionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.privacySettingstring ["do_not_publicly_share","share_name","share_profession","share_name_and_profession"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verificationobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.sharePathstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.shareURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.requiredNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.remainingNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.positiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.negativeVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.netPositiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.verifierCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].privacyOptionsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].privacyOptions[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].privacyOptions[].valuestring ["do_not_publicly_share","share_name","share_profession","share_name_and_profession"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].privacyOptions[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiersarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verificationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].createdDateFormattedstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].messagestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].isPositiveVerificationboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifierobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.avatarstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.communityVerificationStatusstring ["","Unverified","Verified"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.communityVerificationCountFormattedstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.importancePointsFormattedstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completionobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.intentboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.homebaseboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.interestsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.managedVenueboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.aboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.innerCircleboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flowobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.flowIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.sourcestring ["intent-only","active","fallback","status"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.intentTypestring ["","buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actionsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].renderTypestring ["intent_picker","homebase_picker","follow_recommendations","about_me_post","managed_venue_claim","verification_invites"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].orderinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayOrderinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].headlinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parametersOnboardingParameters YesDecoded ActionParametersJSON. Empty or invalid configuration is serialized as []; objects and JSON lists are preserved.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].intentSourcestring No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].Homebasestring No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].homebasestring No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].homebaseSourcestring No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAsarray No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtasarray No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctasarray No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parametersJSONstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].completeboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].completeForProgressboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].visibleboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].lockedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].hasDisplayConditionboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionSatisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].hasGateboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventSatisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionCallbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.callbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.deferredUntilGateSatisfiedboolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.reasonstring ["missing_user","unknown_callback"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.activePendingBidCountinteger No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventMatchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventHeadlinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventDescriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAs[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAs[].stylestring ["primary","secondary"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAs[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAs[].javascriptstring YesConfigured client action code. Documentation treats this as text and never executes it.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.matchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventCounts Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventCounts.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventCounts.anyOf[0].*integer No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventCounts.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.matchedEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.matchedEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].adminNotesstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.stepKeysarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.stepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.visibleStepKeysarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.visibleStepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].targetActionobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].targetAction.actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].targetAction.stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].headlinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctasarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctas[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctas[].stylestring ["primary","secondary"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctas[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctas[].javascriptstring YesConfigured client action code. Documentation treats this as text and never executes it.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventMatchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.matchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts.anyOf[0].*integer No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.matchedEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.matchedEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGatesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].targetActionobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].targetAction.actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].targetAction.stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].headlinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctasarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctas[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctas[].stylestring ["primary","secondary"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctas[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctas[].javascriptstring YesConfigured client action code. Documentation treats this as text and never executes it.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventMatchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.matchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts.anyOf[0].*integer No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.matchedEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.matchedEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].acknowledgeAfterStepKeysarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].acknowledgeAfterStepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventSatisfied = true Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionCallbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.callbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.deferredUntilGateSatisfiedboolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.reasonstring ["missing_user","unknown_callback"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.activePendingBidCountinteger No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.hasDisplayableOpenItemsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.progressobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.progress.completedinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.progress.totalinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.progress.isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpointsobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.refreshstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.setIntentstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.cityOptionsstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.setHomebasestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.setFollowsstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.partnerLocationOptionsstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.partnerSetClaimstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.managedVenuesstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.verificationCenterstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].renderedFragments No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].renderedFragments.anyOf[0]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].renderedFragments.anyOf[0].verificationCenterstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].renderedFragments.anyOf[1]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[1]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[1].isLoggedIn = false Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_profile_about_post",
    "RequestUserAlias": "example-user",
    "Payload": {
        "aboutPost": {
            "id": 0,
            "title": "synthetic-example",
            "bodyPreview": "synthetic-example",
            "url": "synthetic-example",
            "createdDate": "synthetic-example",
            "author": {
                "id": 0,
                "alias": "synthetic-example",
                "avatarEmoji": "synthetic-example",
                "profileUrl": "synthetic-example"
            },
            "board": {
                "id": 0,
                "name": "synthetic-example",
                "slug": "synthetic-example",
                "type": "synthetic-example"
            },
            "imageMediaCount": 0,
            "media": [],
            "selectedProfileImageMediaID": 0,
            "selectedBannerImageMediaID": 0,
            "selectedProfileImageFrame": {
                "positionXPercent": 0,
                "positionYPercent": 0,
                "zoomPercent": 100
            },
            "selectedBannerImageFrame": {
                "positionXPercent": 0,
                "positionYPercent": 0,
                "zoomPercent": 100
            }
        },
        "profileImageMedia": {
            "id": 0,
            "thumbUrl": "synthetic-example",
            "mediaUrl": "synthetic-example",
            "mediaType": "synthetic-example",
            "width": 0,
            "height": 0,
            "title": "synthetic-example",
            "isImage": false,
            "isEmbedded": false
        },
        "profileImageFrame": {
            "positionXPercent": 0,
            "positionYPercent": 0,
            "zoomPercent": 100
        },
        "bannerImageMedia": {
            "id": 0,
            "thumbUrl": "synthetic-example",
            "mediaUrl": "synthetic-example",
            "mediaType": "synthetic-example",
            "width": 0,
            "height": 0,
            "title": "synthetic-example",
            "isImage": false,
            "isEmbedded": false
        },
        "bannerImageFrame": {
            "positionXPercent": 0,
            "positionYPercent": 0,
            "zoomPercent": 100
        },
        "postID": 0,
        "profileUseCount": 0,
        "previousPostID": 0,
        "previousProfileUseCount": 0
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_profile_chat_settings

#
Updates whether the current user's profile accepts new low-friction chat requests. Existing marketplace-required chats and transaction/support chats are not disabled by this setting.

Parameters

NameTypeRequiredDefaultDescription
allowChatRequests bool No true True to allow new profile chat requests.
isWritingRequest bool No false Required true to save.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_profile_chat_settings' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'allowChatRequests={{allowChatRequests}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_profile_chat_settings_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.allowChatRequestsboolean Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_profile_chat_settings",
    "RequestUserAlias": "example-user",
    "Payload": {
        "allowChatRequests": false
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_profile_homebase

#
Saves the acting user's profile setup homebase city.

Parameters

NameTypeRequiredDefaultDescription
citySlug string No "" ATAirport MunicipalitySlug to save.
isWritingRequest bool No false Required true to save.
includeSetup bool No true Include refreshed profile setup state.
onlyIfUnset bool No false Preserve an existing homebase; use true for composer sign-in continuation.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_profile_homebase' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'citySlug={{citySlug}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}' \
  --data-urlencode 'includeSetup={{includeSetup}}' \
  --data-urlencode 'onlyIfUnset={{onlyIfUnset}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_profile_homebase_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.homebase Yes
$.oneOf[0].allOf[1].Payload.homebase.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.homebase.anyOf[0].citySlugstring Yes
$.oneOf[0].allOf[1].Payload.homebase.anyOf[0].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.homebase.anyOf[0].regionstring Yes
$.oneOf[0].allOf[1].Payload.homebase.anyOf[0].countrystring Yes
$.oneOf[0].allOf[1].Payload.homebase.anyOf[0].cityGroupCodestring Yes
$.oneOf[0].allOf[1].Payload.homebase.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.homebase.anyOf[0].iconstring Yes
$.oneOf[0].allOf[1].Payload.homebase.anyOf[0].imageBasePathstring Yes
$.oneOf[0].allOf[1].Payload.homebase.anyOf[0].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.homebase.anyOf[0].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.homebase.anyOf[0].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.homebase.anyOf[0].sourcestring Yes
$.oneOf[0].allOf[1].Payload.homebase.anyOf[0].isSavedboolean Yes
$.oneOf[0].allOf[1].Payload.homebase.anyOf[0].isRecommendedboolean Yes
$.oneOf[0].allOf[1].Payload.homebase.anyOf[0].distanceMetersinteger No
$.oneOf[0].allOf[1].Payload.homebase.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setupProfileSetup NoCurrent setup state. get_profile_setup reads without marking completion; the setup embedded in successful writes can synchronize stored completion.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].isLoggedIn = true Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].hasDisplayableOpenItemsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].requiresOnboardingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].collapsedByDefaultboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].profileIntentstring ["","buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptionsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].valuestring ["buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].spritestring ["buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].flowIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].usesFlowCopy = true Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].citySlugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].regionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].countrystring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].cityGroupCodestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].iconstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].imageBasePathstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].sourcestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].isSavedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].isRecommendedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].distanceMetersinteger No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestionsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].citySlugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].regionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].countrystring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].cityGroupCodestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].iconstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].imageBasePathstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].sourcestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].isSavedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].isRecommendedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].distanceMetersinteger No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].followCountsobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].followCounts.userFollowCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].followCounts.boardFollowCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestionsobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.usersarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].avatarstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileIntentstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].recommendationTypestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].communityVerificationStatusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].followerCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].publicPostCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].isViewerFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].isProfileSetupFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].hasAboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boardsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].urlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].boardIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].followerCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].recentPostCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].isViewerFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].isProfileSetupFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].hasAboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locationsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].locationAliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].stateShortstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].countryShortstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].categoryDescriptorstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].categoryIconstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].localRankinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].rankinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].userTradesinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].bidsLast30Dayinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].isViewerFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].homebaseCitySlugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].renderTypestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].stepKeystring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].hasParametersboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].includeUsersboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].includeBoardsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].includeLocationsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].isTrendingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].profileIntentstring ["","buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completionobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.requiredCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.presentedCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.presentedUserCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.presentedBoardCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.presentedLocationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.followedCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.followedUserCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.followedBoardCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.followedLocationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].isWaitingForMinimumContextboolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].missingContextKeysarray No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].missingContextKeys[]string ["profileIntent","homebase"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[1].isConfigured = false Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenuesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].partnerAccountNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].rolestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].sourcestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].partnerAccountID Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].partnerAccountID.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].partnerAccountID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaimsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].statusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].chatURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].requestIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].chatIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationStatusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationChatIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationChatURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationUnreadCount Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].sidebarStatus Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[0]string ["answer-required","pending"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].hasManagedVenuePathboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].schemaobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].schema.readyboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].schema.missingTablesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].schema.missingTables[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenuesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].rolestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].sourcestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountID Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountID.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaimsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].statusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].chatURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].requestIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].chatIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationStatusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationChatIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationChatURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationUnreadCount Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].sidebarStatus Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[0]string ["answer-required","pending"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].hasManagedVenuePathboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenuesURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPostobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.postIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.hasAboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].bodyPreviewstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].urlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].authorAboutPostAuthor Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].idnull Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].aliasnull Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].avatarEmojinull Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].profileUrlnull Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].identityHidden = true Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].identityHiddenUntilinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].boardobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].board.idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].board.namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].board.slugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].board.typestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].imageMediaCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].mediaarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].widthinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].heightinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].titlestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoardIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].boardIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].countinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].slugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].citystring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].cityGroupCodestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].intentstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].callbackstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].unitLabelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].routingDescriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].createsRegularBoardPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].isDefaultRequestBoardboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].isDefaultListingBoardboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].routingEnabledboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].selectedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircleobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.statusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.positiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.netPositiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.requiredNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.remainingNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verifierCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.hasTrustSignalboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].userobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.avatarstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.communityVerificationStatusstring ["Unverified","Verified"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.communityVerificationCountFormattedstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.firstNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.lastNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.professionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.privacySettingstring ["do_not_publicly_share","share_name","share_profession","share_name_and_profession"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verificationobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.sharePathstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.shareURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.requiredNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.remainingNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.positiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.negativeVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.netPositiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.verifierCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].privacyOptionsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].privacyOptions[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].privacyOptions[].valuestring ["do_not_publicly_share","share_name","share_profession","share_name_and_profession"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].privacyOptions[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiersarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verificationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].createdDateFormattedstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].messagestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].isPositiveVerificationboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifierobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.avatarstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.communityVerificationStatusstring ["","Unverified","Verified"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.communityVerificationCountFormattedstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.importancePointsFormattedstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completionobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.intentboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.homebaseboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.interestsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.managedVenueboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.aboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.innerCircleboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flowobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.flowIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.sourcestring ["intent-only","active","fallback","status"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.intentTypestring ["","buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actionsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].renderTypestring ["intent_picker","homebase_picker","follow_recommendations","about_me_post","managed_venue_claim","verification_invites"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].orderinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayOrderinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].headlinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parametersOnboardingParameters YesDecoded ActionParametersJSON. Empty or invalid configuration is serialized as []; objects and JSON lists are preserved.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].intentSourcestring No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].Homebasestring No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].homebasestring No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].homebaseSourcestring No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAsarray No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtasarray No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctasarray No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parametersJSONstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].completeboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].completeForProgressboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].visibleboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].lockedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].hasDisplayConditionboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionSatisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].hasGateboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventSatisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionCallbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.callbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.deferredUntilGateSatisfiedboolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.reasonstring ["missing_user","unknown_callback"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.activePendingBidCountinteger No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventMatchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventHeadlinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventDescriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAs[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAs[].stylestring ["primary","secondary"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAs[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAs[].javascriptstring YesConfigured client action code. Documentation treats this as text and never executes it.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.matchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventCounts Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventCounts.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventCounts.anyOf[0].*integer No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventCounts.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.matchedEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.matchedEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].adminNotesstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.stepKeysarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.stepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.visibleStepKeysarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.visibleStepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].targetActionobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].targetAction.actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].targetAction.stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].headlinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctasarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctas[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctas[].stylestring ["primary","secondary"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctas[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctas[].javascriptstring YesConfigured client action code. Documentation treats this as text and never executes it.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventMatchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.matchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts.anyOf[0].*integer No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.matchedEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.matchedEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGatesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].targetActionobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].targetAction.actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].targetAction.stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].headlinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctasarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctas[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctas[].stylestring ["primary","secondary"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctas[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctas[].javascriptstring YesConfigured client action code. Documentation treats this as text and never executes it.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventMatchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.matchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts.anyOf[0].*integer No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.matchedEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.matchedEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].acknowledgeAfterStepKeysarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].acknowledgeAfterStepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventSatisfied = true Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionCallbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.callbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.deferredUntilGateSatisfiedboolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.reasonstring ["missing_user","unknown_callback"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.activePendingBidCountinteger No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.hasDisplayableOpenItemsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.progressobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.progress.completedinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.progress.totalinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.progress.isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpointsobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.refreshstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.setIntentstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.cityOptionsstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.setHomebasestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.setFollowsstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.partnerLocationOptionsstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.partnerSetClaimstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.managedVenuesstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.verificationCenterstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].renderedFragments No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].renderedFragments.anyOf[0]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].renderedFragments.anyOf[0].verificationCenterstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].renderedFragments.anyOf[1]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[1]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[1].isLoggedIn = false Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_profile_homebase",
    "RequestUserAlias": "example-user",
    "Payload": {
        "homebase": {
            "citySlug": "synthetic-example",
            "cityName": "synthetic-example",
            "region": "synthetic-example",
            "country": "synthetic-example",
            "cityGroupCode": "synthetic-example",
            "label": "synthetic-example",
            "icon": "synthetic-example",
            "imageBasePath": "synthetic-example",
            "imageURL256": "synthetic-example",
            "imageURL512": "synthetic-example",
            "bannerImageURL": "synthetic-example",
            "source": "synthetic-example",
            "isSaved": false,
            "isRecommended": false
        }
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_profile_intent

#
Updates the current user's profile intent. With onlyIfUnset=true, an existing preference is preserved and returned without intent-related follow changes.

Parameters

NameTypeRequiredDefaultDescription
profileIntent string No "sell" One of buy, sell, socialize, or location-partner.
isWritingRequest bool No false Required true to save.
onlyIfUnset bool No false Preserve an existing intent; use true for sign-in presets.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_profile_intent' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'profileIntent={{profileIntent}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}' \
  --data-urlencode 'onlyIfUnset={{onlyIfUnset}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_profile_intent_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.profileIntentstring ["buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.isBuyerProfileboolean Yes
$.oneOf[0].allOf[1].Payload.isSellerProfileboolean Yes
$.oneOf[0].allOf[1].Payload.isSocialProfileboolean Yes
$.oneOf[0].allOf[1].Payload.isLocationPartnerProfileboolean Yes
$.oneOf[0].allOf[1].Payload.setupProfileSetup YesCurrent setup state. get_profile_setup reads without marking completion; the setup embedded in successful writes can synchronize stored completion.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].isLoggedIn = true Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].hasDisplayableOpenItemsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].requiresOnboardingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].collapsedByDefaultboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].profileIntentstring ["","buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptionsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].valuestring ["buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].spritestring ["buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].flowIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].usesFlowCopy = true Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].citySlugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].regionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].countrystring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].cityGroupCodestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].iconstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].imageBasePathstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].sourcestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].isSavedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].isRecommendedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].distanceMetersinteger No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestionsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].citySlugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].regionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].countrystring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].cityGroupCodestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].iconstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].imageBasePathstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].sourcestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].isSavedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].isRecommendedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].distanceMetersinteger No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].followCountsobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].followCounts.userFollowCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].followCounts.boardFollowCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestionsobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.usersarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].avatarstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileIntentstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].recommendationTypestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].communityVerificationStatusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].followerCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].publicPostCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].isViewerFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].isProfileSetupFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].hasAboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boardsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].urlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].boardIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].followerCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].recentPostCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].isViewerFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].isProfileSetupFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].hasAboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locationsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].locationAliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].stateShortstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].countryShortstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].categoryDescriptorstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].categoryIconstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].localRankinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].rankinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].userTradesinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].bidsLast30Dayinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].isViewerFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].homebaseCitySlugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].renderTypestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].stepKeystring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].hasParametersboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].includeUsersboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].includeBoardsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].includeLocationsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].isTrendingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].profileIntentstring ["","buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completionobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.requiredCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.presentedCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.presentedUserCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.presentedBoardCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.presentedLocationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.followedCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.followedUserCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.followedBoardCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.followedLocationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].isWaitingForMinimumContextboolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].missingContextKeysarray No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].missingContextKeys[]string ["profileIntent","homebase"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[1].isConfigured = false Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenuesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].partnerAccountNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].rolestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].sourcestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].partnerAccountID Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].partnerAccountID.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].partnerAccountID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaimsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].statusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].chatURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].requestIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].chatIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationStatusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationChatIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationChatURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationUnreadCount Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].sidebarStatus Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[0]string ["answer-required","pending"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].hasManagedVenuePathboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].schemaobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].schema.readyboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].schema.missingTablesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].schema.missingTables[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenuesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].rolestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].sourcestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountID Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountID.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaimsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].statusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].chatURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].requestIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].chatIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationStatusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationChatIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationChatURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationUnreadCount Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].sidebarStatus Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[0]string ["answer-required","pending"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].hasManagedVenuePathboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenuesURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPostobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.postIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.hasAboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].bodyPreviewstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].urlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].authorAboutPostAuthor Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].idnull Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].aliasnull Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].avatarEmojinull Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].profileUrlnull Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].identityHidden = true Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].identityHiddenUntilinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].boardobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].board.idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].board.namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].board.slugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].board.typestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].imageMediaCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].mediaarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].widthinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].heightinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].titlestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoardIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].boardIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].countinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].slugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].citystring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].cityGroupCodestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].intentstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].callbackstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].unitLabelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].routingDescriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].createsRegularBoardPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].isDefaultRequestBoardboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].isDefaultListingBoardboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].routingEnabledboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].selectedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircleobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.statusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.positiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.netPositiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.requiredNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.remainingNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verifierCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.hasTrustSignalboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].userobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.avatarstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.communityVerificationStatusstring ["Unverified","Verified"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.communityVerificationCountFormattedstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.firstNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.lastNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.professionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.privacySettingstring ["do_not_publicly_share","share_name","share_profession","share_name_and_profession"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verificationobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.sharePathstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.shareURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.requiredNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.remainingNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.positiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.negativeVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.netPositiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.verifierCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].privacyOptionsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].privacyOptions[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].privacyOptions[].valuestring ["do_not_publicly_share","share_name","share_profession","share_name_and_profession"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].privacyOptions[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiersarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verificationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].createdDateFormattedstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].messagestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].isPositiveVerificationboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifierobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.avatarstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.communityVerificationStatusstring ["","Unverified","Verified"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.communityVerificationCountFormattedstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.importancePointsFormattedstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completionobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.intentboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.homebaseboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.interestsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.managedVenueboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.aboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.innerCircleboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flowobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.flowIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.sourcestring ["intent-only","active","fallback","status"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.intentTypestring ["","buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actionsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].renderTypestring ["intent_picker","homebase_picker","follow_recommendations","about_me_post","managed_venue_claim","verification_invites"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].orderinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayOrderinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].headlinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parametersOnboardingParameters YesDecoded ActionParametersJSON. Empty or invalid configuration is serialized as []; objects and JSON lists are preserved.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].intentSourcestring No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].Homebasestring No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].homebasestring No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].homebaseSourcestring No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAsarray No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtasarray No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctasarray No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parametersJSONstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].completeboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].completeForProgressboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].visibleboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].lockedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].hasDisplayConditionboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionSatisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].hasGateboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventSatisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionCallbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.callbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.deferredUntilGateSatisfiedboolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.reasonstring ["missing_user","unknown_callback"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.activePendingBidCountinteger No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventMatchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventHeadlinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventDescriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAs[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAs[].stylestring ["primary","secondary"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAs[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAs[].javascriptstring YesConfigured client action code. Documentation treats this as text and never executes it.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.matchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventCounts Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventCounts.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventCounts.anyOf[0].*integer No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventCounts.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.matchedEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.matchedEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].adminNotesstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.stepKeysarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.stepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.visibleStepKeysarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.visibleStepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].targetActionobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].targetAction.actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].targetAction.stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].headlinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctasarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctas[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctas[].stylestring ["primary","secondary"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctas[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctas[].javascriptstring YesConfigured client action code. Documentation treats this as text and never executes it.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventMatchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.matchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts.anyOf[0].*integer No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.matchedEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.matchedEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGatesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].targetActionobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].targetAction.actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].targetAction.stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].headlinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctasarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctas[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctas[].stylestring ["primary","secondary"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctas[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctas[].javascriptstring YesConfigured client action code. Documentation treats this as text and never executes it.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventMatchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.matchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts.anyOf[0].*integer No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.matchedEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.matchedEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].acknowledgeAfterStepKeysarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].acknowledgeAfterStepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventSatisfied = true Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionCallbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.callbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.deferredUntilGateSatisfiedboolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.reasonstring ["missing_user","unknown_callback"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.activePendingBidCountinteger No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.hasDisplayableOpenItemsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.progressobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.progress.completedinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.progress.totalinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.progress.isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpointsobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.refreshstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.setIntentstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.cityOptionsstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.setHomebasestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.setFollowsstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.partnerLocationOptionsstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.partnerSetClaimstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.managedVenuesstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.verificationCenterstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].renderedFragments No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].renderedFragments.anyOf[0]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].renderedFragments.anyOf[0].verificationCenterstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].renderedFragments.anyOf[1]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[1].isLoggedIn = false Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_profile_intent",
    "RequestUserAlias": "example-user",
    "Payload": {
        "profileIntent": "buy",
        "isBuyerProfile": false,
        "isSellerProfile": false,
        "isSocialProfile": false,
        "isLocationPartnerProfile": false,
        "setup": {
            "isLoggedIn": true,
            "isComplete": false,
            "hasDisplayableOpenItems": false,
            "requiresOnboarding": false,
            "collapsedByDefault": false,
            "profileIntent": "",
            "intentOptions": [],
            "homebase": {
                "citySlug": "synthetic-example",
                "cityName": "synthetic-example",
                "region": "synthetic-example",
                "country": "synthetic-example",
                "cityGroupCode": "synthetic-example",
                "label": "synthetic-example",
                "icon": "synthetic-example",
                "imageBasePath": "synthetic-example",
                "imageURL256": "synthetic-example",
                "imageURL512": "synthetic-example",
                "bannerImageURL": "synthetic-example",
                "source": "synthetic-example",
                "isSaved": false,
                "isRecommended": false
            },
            "homebaseSuggestions": [],
            "followCounts": {
                "userFollowCount": 0,
                "boardFollowCount": 0
            },
            "suggestions": {
                "users": [],
                "boards": [],
                "locations": [],
                "context": {
                    "homebaseCitySlug": "synthetic-example",
                    "renderType": "synthetic-example",
                    "stepKey": "synthetic-example",
                    "hasParameters": false,
                    "includeUsers": false,
                    "includeBoards": false,
                    "includeLocations": false,
                    "isTrending": false,
                    "profileIntent": "",
                    "completion": {
                        "requiredCount": 0,
                        "presentedCount": 0,
                        "presentedUserCount": 0,
                        "presentedBoardCount": 0,
                        "presentedLocationCount": 0,
                        "followedCount": 0,
                        "followedUserCount": 0,
                        "followedBoardCount": 0,
                        "followedLocationCount": 0,
                        "isComplete": false
                    }
                }
            },
            "managedVenues": [],
            "pendingVenueClaims": [],
            "hasManagedVenuePath": false,
            "managedVenueState": {
                "schema": {
                    "ready": false,
                    "missingTables": []
                },
                "managedVenues": [],
                "pendingVenueClaims": [],
                "hasManagedVenuePath": false,
                "managedVenuesURL": "synthetic-example"
            },
            "aboutPost": {
                "postID": 0,
                "hasAboutPost": false,
                "post": {
                    "id": 0,
                    "title": "synthetic-example",
                    "bodyPreview": "synthetic-example",
                    "url": "synthetic-example",
                    "createdDate": "synthetic-example",
                    "author": {
                        "id": 0,
                        "alias": "synthetic-example",
                        "avatarEmoji": "synthetic-example",
                        "profileUrl": "synthetic-example"
                    },
                    "board": {
                        "id": 0,
                        "name": "synthetic-example",
                        "slug": "synthetic-example",
                        "type": "synthetic-example"
                    },
                    "imageMediaCount": 0,
                    "media": []
                },
                "wallBoardID": 0,
                "wallBoard": {
                    "id": 0,
                    "boardID": 0,
                    "count": 0,
                    "slug": "synthetic-example",
                    "name": "synthetic-example",
                    "city": "synthetic-example",
                    "cityGroupCode": "synthetic-example",
                    "intent": "synthetic-example",
                    "callback": "synthetic-example",
                    "unitLabel": "synthetic-example",
                    "routingDescription": "synthetic-example",
                    "createsRegularBoardPost": false,
                    "isDefaultRequestBoard": false,
                    "isDefaultListingBoard": false,
                    "routingEnabled": false,
                    "selected": false
                }
            },
            "innerCircle": {
                "status": "synthetic-example",
                "positiveVerificationCount": 0,
                "netPositiveVerificationCount": 0,
                "requiredNetPositiveVerifications": 0,
                "remainingNetPositiveVerifications": 0,
                "verifierCount": 0,
                "hasTrustSignal": false,
                "verification": {
                    "user": {
                        "userID": 0,
                        "alias": "synthetic-example",
                        "avatar": "synthetic-example",
                        "profileURL": "synthetic-example",
                        "communityVerificationStatus": "Unverified",
                        "communityVerificationCount": 0,
                        "communityVerificationCountFormatted": "synthetic-example",
                        "firstName": "synthetic-example",
                        "lastName": "synthetic-example",
                        "profession": "synthetic-example",
                        "privacySetting": "do_not_publicly_share"
                    },
                    "verification": {
                        "sharePath": "synthetic-example",
                        "shareURL": "synthetic-example",
                        "requiredNetPositiveVerifications": 0,
                        "remainingNetPositiveVerifications": 0,
                        "positiveVerificationCount": 0,
                        "negativeVerificationCount": 0,
                        "netPositiveVerificationCount": 0,
                        "verifierCount": 0
                    },
                    "privacyOptions": [],
                    "verifiers": []
                }
            },
            "completion": {
                "intent": false,
                "homebase": false,
                "interests": false,
                "managedVenue": false,
                "aboutPost": false,
                "innerCircle": false
            },
            "flow": {
                "flowID": 0,
                "source": "intent-only",
                "intentType": "",
                "name": "synthetic-example",
                "description": "synthetic-example",
                "actions": [],
                "stepKeys": [],
                "visibleStepKeys": [],
                "currentGate": {
                    "actionKey": "SELECT_INTENT",
                    "stepKey": "intent",
                    "targetAction": {
                        "actionKey": "SELECT_INTENT",
                        "stepKey": "intent"
                    },
                    "headline": "synthetic-example",
                    "description": "synthetic-example",
                    "ctas": [],
                    "requiredEventNames": [],
                    "requiredEventMatchMode": "Any",
                    "requiredEventStatus": {
                        "satisfied": false,
                        "eventNames": [],
                        "matchMode": "Any",
                        "eventCounts": [],
                        "matchedEventNames": []
                    }
                },
                "acknowledgementGates": [],
                "displayConditionSuppressedAction": {
                    "actionKey": "SELECT_INTENT",
                    "stepKey": "intent",
                    "displayConditionCallback": "",
                    "displayConditionStatus": {
                        "callback": "",
                        "satisfied": false
                    }
                },
                "hasDisplayableOpenItems": false,
                "progress": {
                    "completed": 0,
                    "total": 0,
                    "isComplete": false
                },
                "isComplete": false
            },
            "endpoints": {
                "refresh": "synthetic-example",
                "setIntent": "synthetic-example",
                "cityOptions": "synthetic-example",
                "setHomebase": "synthetic-example",
                "setFollows": "synthetic-example",
                "partnerLocationOptions": "synthetic-example",
                "partnerSetClaim": "synthetic-example",
                "managedVenues": "synthetic-example",
                "verificationCenter": "synthetic-example"
            }
        }
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_profile_setup_follows

#
Follows or unfollows profile setup users, boards, and locations, with the same location-follow mutation as location/set_follow.

Parameters

NameTypeRequiredDefaultDescription
profileIntent string No "" Current setup intent.
userAliases string No "" Comma separated user aliases to follow.
boardIDs string No "" Comma separated board ids to follow.
locationIDs string No "" Legacy explicit venue ids for derived board follows.
followLocationIDs string No "" Comma separated location ids to follow or explicitly unfollow. Saves are additive; omitted locations are unchanged.
action string No "follow" Either follow or unfollow.
isWritingRequest bool No false Required true to save.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_profile_setup_follows' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'profileIntent={{profileIntent}}' \
  --data-urlencode 'userAliases={{userAliases}}' \
  --data-urlencode 'boardIDs={{boardIDs}}' \
  --data-urlencode 'locationIDs={{locationIDs}}' \
  --data-urlencode 'followLocationIDs={{followLocationIDs}}' \
  --data-urlencode 'action={{action}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_profile_setup_follows_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.actionstring ["follow","unfollow"] Yes
$.oneOf[0].allOf[1].Payload.followedUsersarray Yes
$.oneOf[0].allOf[1].Payload.followedUsers[]object No
$.oneOf[0].allOf[1].Payload.followedUsers[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.followedUsers[].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.unfollowedUsersarray Yes
$.oneOf[0].allOf[1].Payload.unfollowedUsers[]object No
$.oneOf[0].allOf[1].Payload.unfollowedUsers[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.unfollowedUsers[].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.followedBoardsarray Yes
$.oneOf[0].allOf[1].Payload.followedBoards[]integer No
$.oneOf[0].allOf[1].Payload.followedLocationsarray Yes
$.oneOf[0].allOf[1].Payload.followedLocations[]integer No
$.oneOf[0].allOf[1].Payload.unfollowedBoardsarray Yes
$.oneOf[0].allOf[1].Payload.unfollowedBoards[]integer No
$.oneOf[0].allOf[1].Payload.unfollowedLocationsarray Yes
$.oneOf[0].allOf[1].Payload.unfollowedLocations[]integer No
$.oneOf[0].allOf[1].Payload.derivedBoardIDsarray Yes
$.oneOf[0].allOf[1].Payload.derivedBoardIDs[]integer No
$.oneOf[0].allOf[1].Payload.setupProfileSetup YesCurrent setup state. get_profile_setup reads without marking completion; the setup embedded in successful writes can synchronize stored completion.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].isLoggedIn = true Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].hasDisplayableOpenItemsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].requiresOnboardingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].collapsedByDefaultboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].profileIntentstring ["","buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptionsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].valuestring ["buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].spritestring ["buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].flowIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].intentOptions[].usesFlowCopy = true Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].citySlugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].regionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].countrystring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].cityGroupCodestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].iconstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].imageBasePathstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].sourcestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].isSavedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].isRecommendedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[0].distanceMetersinteger No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebase.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestionsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].citySlugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].regionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].countrystring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].cityGroupCodestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].iconstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].imageBasePathstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].sourcestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].isSavedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].isRecommendedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].homebaseSuggestions[].distanceMetersinteger No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].followCountsobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].followCounts.userFollowCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].followCounts.boardFollowCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestionsobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.usersarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].avatarstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileIntentstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].recommendationTypestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].communityVerificationStatusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].followerCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].publicPostCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].isViewerFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].isProfileSetupFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].hasAboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].profileImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.users[].bannerImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boardsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].urlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].boardIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].followerCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].recentPostCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].isViewerFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].isProfileSetupFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].hasAboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].profileImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.boards[].bannerImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locationsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].locationAliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].stateShortstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].countryShortstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].categoryDescriptorstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].categoryIconstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].localRankinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].rankinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].userTradesinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].bidsLast30Dayinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.locations[].isViewerFollowingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].homebaseCitySlugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].renderTypestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].stepKeystring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].hasParametersboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].includeUsersboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].includeBoardsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].includeLocationsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].isTrendingboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].profileIntentstring ["","buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completionobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.requiredCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.presentedCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.presentedUserCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.presentedBoardCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.presentedLocationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.followedCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.followedUserCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.followedBoardCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.followedLocationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].completion.isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].isWaitingForMinimumContextboolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].missingContextKeysarray No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[0].missingContextKeys[]string ["profileIntent","homebase"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].suggestions.context.anyOf[1].isConfigured = false Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenuesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].partnerAccountNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].rolestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].sourcestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].partnerAccountID Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].partnerAccountID.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenues[].partnerAccountID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaimsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].statusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].chatURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].requestIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].chatIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationStatusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationChatIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationChatURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationUnreadCount Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].sidebarStatus Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[0]string ["answer-required","pending"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].hasManagedVenuePathboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].schemaobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].schema.readyboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].schema.missingTablesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].schema.missingTables[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenuesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].rolestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].sourcestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountID Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountID.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenues[].partnerAccountID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaimsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].cityLinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].statusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].chatURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].managementURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].requestIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].chatIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationStatusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationChatIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationChatURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationUnreadCount Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].applicationUnreadCount.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].sidebarStatus Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[0]string ["answer-required","pending"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].pendingVenueClaims[].sidebarStatus.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].hasManagedVenuePathboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[0].managedVenuesURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].managedVenueState.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPostobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.postIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.hasAboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].bodyPreviewstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].urlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].authorAboutPostAuthor Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[0].profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].idnull Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].aliasnull Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].avatarEmojinull Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].profileUrlnull Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].identityHidden = true Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].author.anyOf[1].identityHiddenUntilinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].boardobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].board.idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].board.namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].board.slugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].board.typestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].imageMediaCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].mediaarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].widthinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].heightinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].titlestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[0].media[].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.post.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoardIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].boardIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].countinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].slugstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].citystring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].cityGroupCodestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].intentstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].callbackstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].unitLabelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].routingDescriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].createsRegularBoardPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].isDefaultRequestBoardboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].isDefaultListingBoardboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].routingEnabledboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[0].selectedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].aboutPost.wallBoard.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircleobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.statusstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.positiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.netPositiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.requiredNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.remainingNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verifierCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.hasTrustSignalboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].userobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.avatarstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.communityVerificationStatusstring ["Unverified","Verified"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.communityVerificationCountFormattedstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.firstNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.lastNamestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.professionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].user.privacySettingstring ["do_not_publicly_share","share_name","share_profession","share_name_and_profession"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verificationobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.sharePathstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.shareURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.requiredNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.remainingNetPositiveVerificationsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.positiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.negativeVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.netPositiveVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verification.verifierCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].privacyOptionsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].privacyOptions[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].privacyOptions[].valuestring ["do_not_publicly_share","share_name","share_profession","share_name_and_profession"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].privacyOptions[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiersarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verificationIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].createdDateFormattedstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].messagestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].isPositiveVerificationboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifierobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.aliasstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.avatarstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.profileURLstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.communityVerificationStatusstring ["","Unverified","Verified"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.communityVerificationCountinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.communityVerificationCountFormattedstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[0].verifiers[].verifier.importancePointsFormattedstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].innerCircle.verification.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completionobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.intentboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.homebaseboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.interestsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.managedVenueboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.aboutPostboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].completion.innerCircleboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flowobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.flowIDinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.sourcestring ["intent-only","active","fallback","status"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.intentTypestring ["","buy","sell","socialize","location-partner"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.namestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actionsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].idinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].renderTypestring ["intent_picker","homebase_picker","follow_recommendations","about_me_post","managed_venue_claim","verification_invites"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].orderinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayOrderinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].headlinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parametersOnboardingParameters YesDecoded ActionParametersJSON. Empty or invalid configuration is serialized as []; objects and JSON lists are preserved.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].intentSourcestring No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].Homebasestring No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].homebasestring No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].homebaseSourcestring No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAsarray No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCTAs[].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtasarray No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].requiredEventCtas[].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctasarray No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].ctas[].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[0].*.anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[0]null No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[1]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[2]number No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[4]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[4][]OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[5]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parameters.anyOf[1][].anyOf[5].*OnboardingParameterValue No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].parametersJSONstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].completeboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].completeForProgressboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].visibleboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].lockedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].hasDisplayConditionboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionSatisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].hasGateboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventSatisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionCallbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.callbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.deferredUntilGateSatisfiedboolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.reasonstring ["missing_user","unknown_callback"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].displayConditionStatus.activePendingBidCountinteger No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventMatchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventHeadlinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventDescriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAsarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAs[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAs[].stylestring ["primary","secondary"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAs[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventCTAs[].javascriptstring YesConfigured client action code. Documentation treats this as text and never executes it.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.matchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventCounts Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventCounts.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventCounts.anyOf[0].*integer No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.eventCounts.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.matchedEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].requiredEventStatus.matchedEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.actions[].adminNotesstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.stepKeysarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.stepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.visibleStepKeysarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.visibleStepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].targetActionobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].targetAction.actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].targetAction.stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].headlinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctasarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctas[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctas[].stylestring ["primary","secondary"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctas[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].ctas[].javascriptstring YesConfigured client action code. Documentation treats this as text and never executes it.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventMatchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.matchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts.anyOf[0].*integer No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.eventCounts.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.matchedEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[0].requiredEventStatus.matchedEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.currentGate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGatesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].targetActionobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].targetAction.actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].targetAction.stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].headlinestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctasarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctas[]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctas[].stylestring ["primary","secondary"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctas[].labelstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].ctas[].javascriptstring YesConfigured client action code. Documentation treats this as text and never executes it.
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventMatchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.matchModestring ["Any","All"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts.anyOf[0].*integer No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.eventCounts.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.matchedEventNamesarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventStatus.matchedEventNames[]string No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].acknowledgeAfterStepKeysarray Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].acknowledgeAfterStepKeys[]string ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.acknowledgementGates[].requiredEventSatisfied = true Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].actionKeystring ["SELECT_INTENT","SELECT_HOMEBASE","SELECT_FOLLOWING","SELECT_MANAGED_VENUE","SELECT_ABOUTME_POST","SELECT_VERIFIERS"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].stepKeystring ["intent","homebase","interests","managedVenue","aboutPost","innerCircle"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionCallbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatusobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.callbackstring ["","USER_HAS_ACTIVE_PENDING_BID"] Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.satisfiedboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.deferredUntilGateSatisfiedboolean No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.reasonstring ["missing_user","unknown_callback"] No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[0].displayConditionStatus.activePendingBidCountinteger No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.displayConditionSuppressedAction.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.hasDisplayableOpenItemsboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.progressobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.progress.completedinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.progress.totalinteger Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.progress.isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].flow.isCompleteboolean Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpointsobject Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.refreshstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.setIntentstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.cityOptionsstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.setHomebasestring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.setFollowsstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.partnerLocationOptionsstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.partnerSetClaimstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.managedVenuesstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].endpoints.verificationCenterstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].renderedFragments No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].renderedFragments.anyOf[0]object No
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].renderedFragments.anyOf[0].verificationCenterstring Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[0].renderedFragments.anyOf[1]array No
$.oneOf[0].allOf[1].Payload.setup.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.setup.anyOf[1].isLoggedIn = false Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_profile_setup_follows",
    "RequestUserAlias": "example-user",
    "Payload": {
        "action": "follow",
        "followedUsers": [],
        "unfollowedUsers": [],
        "followedBoards": [],
        "followedLocations": [],
        "unfollowedBoards": [],
        "unfollowedLocations": [],
        "derivedBoardIDs": [],
        "setup": {
            "isLoggedIn": true,
            "isComplete": false,
            "hasDisplayableOpenItems": false,
            "requiresOnboarding": false,
            "collapsedByDefault": false,
            "profileIntent": "",
            "intentOptions": [],
            "homebase": {
                "citySlug": "synthetic-example",
                "cityName": "synthetic-example",
                "region": "synthetic-example",
                "country": "synthetic-example",
                "cityGroupCode": "synthetic-example",
                "label": "synthetic-example",
                "icon": "synthetic-example",
                "imageBasePath": "synthetic-example",
                "imageURL256": "synthetic-example",
                "imageURL512": "synthetic-example",
                "bannerImageURL": "synthetic-example",
                "source": "synthetic-example",
                "isSaved": false,
                "isRecommended": false
            },
            "homebaseSuggestions": [],
            "followCounts": {
                "userFollowCount": 0,
                "boardFollowCount": 0
            },
            "suggestions": {
                "users": [],
                "boards": [],
                "locations": [],
                "context": {
                    "homebaseCitySlug": "synthetic-example",
                    "renderType": "synthetic-example",
                    "stepKey": "synthetic-example",
                    "hasParameters": false,
                    "includeUsers": false,
                    "includeBoards": false,
                    "includeLocations": false,
                    "isTrending": false,
                    "profileIntent": "",
                    "completion": {
                        "requiredCount": 0,
                        "presentedCount": 0,
                        "presentedUserCount": 0,
                        "presentedBoardCount": 0,
                        "presentedLocationCount": 0,
                        "followedCount": 0,
                        "followedUserCount": 0,
                        "followedBoardCount": 0,
                        "followedLocationCount": 0,
                        "isComplete": false
                    }
                }
            },
            "managedVenues": [],
            "pendingVenueClaims": [],
            "hasManagedVenuePath": false,
            "managedVenueState": {
                "schema": {
                    "ready": false,
                    "missingTables": []
                },
                "managedVenues": [],
                "pendingVenueClaims": [],
                "hasManagedVenuePath": false,
                "managedVenuesURL": "synthetic-example"
            },
            "aboutPost": {
                "postID": 0,
                "hasAboutPost": false,
                "post": {
                    "id": 0,
                    "title": "synthetic-example",
                    "bodyPreview": "synthetic-example",
                    "url": "synthetic-example",
                    "createdDate": "synthetic-example",
                    "author": {
                        "id": 0,
                        "alias": "synthetic-example",
                        "avatarEmoji": "synthetic-example",
                        "profileUrl": "synthetic-example"
                    },
                    "board": {
                        "id": 0,
                        "name": "synthetic-example",
                        "slug": "synthetic-example",
                        "type": "synthetic-example"
                    },
                    "imageMediaCount": 0,
                    "media": []
                },
                "wallBoardID": 0,
                "wallBoard": {
                    "id": 0,
                    "boardID": 0,
                    "count": 0,
                    "slug": "synthetic-example",
                    "name": "synthetic-example",
                    "city": "synthetic-example",
                    "cityGroupCode": "synthetic-example",
                    "intent": "synthetic-example",
                    "callback": "synthetic-example",
                    "unitLabel": "synthetic-example",
                    "routingDescription": "synthetic-example",
                    "createsRegularBoardPost": false,
                    "isDefaultRequestBoard": false,
                    "isDefaultListingBoard": false,
                    "routingEnabled": false,
                    "selected": false
                }
            },
            "innerCircle": {
                "status": "synthetic-example",
                "positiveVerificationCount": 0,
                "netPositiveVerificationCount": 0,
                "requiredNetPositiveVerifications": 0,
                "remainingNetPositiveVerifications": 0,
                "verifierCount": 0,
                "hasTrustSignal": false,
                "verification": {
                    "user": {
                        "userID": 0,
                        "alias": "synthetic-example",
                        "avatar": "synthetic-example",
                        "profileURL": "synthetic-example",
                        "communityVerificationStatus": "Unverified",
                        "communityVerificationCount": 0,
                        "communityVerificationCountFormatted": "synthetic-example",
                        "firstName": "synthetic-example",
                        "lastName": "synthetic-example",
                        "profession": "synthetic-example",
                        "privacySetting": "do_not_publicly_share"
                    },
                    "verification": {
                        "sharePath": "synthetic-example",
                        "shareURL": "synthetic-example",
                        "requiredNetPositiveVerifications": 0,
                        "remainingNetPositiveVerifications": 0,
                        "positiveVerificationCount": 0,
                        "negativeVerificationCount": 0,
                        "netPositiveVerificationCount": 0,
                        "verifierCount": 0
                    },
                    "privacyOptions": [],
                    "verifiers": []
                }
            },
            "completion": {
                "intent": false,
                "homebase": false,
                "interests": false,
                "managedVenue": false,
                "aboutPost": false,
                "innerCircle": false
            },
            "flow": {
                "flowID": 0,
                "source": "intent-only",
                "intentType": "",
                "name": "synthetic-example",
                "description": "synthetic-example",
                "actions": [],
                "stepKeys": [],
                "visibleStepKeys": [],
                "currentGate": {
                    "actionKey": "SELECT_INTENT",
                    "stepKey": "intent",
                    "targetAction": {
                        "actionKey": "SELECT_INTENT",
                        "stepKey": "intent"
                    },
                    "headline": "synthetic-example",
                    "description": "synthetic-example",
                    "ctas": [],
                    "requiredEventNames": [],
                    "requiredEventMatchMode": "Any",
                    "requiredEventStatus": {
                        "satisfied": false,
                        "eventNames": [],
                        "matchMode": "Any",
                        "eventCounts": [],
                        "matchedEventNames": []
                    }
                },
                "acknowledgementGates": [],
                "displayConditionSuppressedAction": {
                    "actionKey": "SELECT_INTENT",
                    "stepKey": "intent",
                    "displayConditionCallback": "",
                    "displayConditionStatus": {
                        "callback": "",
                        "satisfied": false
                    }
                },
                "hasDisplayableOpenItems": false,
                "progress": {
                    "completed": 0,
                    "total": 0,
                    "isComplete": false
                },
                "isComplete": false
            },
            "endpoints": {
                "refresh": "synthetic-example",
                "setIntent": "synthetic-example",
                "cityOptions": "synthetic-example",
                "setHomebase": "synthetic-example",
                "setFollows": "synthetic-example",
                "partnerLocationOptions": "synthetic-example",
                "partnerSetClaim": "synthetic-example",
                "managedVenues": "synthetic-example",
                "verificationCenter": "synthetic-example"
            }
        }
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_profile_visibility

#
Updates the current user's profile visibility threshold. The threshold is based on a viewer's cached total importance points. A threshold of 0 means "Any" and keeps the profile visible to everyone.

Parameters

NameTypeRequiredDefaultDescription
profileVisibleImportancePointsThreshold int No 0 Minimum total importance points required to see the profile.
profileVisibilityMode string No "public" One of public, rich_lock, or full_lock.
isWritingRequest bool No false Required true to save.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_profile_visibility' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'profileVisibleImportancePointsThreshold={{profileVisibleImportancePointsThreshold}}' \
  --data-urlencode 'profileVisibilityMode={{profileVisibilityMode}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_profile_visibility_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.settingsobject Yes
$.oneOf[0].allOf[1].Payload.settings.profileVisibleImportancePointsThresholdinteger Yes
$.oneOf[0].allOf[1].Payload.settings.profileVisibilityModestring ["public","rich_lock","full_lock"] Yes
$.oneOf[0].allOf[1].Payload.visibilityobject Yes
$.oneOf[0].allOf[1].Payload.visibility.canViewProfileboolean Yes
$.oneOf[0].allOf[1].Payload.visibility.lockedboolean Yes
$.oneOf[0].allOf[1].Payload.visibility.isAnyboolean Yes
$.oneOf[0].allOf[1].Payload.visibility.isPublicboolean Yes
$.oneOf[0].allOf[1].Payload.visibility.isSelfboolean Yes
$.oneOf[0].allOf[1].Payload.visibility.canBypassboolean Yes
$.oneOf[0].allOf[1].Payload.visibility.viewerMeetsThresholdboolean Yes
$.oneOf[0].allOf[1].Payload.visibility.lockModestring ["","public","rich_lock","full_lock"] Yes
$.oneOf[0].allOf[1].Payload.visibility.profileVisibilityModestring ["public","rich_lock","full_lock"] Yes
$.oneOf[0].allOf[1].Payload.visibility.profileVisibleImportancePointsThresholdinteger Yes
$.oneOf[0].allOf[1].Payload.visibility.modestring ["public","rich_lock","full_lock"] Yes
$.oneOf[0].allOf[1].Payload.visibility.thresholdinteger Yes
$.oneOf[0].allOf[1].Payload.visibility.maxThreshold = 10000000 Yes
$.oneOf[0].allOf[1].Payload.visibility.viewerUserID Yes
$.oneOf[0].allOf[1].Payload.visibility.viewerUserID.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.visibility.viewerUserID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.visibility.viewerImportancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.audiencePreviewobject Yes
$.oneOf[0].allOf[1].Payload.audiencePreview.thresholdinteger Yes
$.oneOf[0].allOf[1].Payload.audiencePreview.maxThreshold = 10000000 Yes
$.oneOf[0].allOf[1].Payload.audiencePreview.isAnyboolean Yes
$.oneOf[0].allOf[1].Payload.audiencePreview.totalVisibleUserCountinteger Yes
$.oneOf[0].allOf[1].Payload.audiencePreview.topUsersarray Yes
$.oneOf[0].allOf[1].Payload.audiencePreview.topUsers[]object No
$.oneOf[0].allOf[1].Payload.audiencePreview.topUsers[].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.audiencePreview.topUsers[].importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.audiencePreview.topUsers[].topUserGroupImportanceinteger Yes
$.oneOf[0].allOf[1].Payload.audiencePreview.topUsers[].aliasstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.audiencePreview.topUsers[].avatarstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.audiencePreview.topUsers[].topUserGroupNamestring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.audiencePreview.topUsers[].topMedalCategoryNamestring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.audiencePreview.topUsers[].profileURLstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.audiencePreview.groupsarray Yes
$.oneOf[0].allOf[1].Payload.audiencePreview.groups[]object No
$.oneOf[0].allOf[1].Payload.audiencePreview.groups[].userGroupIDinteger Yes
$.oneOf[0].allOf[1].Payload.audiencePreview.groups[].importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.audiencePreview.groups[].medalCategoryIDinteger Yes
$.oneOf[0].allOf[1].Payload.audiencePreview.groups[].qualifyingUserCountinteger Yes
$.oneOf[0].allOf[1].Payload.audiencePreview.groups[].namestring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.audiencePreview.groups[].slugstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.audiencePreview.groups[].descriptionstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.audiencePreview.groups[].iconURLstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.audiencePreview.groups[].colorstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.audiencePreview.groups[].textColorstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.audiencePreview.groups[].medalCategoryNamestring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.audiencePreview.groups[].medalCategorySlugstring YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.audiencePreview.groups[].topUsersarray Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_profile_visibility",
    "RequestUserAlias": "example-user",
    "Payload": {
        "settings": {
            "profileVisibleImportancePointsThreshold": 0,
            "profileVisibilityMode": "public"
        },
        "visibility": {
            "canViewProfile": false,
            "locked": false,
            "isAny": false,
            "isPublic": false,
            "isSelf": false,
            "canBypass": false,
            "viewerMeetsThreshold": false,
            "lockMode": "",
            "profileVisibilityMode": "public",
            "profileVisibleImportancePointsThreshold": 0,
            "mode": "public",
            "threshold": 0,
            "maxThreshold": 10000000,
            "viewerUserID": 0,
            "viewerImportancePoints": 0
        },
        "audiencePreview": {
            "threshold": 0,
            "maxThreshold": 10000000,
            "isAny": false,
            "totalVisibleUserCount": 0,
            "topUsers": [],
            "groups": []
        }
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_profile_visit_notifications

#
Updates the acting profile owner's visitor notification preferences. Requires SeeProfileInsights. Enabled with Priority delivery by default; applies to future visits.

Parameters

NameTypeRequiredDefaultDescription
notifyOnProfileVisit bool Yes — Whether to notify about signed-in profile visitors.
isWritingRequest bool No false Required true to save.
profileVisitNotificationPriority string No "" Normal retains feed notifications without ordinary push delivery; Priority allows push delivery. Omit or pass an empty string to preserve the saved priority.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_profile_visit_notifications' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'notifyOnProfileVisit={{notifyOnProfileVisit}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}' \
  --data-urlencode 'profileVisitNotificationPriority={{profileVisitNotificationPriority}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_profile_visit_notifications_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.notifyOnProfileVisitboolean Yes
$.oneOf[0].allOf[1].Payload.profileVisitNotificationPrioritystring ["Normal","Priority"] Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_profile_visit_notifications",
    "RequestUserAlias": "example-user",
    "Payload": {
        "notifyOnProfileVisit": false,
        "profileVisitNotificationPriority": "Normal"
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_relationship_block

#
Blocks or unblocks a user for optional user-to-user contact.

Parameters

NameTypeRequiredDefaultDescription
userAlias string Yes — Alias of the user to block or unblock.
blocked bool No true True to block, false to unblock.
reason string No "" Optional private reason.
isWritingRequest bool No false Required true to save.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_relationship_block' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'blocked={{blocked}}' \
  --data-urlencode 'reason={{reason}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_relationship_block_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.actorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.targetUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.isBlockedboolean Yes
$.oneOf[0].allOf[1].Payload.blockedDate Yes
$.oneOf[0].allOf[1].Payload.blockedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.blockedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.isMutedboolean Yes
$.oneOf[0].allOf[1].Payload.mutedDate Yes
$.oneOf[0].allOf[1].Payload.mutedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.mutedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.reasonstring Yes
$.oneOf[0].allOf[1].Payload.personalNotestring Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_relationship_block",
    "RequestUserAlias": "example-user",
    "Payload": {
        "actorUserID": 0,
        "targetUserID": 0,
        "isBlocked": false,
        "blockedDate": "synthetic-example",
        "isMuted": false,
        "mutedDate": "synthetic-example",
        "reason": "synthetic-example",
        "personalNote": "synthetic-example"
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_relationship_mute

#
Mutes or unmutes a user for viewer-side chat urgency.

Parameters

NameTypeRequiredDefaultDescription
userAlias string Yes — Alias of the user to mute or unmute.
muted bool No true True to mute, false to unmute.
reason string No "" Optional private reason.
isWritingRequest bool No false Required true to save.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_relationship_mute' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'muted={{muted}}' \
  --data-urlencode 'reason={{reason}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_relationship_mute_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.actorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.targetUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.isBlockedboolean Yes
$.oneOf[0].allOf[1].Payload.blockedDate Yes
$.oneOf[0].allOf[1].Payload.blockedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.blockedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.isMutedboolean Yes
$.oneOf[0].allOf[1].Payload.mutedDate Yes
$.oneOf[0].allOf[1].Payload.mutedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.mutedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.reasonstring Yes
$.oneOf[0].allOf[1].Payload.personalNotestring Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_relationship_mute",
    "RequestUserAlias": "example-user",
    "Payload": {
        "actorUserID": 0,
        "targetUserID": 0,
        "isBlocked": false,
        "blockedDate": "synthetic-example",
        "isMuted": false,
        "mutedDate": "synthetic-example",
        "reason": "synthetic-example",
        "personalNote": "synthetic-example"
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_relationship_note

#
Saves or clears the current viewer's private note about a target user. The note is private to the current viewer and is not shown to the target user.

Parameters

NameTypeRequiredDefaultDescription
userAlias string Yes — Alias of the target user.
personalNote string No "" Short private note. Empty clears the note.
isWritingRequest bool No false Required true to save.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_relationship_note' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'personalNote={{personalNote}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_relationship_note_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.actorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.targetUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.isBlockedboolean Yes
$.oneOf[0].allOf[1].Payload.blockedDate Yes
$.oneOf[0].allOf[1].Payload.blockedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.blockedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.isMutedboolean Yes
$.oneOf[0].allOf[1].Payload.mutedDate Yes
$.oneOf[0].allOf[1].Payload.mutedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.mutedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.reasonstring Yes
$.oneOf[0].allOf[1].Payload.personalNotestring Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_relationship_note",
    "RequestUserAlias": "example-user",
    "Payload": {
        "actorUserID": 0,
        "targetUserID": 0,
        "isBlocked": false,
        "blockedDate": "synthetic-example",
        "isMuted": false,
        "mutedDate": "synthetic-example",
        "reason": "synthetic-example",
        "personalNote": "synthetic-example"
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_request_email_change

#
Request a protected email change for the original owner, or an explicit target with AccessSpecialFunctions. Sends old-address cancellation and new-address verification emails; never changes the login email immediately. Self-service requests are limited to three attempts per hour per original owner.

Parameters

NameTypeRequiredDefaultDescription
userID int Yes — 0 selects the original caller, ignoring impersonation. Positive IDs require admin permission.
newEmail string Yes — Proposed login email.
expectedEmail string Yes — Current email shown in the confirmation; stale values are rejected.
isWritingRequest bool No false Explicit confirmation; must be true. POST only.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_request_email_change' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userID={{userID}}' \
  --data-urlencode 'newEmail={{newEmail}}' \
  --data-urlencode 'expectedEmail={{expectedEmail}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_request_email_change_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.requestobject Yes
$.oneOf[0].allOf[1].Payload.request.idinteger Yes
$.oneOf[0].allOf[1].Payload.request.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.request.oldEmailstring Yes
$.oneOf[0].allOf[1].Payload.request.newEmailstring Yes
$.oneOf[0].allOf[1].Payload.request.statusstring ["Preparing","Pending","Completed","Cancelled","Expired","Failed"] Yes
$.oneOf[0].allOf[1].Payload.request.reason Yes
$.oneOf[0].allOf[1].Payload.request.reason.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.request.reason.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.request.activeboolean Yes
$.oneOf[0].allOf[1].Payload.request.requestedAtstring Yes
$.oneOf[0].allOf[1].Payload.request.resolvedAt Yes
$.oneOf[0].allOf[1].Payload.request.resolvedAt.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.request.resolvedAt.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.request.dueAt Yes
$.oneOf[0].allOf[1].Payload.request.dueAt.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.request.dueAt.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.request.verifiedboolean Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_request_email_change",
    "RequestUserAlias": "example-user",
    "Payload": {
        "request": {
            "id": 0,
            "userID": 0,
            "oldEmail": "old-owner@example.invalid",
            "newEmail": "new-owner@example.invalid",
            "status": "Preparing",
            "reason": "synthetic-example",
            "active": false,
            "requestedAt": "synthetic-example",
            "resolvedAt": "synthetic-example",
            "dueAt": "synthetic-example",
            "verified": false
        }
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_submit_address_verification

#
Submit an owned address revision and its effective phone through the existing document review. Use POST for personal information.

Parameters

NameTypeRequiredDefaultDescription
addressID int Yes — Owned saved address ID.
revision int Yes — Current saved revision.
firstName string Yes — Legal first name.
lastName string Yes — Legal last name.
nationalIDNumber string Yes — National identification number.
dateOfBirth string Yes — Date in YYYY-MM-DD format.
mediaIDsJSON string Yes — JSON list of at least two identity-document media IDs owned by the acting user.
businessName string No "" Optional business name.
isWritingRequest bool No false Explicit write confirmation.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_submit_address_verification' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'addressID={{addressID}}' \
  --data-urlencode 'revision={{revision}}' \
  --data-urlencode 'firstName={{firstName}}' \
  --data-urlencode 'lastName={{lastName}}' \
  --data-urlencode 'nationalIDNumber={{nationalIDNumber}}' \
  --data-urlencode 'dateOfBirth={{dateOfBirth}}' \
  --data-urlencode 'mediaIDsJSON={{mediaIDsJSON}}' \
  --data-urlencode 'businessName={{businessName}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Parameters: mediaIDsJSON
FieldTypeRequiredDescription
mediaIDsJSONstring (application/json) YesJSON list of 2–10 media IDs for documents owned by the caller.
mediaIDsJSONarray (decoded JSON) Yes
mediaIDsJSON[] No
mediaIDsJSON[].anyOf[0]integer No
mediaIDsJSON[].anyOf[1]string No
Response fields
FieldTypeRequiredDescription
$user_set_submit_address_verification_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.userAliasstring Yes
$.oneOf[0].allOf[1].Payload.canEditboolean Yes
$.oneOf[0].allOf[1].Payload.defaultPhonestring Yes
$.oneOf[0].allOf[1].Payload.totalinteger Yes
$.oneOf[0].allOf[1].Payload.primary Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].addressIDinteger Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].reviewIDinteger Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].formattedAddressstring Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].phonestring Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[0].status = "IdentityConfirmed" Yes
$.oneOf[0].allOf[1].Payload.primary.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.addressesarray Yes
$.oneOf[0].allOf[1].Payload.addresses[]object No
$.oneOf[0].allOf[1].Payload.addresses[].idinteger Yes
$.oneOf[0].allOf[1].Payload.addresses[].revisioninteger Yes
$.oneOf[0].allOf[1].Payload.addresses[].labelstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].addressPersonalAddress Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].formatted_addressstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_componentsarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[]object No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].long_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].short_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].typesarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].address_components[].types[]string No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].source = "google" Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[0].unitstring No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].formatted_addressstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_componentsarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[]object No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].long_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].short_namestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].typesarray Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].address_components[].types[]string No
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].source = "photon" Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].osmobject Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].osm.typestring ["N","W","R"] Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].osm.idstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].coordinatesobject Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].coordinates.latitudenumber Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].coordinates.longitudenumber Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].resultTypestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].schemaVersion = 1 Yes
$.oneOf[0].allOf[1].Payload.addresses[].address.anyOf[1].unitstring No
$.oneOf[0].allOf[1].Payload.addresses[].formattedAddressstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].phoneOverride Yes
$.oneOf[0].allOf[1].Payload.addresses[].phoneOverride.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.addresses[].phoneOverride.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.addresses[].phonestring Yes
$.oneOf[0].allOf[1].Payload.addresses[].statusstring ["NotReviewed","SubmittedForReview","Rejected","CancelledByUser","IdentityConfirmed"] Yes
$.oneOf[0].allOf[1].Payload.addresses[].reviewIDinteger Yes
$.oneOf[0].allOf[1].Payload.addresses[].rejectReasonstring Yes
$.oneOf[0].allOf[1].Payload.addresses[].isPrimaryboolean Yes
$.oneOf[0].allOf[1].Payload.addresses[].isActiveSnapshotboolean Yes
$.oneOf[0].allOf[1].Payload.nextStartinteger Yes
$.oneOf[0].allOf[1].Payload.hasMoreboolean Yes
$.oneOf[0].allOf[1].Payload.reviewDefaultsobject No
$.oneOf[0].allOf[1].Payload.reviewDefaults.firstNamestring Yes
$.oneOf[0].allOf[1].Payload.reviewDefaults.lastNamestring Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_submit_address_verification",
    "RequestUserAlias": "example-user",
    "Payload": {
        "userAlias": "synthetic-example",
        "canEdit": false,
        "defaultPhone": "synthetic-example",
        "total": 0,
        "primary": {
            "addressID": 0,
            "reviewID": 0,
            "formattedAddress": "synthetic-example",
            "phone": "synthetic-example",
            "status": "IdentityConfirmed"
        },
        "addresses": [],
        "nextStart": 0,
        "hasMore": false
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_user_to_user_chat_decision

#
Accepts or denies a user-to-user profile chat request. The requested user may also accept a previously denied request.

Parameters

NameTypeRequiredDefaultDescription
chatID int No 0 ATNotificationIntelligentTags.ID for the chat.
decision string No "accept" Either accept or deny.
isWritingRequest bool No false Required true to save the decision.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_user_to_user_chat_decision' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'chatID={{chatID}}' \
  --data-urlencode 'decision={{decision}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_user_to_user_chat_decision_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.ChatIDinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].chatIDinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].otherUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestingUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].destinationUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestMessageBodyIDinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestMessageCountinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestMessageLimitinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestMessagesRemaininginteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestMessageCooldownHoursinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestMessageSecondsUntilNextinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].otherAliasstring Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].otherAvatarstring Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].reasonCodestring Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].reasonstring Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].statusstring ["accepted","blocked-by-viewer","blocked-by-other","denied","pending"] Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].viewerRolestring ["requester","destination","participant"] Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].acceptedDate Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].acceptedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].acceptedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].deniedDate Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].deniedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].deniedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].lastRequestDate Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].lastRequestDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].lastRequestDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].nextRequestMessageDate Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].nextRequestMessageDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].nextRequestMessageDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].canSendNextRequestMessageboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].viewerBlockedOtherboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].otherBlockedViewerboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].viewerMutedOtherboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].otherMutedViewerboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].recipientAllowsChatRequestsboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].canAcceptboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].canDenyboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].canSendboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[1]null Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_user_to_user_chat_decision",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ChatID": 0,
        "UserToUser": {
            "chatID": 0,
            "otherUserID": 0,
            "requestingUserID": 0,
            "destinationUserID": 0,
            "requestMessageBodyID": 0,
            "requestMessageCount": 0,
            "requestMessageLimit": 0,
            "requestMessagesRemaining": 0,
            "requestMessageCooldownHours": 0,
            "requestMessageSecondsUntilNext": 0,
            "otherAlias": "synthetic-example",
            "otherAvatar": "synthetic-example",
            "reasonCode": "synthetic-example",
            "reason": "synthetic-example",
            "status": "accepted",
            "viewerRole": "requester",
            "acceptedDate": "synthetic-example",
            "deniedDate": "synthetic-example",
            "lastRequestDate": "synthetic-example",
            "nextRequestMessageDate": "synthetic-example",
            "canSendNextRequestMessage": false,
            "viewerBlockedOther": false,
            "otherBlockedViewer": false,
            "viewerMutedOther": false,
            "otherMutedViewer": false,
            "recipientAllowsChatRequests": false,
            "canAccept": false,
            "canDeny": false,
            "canSend": false
        }
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_user_to_user_chat_request

#
Starts or reopens a user-to-user profile chat request. If the existing marketplace chat permission already allows the pair, the chat is immediately sendable. Otherwise the target user receives an in-chat request decision and the requester may send one opening message. New requests to buyers in an active selection round require GlobalCommunityAdministration; otherwise ErrorReason=active_bid_selection. Existing history remains readable. Disabled profile requests return ErrorReason=profile_chat_requests_disabled; purchase help is available through /v1/user/get_purchase_contact_options.

Parameters

NameTypeRequiredDefaultDescription
userAlias string Yes — Alias of the profile user to message.
dateTimeExpiry string No "" Deprecated and ignored. Direct chats never expire.
isWritingRequest bool No false Required true to create or reopen the chat.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_user_to_user_chat_request' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'dateTimeExpiry={{dateTimeExpiry}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_user_to_user_chat_request_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.ChatIDinteger Yes
$.oneOf[0].allOf[1].Payload.Namestring Yes
$.oneOf[0].allOf[1].Payload.EncodedTagstring Yes
$.oneOf[0].allOf[1].Payload.Urlstring Yes
$.oneOf[0].allOf[1].Payload.ChatUrlstring Yes
$.oneOf[0].allOf[1].Payload.BidChat Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].bidIDinteger Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].buyerUserIDinteger | null Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].sellerUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].otherUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].bidUUIDstring Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].otherUserAlias Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].otherUserAlias.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].otherUserAlias.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].reasonCodestring Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].reasonstring Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].expiresAt Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].expiresAt.anyOf[0]string YesEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].expiresAt.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].expiredboolean Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].canSendboolean Yes
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].buyerIdentityHiddenboolean NoTrue when the authenticated viewer cannot see the buyer during the current response race.
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[0].buyerIdentityHiddenUntilinteger | null NoSaved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
$.oneOf[0].allOf[1].Payload.BidChat.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.UserToUser Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].chatIDinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].otherUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestingUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].destinationUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestMessageBodyIDinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestMessageCountinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestMessageLimitinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestMessagesRemaininginteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestMessageCooldownHoursinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].requestMessageSecondsUntilNextinteger Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].otherAliasstring Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].otherAvatarstring Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].reasonCodestring Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].reasonstring Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].statusstring ["accepted","blocked-by-viewer","blocked-by-other","denied","pending"] Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].viewerRolestring ["requester","destination","participant"] Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].acceptedDate Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].acceptedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].acceptedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].deniedDate Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].deniedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].deniedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].lastRequestDate Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].lastRequestDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].lastRequestDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].nextRequestMessageDate Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].nextRequestMessageDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].nextRequestMessageDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].canSendNextRequestMessageboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].viewerBlockedOtherboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].otherBlockedViewerboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].viewerMutedOtherboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].otherMutedViewerboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].recipientAllowsChatRequestsboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].canAcceptboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].canDenyboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[0].canSendboolean Yes
$.oneOf[0].allOf[1].Payload.UserToUser.anyOf[1]null Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[1].ErrorReasonstring NoEncoded intelligent tag for the created/opened chat. This legacy GET compatibility operation can create or update a chat request.
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_user_to_user_chat_request",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ChatID": 0,
        "Name": "synthetic-example",
        "EncodedTag": "synthetic-example",
        "Url": "synthetic-example",
        "ChatUrl": "synthetic-example",
        "BidChat": {
            "bidID": 900001,
            "buyerUserID": null,
            "sellerUserID": 900002,
            "otherUserID": 900003,
            "bidUUID": "00000000000000000000000000000001",
            "otherUserAlias": null,
            "reasonCode": "synthetic-example",
            "reason": "Synthetic customer privacy fixture.",
            "expiresAt": null,
            "expired": false,
            "canSend": false,
            "buyerIdentityHidden": true,
            "buyerIdentityHiddenUntil": 2100000000
        },
        "UserToUser": {
            "chatID": 0,
            "otherUserID": 0,
            "requestingUserID": 0,
            "destinationUserID": 0,
            "requestMessageBodyID": 0,
            "requestMessageCount": 0,
            "requestMessageLimit": 0,
            "requestMessagesRemaining": 0,
            "requestMessageCooldownHours": 0,
            "requestMessageSecondsUntilNext": 0,
            "otherAlias": "synthetic-example",
            "otherAvatar": "synthetic-example",
            "reasonCode": "synthetic-example",
            "reason": "synthetic-example",
            "status": "accepted",
            "viewerRole": "requester",
            "acceptedDate": "synthetic-example",
            "deniedDate": "synthetic-example",
            "lastRequestDate": "synthetic-example",
            "nextRequestMessageDate": "synthetic-example",
            "canSendNextRequestMessage": false,
            "viewerBlockedOther": false,
            "otherBlockedViewer": false,
            "viewerMutedOther": false,
            "otherMutedViewer": false,
            "recipientAllowsChatRequests": false,
            "canAccept": false,
            "canDeny": false,
            "canSend": false
        }
    }
}
Machine-readable endpoint documentation
POST

/v1/user/set_verify

#
Verifies another user. A newly saved positive confirmation joins their Inner Circle and queues a high-priority notification to them linking to the confirming user's profile.

Parameters

NameTypeRequiredDefaultDescription
toBeVerifiedUserAlias string Yes — Alias of user to be verified.
isPositiveVerification bool No true defines whether the user has been verified or not
verificationMessage string No "" Description of confirmation
isWritingRequest bool No false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_verify' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'toBeVerifiedUserAlias={{toBeVerifiedUserAlias}}' \
  --data-urlencode 'isPositiveVerification={{isPositiveVerification}}' \
  --data-urlencode 'verificationMessage={{verificationMessage}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_verify_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payload = true Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_verify",
    "RequestUserAlias": "example-user",
    "Payload": true
}
Machine-readable endpoint documentation
POST

/v1/user/set_verify_email_change

#
Public-by-design: possession of the proposed mailbox's token verifies that address only; never grants login or early completion.

Parameters

NameTypeRequiredDefaultDescription
token string Yes — Verification token from the email URL fragment. Never put it in the query string.
isWritingRequest bool No false Must be true after an explicit confirmation. POST only.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/user/set_verify_email_change' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'token={{token}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$user_set_verify_email_change_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.verified = true Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/user/set_verify_email_change",
    "RequestUserAlias": "example-user",
    "Payload": {
        "verified": true
    }
}
Machine-readable endpoint documentation