Rate this page:
GET /marketplace/catalog/partners/{partnerId}/promotions/paged
Get a list of promotions for the specified partner in paginated way. This resource requires authentication.
integer
The unique identifier for this partner
int64
integer
Number of result in the response (only for Server and Data Center)
10
, Minimum: 1
, Maximum: 1500
, Format: int64
integer
If specified, skips ahead by this number of items (only for Server and Data Center)
0
, Format: int64
anything
If specified, sorts the promotions based on the supplied order by parameter. Uses descending order by default.
CREATION_DATE
boolean
If specified, returns active promotions only
false
anything
If specified, filters promotions based on the supplied hosting type parameter
string
If specified, filters promotions based on the supplied app key
boolean
If specified, sorts promotion in ascending order
false
string
To navigate in the forward direction, provide the next page Id (only for cloud Promotions)
string
To navigate in the backward direction, provide the previous page Id (only for cloud Promotions)
1 2 3 4
curl --request GET \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/paged' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'
Content type | Value |
---|---|
application/json |
GET /marketplace/catalog/partners/{partnerId}/promotions
Get a list of promotions for the specified partner.
This resource requires authentication.
It is strongly recommended to use paginated API. Refer Get promotions paged
integer
The unique identifier for this partner
int64
1 2 3 4
curl --request GET \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'
Content type | Value |
---|---|
application/json |
POST /marketplace/catalog/partners/{partnerId}/promotions
Create a new promotion for the specified partner. This resource requires authentication.
integer
The unique identifier for this partner
int64
string
Name of the promotion
Array<string>
App keys of the apps for which this promotion is applicable
string
Starting date of the promotion
date
string
Expiration date of the promotion
date
string
Indicates whether this is a shared or single-use promotion
Valid values: SHARED_PROMOTION
, SINGLE_USE_PROMOTION
string
Indicates whether the promotion uses flat discount or tiered discount
Valid values: FLAT_DISCOUNT
integer
Discount percentage if this promotion is based on a percentage discount
int32
integer
Maximum number of times this promotion can be used if it is a shared promotion
int32
string
Hosting environment of the apps for which this promotion is applicable.
Valid values: SERVER
, DATA_CENTER
, CLOUD
string
Used for cloud promotions to specify type of subscription.
Valid values: MONTHLY
, ANNUAL
integer
Number of billing cycles the promotions is valid for. Used for cloud promotions.
int32
boolean
True if the promotions is valid for unlimited uses.
string
Custom Promo code will be prefixed with an autogenerated string for a shared promotion. In case of any issue with the provided custom promo code, a random promocode will be generated. (Only for Cloud Promotions)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
curl --request POST \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"eligibleApps": [
"<string>"
],
"startDate": "<string>",
"expirationDate": "<string>",
"promotionType": "SHARED_PROMOTION",
"discountType": "FLAT_DISCOUNT",
"discountPercent": 71,
"maxUses": 78,
"hostingType": "SERVER",
"subscriptionType": "MONTHLY",
"allowedBillingCycles": 80,
"allowUnlimitedUses": true,
"customPromoCode": "<string>"
}'
Successfully created
Content type | Value |
---|---|
application/json |
GET /marketplace/catalog/partners/{partnerId}/promotions/{promotionId}
Get a specific promotion for the specified partner. This resource requires authentication.
integer
The unique identifier for this partner
int64
string
The unique identifier for this promotion. (UUID for Cloud promotions and string for Server/DC promotions)
1 2 3 4
curl --request GET \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'
Content type | Value |
---|---|
application/json |
PATCH /marketplace/catalog/partners/{partnerId}/promotions/{promotionId}
Update a specific promotion for the specified partner. This resource requires authentication.
integer
The unique identifier for this partner
int64
string
The unique identifier for this promotion. (UUID for Cloud promotions and string for Server/DC promotions)
string
Name of the promotion
string
Starting date of the promotion
date
string
Expiration date of the promotion
date
integer
Discount percentage if this promotion is based on a percentage discount
int32
integer
Maximum number of times this promotion can be used if it is a shared promotion
int32
integer
Number of billing cycles the promotions is valid for. Used for cloud promotions.
int32
1 2 3 4 5 6 7 8 9 10 11 12
curl --request PATCH \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}' \
--user 'email@example.com:<api_token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"startDate": "<string>",
"expirationDate": "<string>",
"discountPercent": 71,
"maxUses": 78,
"allowedBillingCycles": 80
}'
Successfully modified
A schema has not been defined for this response code.
GET /marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes
Get a list of single-use codes for the specified promotion.
This resource requires authentication.
integer
The unique identifier for this partner
int64
string
The unique identifier for this promotion. (UUID for Cloud promotions and string for Server/DC promotions)
1 2 3 4
curl --request GET \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'
Content type | Value |
---|---|
application/json |
POST /marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes
Create a new single-use code for the specified promotion.
This resource requires authentication.
integer
The unique identifier for this partner
int64
string
The unique identifier for this promotion. (UUID for Cloud promotions and string for Server/DC promotions)
1 2 3
curl --request POST \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes' \
--user 'email@example.com:<api_token>'
Successfully created
A schema has not been defined for this response code.
GET /marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes/{promotionCode}
Get a specific single-use code for the specified promotion.
This resource requires authentication.
integer
The unique identifier for this partner
int64
string
The unique identifier for this promotion. (UUID for Cloud promotions and string for Server/DC promotions)
integer
The unique identifier for this promotion code
int32
1 2 3 4
curl --request GET \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes/{promotionCode}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'
Content type | Value |
---|---|
application/json |
DELETE /marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes/{promotionCode}
Delete a specific single-use code for a specific promotion associated with a specific partner.
This resource requires authentication.
integer
The unique identifier for this partner
int64
string
The unique identifier for this promotion. (UUID for Cloud promotions and string for Server/DC promotions)
integer
The unique identifier for this promotion code
int32
1 2 3
curl --request DELETE \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes/{promotionCode}' \
--user 'email@example.com:<api_token>'
Successfully deleted
A schema has not been defined for this response code.
GET /marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/status
Get a specific promotion status for the specified partner. This resource requires authentication.
integer
The unique identifier for this partner
int64
string
The unique identifier for this promotion. (UUID for Cloud promotions and string for Server/DC promotions)
1 2 3 4
curl --request GET \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/status' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'
Content type | Value | Restrictions |
---|---|---|
application/json | string | Valid values: |
Rate this page: