Rate this page:
Information about vendor promotions
GET /rest/2/vendors/{vendorId}/promotions
Get a list of promotions for the specified vendor.
This resource requires authentication.
This is a deprecated API. Refer Get promotions for the new API details
integer
The unique identifier for this vendor
int64
1 2 3 4
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'
Content type | Value |
---|---|
application/json |
POST /rest/2/vendors/{vendorId}/promotions
Create a new promotion for the specified vendor.
This resource requires authentication.
This is a deprecated API. Refer Create promotion for the new API details
integer
The unique identifier for this vendor
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
Current status of the promotion
Valid values: ACTIVE
, ENDED-EARLY
, EXPIRED
string
Indicates whether this is a shared or single-use promotion
Valid values: MULTI
, SINGLE
string
Indicates whether the promotion uses percentage discounts or dollar amounts
Valid values: FLAT
, PERCENTAGE
integer
Discount percentage if this promotion is based on a percentage discount
int32
boolean
True if the promotion applies to all license types
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. Allowed values are server
or datacenter
, defaulting to server
.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
curl --request POST \
--url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions' \
--user 'email@example.com:<api_token>' \
--header 'Content-Type: application/json' \
--data '{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"edit": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"status": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"codes": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"usage": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"name": "<string>",
"products": [
"<string>"
],
"startDate": "<string>",
"expirationDate": "<string>",
"status": "ACTIVE",
"usageType": "MULTI",
"discountType": "FLAT",
"discountPercent": 71,
"appliesToAllLicenseTypes": true,
"maxUses": 78,
"hosting": "<string>"
}'
Successfully created
A schema has not been defined for this response code.
string
URI of the new resource
GET /rest/2/vendors/{vendorId}/promotions/{promotionId}
Get a specific promotion for the specified vendor.
This resource requires authentication.
This is a deprecated API. Refer Get promotion for the new API details
integer
The unique identifier for this vendor
int64
string
The unique identifier for this promotion
1 2 3 4
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'
Content type | Value |
---|---|
application/json |
PATCH /rest/2/vendors/{vendorId}/promotions/{promotionId}
Update a specific promotion for the specified vendor.
The request body must be a valid JSON Patch document. The properties which can be referenced in the PATCH are the same ones returned by a GET on this URI.
This resource requires authentication.
This is a deprecated API. Refer Update promotion for the new API details
integer
The unique identifier for this vendor
int64
string
The unique identifier for this promotion
Content type | Value |
---|---|
application/json-patch+json | Array<JsonPatchDocumentation> |
1 2 3
curl --request PATCH \
--url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}' \
--user 'email@example.com:<api_token>'
Successfully modified
string
URI of the resource
GET /rest/2/vendors/{vendorId}/promotions/{promotionId}/codes
Get a list of single-use codes for the specified promotion.
This resource requires authentication.
This is a deprecated API. Refer Get promotion codes for the new API details
integer
The unique identifier for this vendor
int64
string
The unique identifier for this promotion
1 2 3 4
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}/codes' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'
Content type | Value |
---|---|
application/json |
POST /rest/2/vendors/{vendorId}/promotions/{promotionId}/codes
Create a new single-use code for the specified promotion.
This resource requires authentication.
This is a deprecated API. Refer Create promotion code for the new API details
integer
The unique identifier for this vendor
int64
string
The unique identifier for this promotion
1 2 3 4
curl --request POST \
--url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}/codes' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'
Content type | Value |
---|---|
application/json |
GET /rest/2/vendors/{vendorId}/promotions/{promotionId}/codes/{promotionCode}
Get a specific single-use code for the specified promotion.
This resource requires authentication.
This is a deprecated API. Refer Get promotion code for the new API details
integer
The unique identifier for this vendor
int64
string
The unique identifier for this promotion
string
1 2 3 4
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}/codes/{promotionCode}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'
Content type | Value |
---|---|
application/json |
DELETE /rest/2/vendors/{vendorId}/promotions/{promotionId}/codes/{promotionCode}
Delete a specific single-use code for a specific promotion associated with a specific vendor.
Promotion codes can only be deleted prior to their use.
This resource requires authentication.
This is a deprecated API. Refer Delete promotion code for the new API details
integer
The unique identifier for this vendor
int64
string
The unique identifier for this promotion
string
1 2 3
curl --request DELETE \
--url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}/codes/{promotionCode}' \
--user 'email@example.com:<api_token>'
Successfully deleted
A schema has not been defined for this response code.
GET /rest/2/vendors/{vendorId}/promotions/{promotionId}/status
Get a specific promotion status for the specified vendor.
This resource requires authentication.
This is a deprecated API. Refer Get promotion status for the new API details
integer
The unique identifier for this vendor
int64
string
The unique identifier for this promotion
1 2 3 4
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/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: