logo

Upsert an application instance configuration

Creates or updates (upserts) an application instance configuration.

SecuritySecretApiKey or JWT or ApplicationJWT
Request
path Parameters
applicationId
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the application.

Request Body schema: application/json
required
object

Configuration settings that are available during installation.

property name*
additional property
string

Additional properties that the user may want to add when installing an application.

Responses
200

Application instance configuration updated.

Response Schema: application/json
required
object

Configuration settings that are available during installation.

property name*
additional property
string

Additional properties that the user may want to add when installing an application.

Array of objects

Related links.

Array
rel
string

Type of link.

Enum: Description
self

Link to the application instance configuration.

configuration

Link to the external resource where the application instance must be configured. This field contains a JWT in the query parameter. Direct the user to this URL where application settings must be submitted.

href
string

Link URL.

201

Application instance configuration created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
required
object

Configuration settings that are available during installation.

property name*
additional property
string

Additional properties that the user may want to add when installing an application.

Array of objects

Related links.

Array
rel
string

Type of link.

Enum: Description
self

Link to the application instance configuration.

configuration

Link to the external resource where the application instance must be configured. This field contains a JWT in the query parameter. Direct the user to this URL where application settings must be submitted.

href
string

Link URL.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

put/application-instances/{applicationId}/configuration
Request samples
application/json
{
  • "settings": {
    }
}
Response samples
application/json
{
  • "settings": {
    },
  • "_links": [
    ]
}
➔ Next to Retrieve applications