appsv2 API reference | AppointmentTrader

Search all endpoints

/v1/appsv2/

V2 appstore - list, create, configure, and purchase iframe-hosted apps. Distinct from /v1/apps/ (the legacy `\AT\ATApps` dev-platform model for externally-hosted developer apps with private keys). The `appsv2` namespace covers the v2 iframe app shell (\AT\ATAppsV2, /modules/v2/_app_host/), backed by the `ATAppsV2` table for user-created entries plus the static manifests in /config/atv2-apps.php for first-party shells.

GET

/v1/appsv2/get_about_post_candidates

Finds public community posts that can be selected as an app's About my app post. Eligibility mirrors the profile/About Me selector.

Parameters

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

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/appsv2/get_about_post_candidates' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'searchFilter={{searchFilter}}' \
  --data-urlencode 'postID={{postID}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'ownPostsOnly={{ownPostsOnly}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`appsv2_get_about_post_candidates_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.Candidates[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].bodyPreview`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].url`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].author`	`AboutPostAuthor`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[0].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[0].alias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[0].avatarEmoji`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[0].profileUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1].id`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1].alias`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1].avatarEmoji`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1].profileUrl`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1].identityHidden`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].author.anyOf[1].identityHiddenUntil`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].board`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].board.id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].board.name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].board.slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].board.type`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].imageMediaCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].media`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].media[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.Candidates[].media[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].media[].thumbUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].media[].mediaUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].media[].mediaType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].media[].width`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].media[].height`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].media[].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].media[].isImage`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.Candidates[].media[].isEmbedded`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.Page`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Page.pageSize`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Page.ownPostsOnly`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Page.requiresImageMedia`	`= 1`	`Yes`
`$.oneOf[0].allOf[1].Payload.Page.minimumImageMediaCount`	`= 2`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/appsv2/get_about_post_candidates",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Candidates": [],
        "Page": {
            "pageSize": 0,
            "ownPostsOnly": 0,
            "requiresImageMedia": 1,
            "minimumImageMediaCount": 2
        }
    }
}

Machine-readable endpoint documentation

GET

/v1/appsv2/get_checkout_url

Returns an inline custom-article checkout URL for paid app access.

Parameters

Name	Type	Required	Default	Description
`appID`	`int`	`Yes`	`—`	ATAppsV2.ID of the paid app.
`returnURL`	`string`	`No`	`""`	Optional same-host URL to return to after checkout.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/appsv2/get_checkout_url' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'appID={{appID}}' \
  --data-urlencode 'returnURL={{returnURL}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`appsv2_get_checkout_url_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.checkoutUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app`		`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].id`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].icon`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].entryUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].defaultPath`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].contentWidth`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].dbID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].ownerUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].aboutPostID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].priceAmount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].menu`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].isUserCreated`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].requiredLogin`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricingType`	`string ["Free","MonthlyUSD","YearlyUSD","MonthlyTraderpoints","YearlyTraderpoints"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.type`	`string ["Free","MonthlyUSD","YearlyUSD","MonthlyTraderpoints","YearlyTraderpoints"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.isPaid`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.period`	`string ["free","monthly","yearly"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.paymentMode`	`string ["free","usd","traderpoints"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.amountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.traderpointsAmount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.canAccess`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.isOwner`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.isFree`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.hasActiveAccess`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.accessEndDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].selectedForPost`	`integer [0,1]`	`No`
`$.oneOf[0].allOf[1].Payload.app.anyOf[1]`	`array`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/appsv2/get_checkout_url",
    "RequestUserAlias": "example-user",
    "Payload": {
        "checkoutUrl": "synthetic-example",
        "app": {
            "id": "synthetic-example",
            "slug": "synthetic-example",
            "name": "synthetic-example",
            "description": "synthetic-example",
            "icon": "synthetic-example",
            "entryUrl": "synthetic-example",
            "defaultPath": "synthetic-example",
            "contentWidth": "synthetic-example",
            "dbID": 0,
            "ownerUserID": 0,
            "aboutPostID": 0,
            "priceAmount": 0,
            "menu": [],
            "isUserCreated": true,
            "requiredLogin": true,
            "pricingType": "Free",
            "pricing": {
                "type": "Free",
                "isPaid": 0,
                "period": "free",
                "paymentMode": "free",
                "amountCents": 0,
                "traderpointsAmount": 0,
                "label": "synthetic-example"
            }
        }
    }
}

Machine-readable endpoint documentation

GET

/v1/appsv2/get_list

Returns the list of published user-created apps for the appstore. Public-by-design: the appstore is a public browse surface; paid apps only expose storefront metadata here, while app access is enforced by /modules/v2/_app_host/ and \AT\ATAppsV2::ViewerCanAccess().

Request example (cURL)

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

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`appsv2_get_list_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.apps[].id`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].icon`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].entryUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].defaultPath`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].contentWidth`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].dbID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].ownerUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].aboutPostID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].priceAmount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].menu`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].isUserCreated`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].requiredLogin`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].pricingType`	`string ["Free","MonthlyUSD","YearlyUSD","MonthlyTraderpoints","YearlyTraderpoints"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].pricing`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].pricing.type`	`string ["Free","MonthlyUSD","YearlyUSD","MonthlyTraderpoints","YearlyTraderpoints"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].pricing.isPaid`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].pricing.period`	`string ["free","monthly","yearly"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].pricing.paymentMode`	`string ["free","usd","traderpoints"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].pricing.amountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].pricing.traderpointsAmount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].pricing.label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].access`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.apps[].access.canAccess`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].access.isOwner`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].access.isFree`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].access.hasActiveAccess`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].access.accessEndDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].selectedForPost`	`integer [0,1]`	`No`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/appsv2/get_list",
    "RequestUserAlias": "example-user",
    "Payload": {
        "apps": []
    }
}

Machine-readable endpoint documentation

GET

/v1/appsv2/get_my_apps

Returns apps owned by the current viewer for the App Store setup UI.

Parameters

Name	Type	Required	Default	Description
`aboutPostID`	`int`	`No`	`0`	Optional post ID used by the newsfeed action to mark which owned apps already use that post.

Request example (cURL)

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

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`appsv2_get_my_apps_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[]`		`No`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].id`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].icon`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].entryUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].defaultPath`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].contentWidth`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].dbID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].ownerUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].aboutPostID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].priceAmount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].menu`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].isUserCreated`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].requiredLogin`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].pricingType`	`string ["Free","MonthlyUSD","YearlyUSD","MonthlyTraderpoints","YearlyTraderpoints"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].pricing`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].pricing.type`	`string ["Free","MonthlyUSD","YearlyUSD","MonthlyTraderpoints","YearlyTraderpoints"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].pricing.isPaid`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].pricing.period`	`string ["free","monthly","yearly"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].pricing.paymentMode`	`string ["free","usd","traderpoints"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].pricing.amountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].pricing.traderpointsAmount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].pricing.label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].access`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].access.canAccess`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].access.isOwner`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].access.isFree`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].access.hasActiveAccess`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].access.accessEndDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[0].selectedForPost`	`integer [0,1]`	`No`
`$.oneOf[0].allOf[1].Payload.apps[].anyOf[1]`	`array`	`No`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/appsv2/get_my_apps",
    "RequestUserAlias": "example-user",
    "Payload": {
        "apps": []
    }
}

Machine-readable endpoint documentation

POST

/v1/appsv2/set_about_post

Sets or clears an app's About my app post.

Parameters

Name	Type	Required	Default	Description
`appID`	`int`	`Yes`	`—`	ATAppsV2.ID of an app owned by the current user.
`postID`	`int`	`No`	`0`	Public ATDiscussionPosts.ID with at least two attached images. Pass 0 to clear.
`isWritingRequest`	`bool`	`No`	`false`	Set true to actually persist the app.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/appsv2/set_about_post' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'appID={{appID}}' \
  --data-urlencode 'postID={{postID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`appsv2_set_about_post_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.app`		`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].id`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].icon`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].entryUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].defaultPath`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].contentWidth`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].dbID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].ownerUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].aboutPostID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].priceAmount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].menu`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].isUserCreated`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].requiredLogin`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricingType`	`string ["Free","MonthlyUSD","YearlyUSD","MonthlyTraderpoints","YearlyTraderpoints"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.type`	`string ["Free","MonthlyUSD","YearlyUSD","MonthlyTraderpoints","YearlyTraderpoints"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.isPaid`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.period`	`string ["free","monthly","yearly"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.paymentMode`	`string ["free","usd","traderpoints"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.amountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.traderpointsAmount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.canAccess`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.isOwner`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.isFree`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.hasActiveAccess`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.accessEndDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].selectedForPost`	`integer [0,1]`	`No`
`$.oneOf[0].allOf[1].Payload.app.anyOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.postID`	`integer`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/appsv2/set_about_post",
    "RequestUserAlias": "example-user",
    "Payload": {
        "app": {
            "id": "synthetic-example",
            "slug": "synthetic-example",
            "name": "synthetic-example",
            "description": "synthetic-example",
            "icon": "synthetic-example",
            "entryUrl": "synthetic-example",
            "defaultPath": "synthetic-example",
            "contentWidth": "synthetic-example",
            "dbID": 0,
            "ownerUserID": 0,
            "aboutPostID": 0,
            "priceAmount": 0,
            "menu": [],
            "isUserCreated": true,
            "requiredLogin": true,
            "pricingType": "Free",
            "pricing": {
                "type": "Free",
                "isPaid": 0,
                "period": "free",
                "paymentMode": "free",
                "amountCents": 0,
                "traderpointsAmount": 0,
                "label": "synthetic-example"
            }
        },
        "postID": 0
    }
}

Machine-readable endpoint documentation

POST

/v1/appsv2/set_create

Create a new user-published app row in the v2 appstore.

Parameters

Name	Type	Required	Default	Description
`name`	`string`	`Yes`	`—`	Display name shown in the appstore card and the host shell.
`slug`	`string`	`Yes`	`—`	Lowercase URL slug ([a-z0-9-]+, 2-64 chars).
`entry_url`	`string`	`Yes`	`—`	Absolute http(s) URL or root-relative path loaded into the sandboxed iframe.
`description`	`string`	`No`	`""`	Optional short description shown on the appstore card.
`icon`	`string`	`No`	`""`	Optional sprite reference (e.g. "i-trending-bars"). Empty string allowed.
`pricingType`	`string`	`No`	`"Free"`	One of Free, MonthlyUSD, YearlyUSD, MonthlyTraderpoints, YearlyTraderpoints.
`priceAmount`	`int`	`No`	`0`	Price in USD cents for paid monthly/yearly access.
`aboutPostID`	`int`	`No`	`0`	Optional public post ID with at least two images to use as the About my app post.
`isWritingRequest`	`bool`	`No`	`false`	Set true to actually persist the app.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/appsv2/set_create' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'name={{name}}' \
  --data-urlencode 'slug={{slug}}' \
  --data-urlencode 'entry_url={{entry_url}}' \
  --data-urlencode 'description={{description}}' \
  --data-urlencode 'icon={{icon}}' \
  --data-urlencode 'pricingType={{pricingType}}' \
  --data-urlencode 'priceAmount={{priceAmount}}' \
  --data-urlencode 'aboutPostID={{aboutPostID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`appsv2_set_create_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app`		`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].id`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].icon`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].entryUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].defaultPath`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].contentWidth`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].dbID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].ownerUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].aboutPostID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].priceAmount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].menu`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].isUserCreated`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].requiredLogin`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricingType`	`string ["Free","MonthlyUSD","YearlyUSD","MonthlyTraderpoints","YearlyTraderpoints"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.type`	`string ["Free","MonthlyUSD","YearlyUSD","MonthlyTraderpoints","YearlyTraderpoints"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.isPaid`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.period`	`string ["free","monthly","yearly"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.paymentMode`	`string ["free","usd","traderpoints"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.amountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.traderpointsAmount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.canAccess`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.isOwner`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.isFree`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.hasActiveAccess`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.accessEndDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].selectedForPost`	`integer [0,1]`	`No`
`$.oneOf[0].allOf[1].Payload.app.anyOf[1]`	`array`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/appsv2/set_create",
    "RequestUserAlias": "example-user",
    "Payload": {
        "id": 0,
        "slug": "synthetic-example",
        "app": {
            "id": "synthetic-example",
            "slug": "synthetic-example",
            "name": "synthetic-example",
            "description": "synthetic-example",
            "icon": "synthetic-example",
            "entryUrl": "synthetic-example",
            "defaultPath": "synthetic-example",
            "contentWidth": "synthetic-example",
            "dbID": 0,
            "ownerUserID": 0,
            "aboutPostID": 0,
            "priceAmount": 0,
            "menu": [],
            "isUserCreated": true,
            "requiredLogin": true,
            "pricingType": "Free",
            "pricing": {
                "type": "Free",
                "isPaid": 0,
                "period": "free",
                "paymentMode": "free",
                "amountCents": 0,
                "traderpointsAmount": 0,
                "label": "synthetic-example"
            }
        }
    }
}

Machine-readable endpoint documentation

POST

/v1/appsv2/set_update

Update a user-owned v2 app's storefront setup.

Parameters

Name	Type	Required	Default	Description
`appID`	`int`	`Yes`	`—`	ATAppsV2.ID of an app owned by the current user.
`name`	`string`	`Yes`	`—`	Display name shown in the appstore card and the host shell.
`entry_url`	`string`	`Yes`	`—`	Absolute http(s) URL or root-relative path loaded into the sandboxed iframe.
`description`	`string`	`No`	`""`	Optional short description shown on the appstore card.
`icon`	`string`	`No`	`""`	Optional sprite reference (e.g. "i-trending-bars"). Empty string allowed.
`pricingType`	`string`	`No`	`"Free"`	One of Free, MonthlyUSD, YearlyUSD, MonthlyTraderpoints, YearlyTraderpoints.
`priceAmount`	`int`	`No`	`0`	Price in USD cents for paid monthly/yearly access.
`aboutPostID`	`int`	`No`	`0`	Optional public post ID with at least two images to use as the About my app post.
`isWritingRequest`	`bool`	`No`	`false`	Set true to actually persist the app.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/appsv2/set_update' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'appID={{appID}}' \
  --data-urlencode 'name={{name}}' \
  --data-urlencode 'entry_url={{entry_url}}' \
  --data-urlencode 'description={{description}}' \
  --data-urlencode 'icon={{icon}}' \
  --data-urlencode 'pricingType={{pricingType}}' \
  --data-urlencode 'priceAmount={{priceAmount}}' \
  --data-urlencode 'aboutPostID={{aboutPostID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`appsv2_set_update_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.app`		`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].id`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].icon`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].entryUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].defaultPath`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].contentWidth`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].dbID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].ownerUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].aboutPostID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].priceAmount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].menu`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].isUserCreated`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].requiredLogin`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricingType`	`string ["Free","MonthlyUSD","YearlyUSD","MonthlyTraderpoints","YearlyTraderpoints"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.type`	`string ["Free","MonthlyUSD","YearlyUSD","MonthlyTraderpoints","YearlyTraderpoints"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.isPaid`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.period`	`string ["free","monthly","yearly"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.paymentMode`	`string ["free","usd","traderpoints"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.amountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.traderpointsAmount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].pricing.label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.canAccess`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.isOwner`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.isFree`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.hasActiveAccess`	`integer [0,1]`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].access.accessEndDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.app.anyOf[0].selectedForPost`	`integer [0,1]`	`No`
`$.oneOf[0].allOf[1].Payload.app.anyOf[1]`	`array`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/appsv2/set_update",
    "RequestUserAlias": "example-user",
    "Payload": {
        "app": {
            "id": "synthetic-example",
            "slug": "synthetic-example",
            "name": "synthetic-example",
            "description": "synthetic-example",
            "icon": "synthetic-example",
            "entryUrl": "synthetic-example",
            "defaultPath": "synthetic-example",
            "contentWidth": "synthetic-example",
            "dbID": 0,
            "ownerUserID": 0,
            "aboutPostID": 0,
            "priceAmount": 0,
            "menu": [],
            "isUserCreated": true,
            "requiredLogin": true,
            "pricingType": "Free",
            "pricing": {
                "type": "Free",
                "isPaid": 0,
                "period": "free",
                "paymentMode": "free",
                "amountCents": 0,
                "traderpointsAmount": 0,
                "label": "synthetic-example"
            }
        }
    }
}

Machine-readable endpoint documentation