POST /applications

Registers an application and displays it publicly in the App Store. Before you submit an application, read the App Store documentation.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
logoId String Yes

Unique identifier of the file that contains the application logo.

configuredBy String No

Specifies who can configure the application.

Valid values:

  • "application"
  • "user"
description String Yes

Detailed description of the application. This field accepts markdown and simple text.

properties Object No

Defines settings that users complete when they install the application. This field accepts JSON-schema drafts 4, 6, and 7.

createdTime String No

Date and time when the resource is created. This value is set automatically when the resource is created.

authorLogoId String No

Unique identifier of the file that contains the logo of the author.

status String No

Current status of the application in the App Store.

Valid values:

  • "available"
  • "disabled"
  • "pending-approval"
authorName String Yes

Name of the person or organization that created the application.

permissions[] Array Yes

List of permissions that are available to the application. To add permissions, contact Rebilly Support.

id String No

Unique identifier of the application.

_links[] Array No

Related links.

_links[].href String No

URL of the link.

_links[].rel String No

Type of link.

Valid values:

  • "logoUrl"
  • "authorLogoUrl"
  • "self"
  • "applicationInstance"
name String Yes

Name that is displayed for the application in the App Store.

tagline String Yes

Short descriptive tagline that is displayed for the application in the App Store.

updatedTime String No

Date and time when the resource is updated. This value is set automatically when the resource is updated.

configurationUrl String No

URL for configuring the application during installation.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.