Pushes the offer's plan, add-ons and, when asked, its promotion to the entitlements made from it: each gets the offer's plan and the add-ons the offer gives, and loses the ones the offer no longer gives. Preview first with a dry run.
const url = 'https://example.com/api/v1/provision/admin/entitlements/offers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/push?dryRun=false';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"includeDeviating":true,"includePromotion":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url 'https://example.com/api/v1/provision/admin/entitlements/offers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/push?dryRun=false' \ --header 'Content-Type: application/json' \ --data '{ "includeDeviating": true, "includePromotion": true }'With includePromotion, each also gets the offer’s running promotion as a temporary plan override
that ends on the promotion’s end date, with a plan-override touch of its campaign; it replaces an earlier
promotion of the same offer only. Entitlements that deviate from the offer are skipped, unless
includeDeviating is set; then the offer wins over the customer’s change, except that an add-on added
for that customer alone stays. An entitlement with any other running temporary override (a trial, a lapsed
payment, one set for that customer) is always skipped: no push ends one. Under the offer’s own promotion,
the offer’s plan becomes the plan the promotion returns to. Each changed entitlement gets an audit entry and
the usual plan-applied and add-on events. One the rules refuse is listed under failed with the
reason and left as it was, and the push goes on with the rest. Refused for an archived offer.
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The offer.
Query Parameters
Section titled “Query Parameters”Change nothing, and say what the push would change.
Request Bodyrequired
Section titled “Request Bodyrequired”Whether deviating entitlements are included, and whether the promotion is given.
How an offer’s plan and add-ons are pushed to the entitlements made from it.
object
Push to the entitlements that deviate from the offer too. The offer then wins over the customer’s change: the plan is set back to the offer’s, an add-on the offer gives is granted again where it was revoked, and a promotion ended for that customer is given again. An add-on added for that customer alone stays, and an entitlement with a running temporary override other than this offer’s promotion (a trial, a lapsed payment) is still skipped. Without it, deviating entitlements are skipped.
Give the offer’s running promotion too (OfferPromotionDto? EntitlementDto.Promotion), as a temporary plan override that ends on the promotion’s end date. It replaces an earlier promotion of the same offer, and never any other temporary override. Without it, promotions are left as they are.
Examplegenerated
{ "includeDeviating": true, "includePromotion": true}How an offer’s plan and add-ons are pushed to the entitlements made from it.
object
Push to the entitlements that deviate from the offer too. The offer then wins over the customer’s change: the plan is set back to the offer’s, an add-on the offer gives is granted again where it was revoked, and a promotion ended for that customer is given again. An add-on added for that customer alone stays, and an entitlement with a running temporary override other than this offer’s promotion (a trial, a lapsed payment) is still skipped. Without it, deviating entitlements are skipped.
Give the offer’s running promotion too (OfferPromotionDto? EntitlementDto.Promotion), as a temporary plan override that ends on the promotion’s end date. It replaces an earlier promotion of the same offer, and never any other temporary override. Without it, promotions are left as they are.
Examplegenerated
{ "includeDeviating": true, "includePromotion": true}How an offer’s plan and add-ons are pushed to the entitlements made from it.
object
Push to the entitlements that deviate from the offer too. The offer then wins over the customer’s change: the plan is set back to the offer’s, an add-on the offer gives is granted again where it was revoked, and a promotion ended for that customer is given again. An add-on added for that customer alone stays, and an entitlement with a running temporary override other than this offer’s promotion (a trial, a lapsed payment) is still skipped. Without it, deviating entitlements are skipped.
Give the offer’s running promotion too (OfferPromotionDto? EntitlementDto.Promotion), as a temporary plan override that ends on the promotion’s end date. It replaces an earlier promotion of the same offer, and never any other temporary override. Without it, promotions are left as they are.
Examplegenerated
{ "includeDeviating": true, "includePromotion": true}Responses
Section titled “Responses”OK
What a push of an offer’s plan and add-ons changed on the entitlements made from it, or with a dry run would change. Every entitlement made from the offer is counted once: changed, up to date, skipped or failed.
object
True when nothing was changed and the counts say what the push would do.
The offer’s plan the push sets; null when the offer has none, and plans are left as they are.
The add-ons the offer gives, which the push grants where they are missing.
The promotion the push gives: the offer’s, when the push includes it and it is running. Null otherwise, and promotions are left as they are.
object
The campaign it runs under; each entitlement given it counts as a plan-override touch of the campaign.
Recorded as the reason of each temporary override it becomes.
The entitlements made from the offer, try licenses left out.
Entitlements the push changed, or would change.
Entitlements that already hold what the offer gives.
Deviating entitlements left as they are: not included, or held by a running temporary override other than this offer’s promotion, which a push never ends.
Entitlements the push could not change, or would not be able to; List<OfferPushFailureDto> OfferPushResultDto.Failed says why.
Every entitlement that deviates from the offer, with why, whether it was skipped or included.
One entitlement made from an offer (its Guid? EntitlementDto.OriginOfferId), and whether it deviates from what the offer gave it: a change made to this customer since, which wins over the offer.
object
Admin-controlled lifecycle state of an entitlement.
True when at least one facet deviates; List<OfferDeviationDto> OfferEntitlementDto.Deviations says which and why.
Each facet whose current value differs from what the offer gave the entitlement, with the reason.
A facet of an entitlement whose current value differs from what its offer gave it.
object
A part of an entitlement that an offer gives it and that can later be changed for that customer alone.
What changed and, where it is recorded, what changed it; for example an approved plan-change request.
The entitlements the push could not change, each with the reason. The others are changed all the same.
An entitlement a push could not change, and why.
object
What a push of an offer’s plan and add-ons changed on the entitlements made from it, or with a dry run would change. Every entitlement made from the offer is counted once: changed, up to date, skipped or failed.
object
True when nothing was changed and the counts say what the push would do.
The offer’s plan the push sets; null when the offer has none, and plans are left as they are.
The add-ons the offer gives, which the push grants where they are missing.
The promotion the push gives: the offer’s, when the push includes it and it is running. Null otherwise, and promotions are left as they are.
object
The campaign it runs under; each entitlement given it counts as a plan-override touch of the campaign.
Recorded as the reason of each temporary override it becomes.
The entitlements made from the offer, try licenses left out.
Entitlements the push changed, or would change.
Entitlements that already hold what the offer gives.
Deviating entitlements left as they are: not included, or held by a running temporary override other than this offer’s promotion, which a push never ends.
Entitlements the push could not change, or would not be able to; List<OfferPushFailureDto> OfferPushResultDto.Failed says why.
Every entitlement that deviates from the offer, with why, whether it was skipped or included.
One entitlement made from an offer (its Guid? EntitlementDto.OriginOfferId), and whether it deviates from what the offer gave it: a change made to this customer since, which wins over the offer.
object
Admin-controlled lifecycle state of an entitlement.
True when at least one facet deviates; List<OfferDeviationDto> OfferEntitlementDto.Deviations says which and why.
Each facet whose current value differs from what the offer gave the entitlement, with the reason.
A facet of an entitlement whose current value differs from what its offer gave it.
object
A part of an entitlement that an offer gives it and that can later be changed for that customer alone.
What changed and, where it is recorded, what changed it; for example an approved plan-change request.
The entitlements the push could not change, each with the reason. The others are changed all the same.
An entitlement a push could not change, and why.
object
Example
{ "deviating": [ { "status": "Draft", "deviations": [ { "facet": "Plan" } ] } ]}What a push of an offer’s plan and add-ons changed on the entitlements made from it, or with a dry run would change. Every entitlement made from the offer is counted once: changed, up to date, skipped or failed.
object
True when nothing was changed and the counts say what the push would do.
The offer’s plan the push sets; null when the offer has none, and plans are left as they are.
The add-ons the offer gives, which the push grants where they are missing.
The promotion the push gives: the offer’s, when the push includes it and it is running. Null otherwise, and promotions are left as they are.
object
The campaign it runs under; each entitlement given it counts as a plan-override touch of the campaign.
Recorded as the reason of each temporary override it becomes.
The entitlements made from the offer, try licenses left out.
Entitlements the push changed, or would change.
Entitlements that already hold what the offer gives.
Deviating entitlements left as they are: not included, or held by a running temporary override other than this offer’s promotion, which a push never ends.
Entitlements the push could not change, or would not be able to; List<OfferPushFailureDto> OfferPushResultDto.Failed says why.
Every entitlement that deviates from the offer, with why, whether it was skipped or included.
One entitlement made from an offer (its Guid? EntitlementDto.OriginOfferId), and whether it deviates from what the offer gave it: a change made to this customer since, which wins over the offer.
object
Admin-controlled lifecycle state of an entitlement.
True when at least one facet deviates; List<OfferDeviationDto> OfferEntitlementDto.Deviations says which and why.
Each facet whose current value differs from what the offer gave the entitlement, with the reason.
A facet of an entitlement whose current value differs from what its offer gave it.
object
A part of an entitlement that an offer gives it and that can later be changed for that customer alone.
What changed and, where it is recorded, what changed it; for example an approved plan-change request.
The entitlements the push could not change, each with the reason. The others are changed all the same.
An entitlement a push could not change, and why.
object
Example
{ "deviating": [ { "status": "Draft", "deviations": [ { "facet": "Plan" } ] } ]}Bad Request
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}