Check Eligibility for Ad Space Capacity Allocation Action

Validate line item quantities and industry eligibility against the selected ad space before adding it to a media plan.

This action is available in API version 68.0 and later.

Special Access Rules 

To access this action, ensure that you have the Media Cloud Base user permission set enabled.

Supported REST HTTP Methods 

URI: /services/data/v68.0/actions/standard/checkEligForAdSpaceCptyAlloc

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a variable.

Inputs 

InputTypeDescription
opportunityIdstringRequired.
The ID of the opportunity associated with the media plan where slots are added.
adSpaceDetailsApexRequired.
The details of the ad space for creating line items in bulk.

Outputs 

OutputTypeDescription
isSuccessbooleanIndicates whether the validation was executed.
errorMessagestringThe error message that’s displayed if the validation fails.

Example 

POST

This sample request is for the Check Eligibility for Ad Space Capacity Allocation action.

1{
2  "inputs": [
3    {
4      "opportunityId": "006xx0000004CjrAAE",
5      "adSpaceDetails": {
6        "adSpaceId": "a0xxx0000004CjrAAE",
7        "quantity": 10
8      }
9    }
10  ]
11}

This sample response is for the Check Eligibility for Ad Space Capacity Allocation action.

1[
2  {
3    "actionName": "checkEligForAdSpaceCptyAlloc",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outputValues": {
8      "isSuccess": true,
9      "errorMessage": null
10    },
11    "sortOrder": -1,
12    "version": 1
13  }
14]