Qualify a Brand by Use Case

Determine if a brand is qualified to run a campaign for a specific use case. The brand’s qualification is checked across participating MNOs.

Endpoint

GET /v1/brands/{id}/qualification/usecases/{usecaseId}

Authorization Header

Authorization: Bearer <access_token>
or
Authorization: Basic <encodedString>
where <encodedString> is your <api-key>:<api-secret> string encoded using Base64 encoding

Path Parameters

id REQUIRED

string (UUID)

Unique ID assigned to the brand in RocketCOMS.

usecaseId REQUIRED

string (UUID)

Unique ID representing the use case. Use the List Use Cases API to retrieve a list of available UUIDs and their corresponding descriptions.

Request Body

None

Returns

If the brand is qualified to run the campaign on one or more MNOs, the following information is returned: 1) the use case details, including pricing and sub use case requirements, and 2) the use case attributes and restrictions for each MNO. For details, see the Use Case object.

SAMPLE RESPONSE

				
					[
  {
    "usecase": "Marketing",
    "monthlyFee": 0,
    "quarterlyFee": 0,
    "annualFee": 0,
    "minSubUsecases": 0,
    "maxSubUsecases": 0,
    "mnoMetadata": [
      {
        "tpmScope": "string",
        "minMsgSamples": 0,
        "msgClass": "string",
        "reqSubscriberOptout": true,
        "mnoReview": true,
        "noEmbeddedPhone": true,
        "mno": "string",
        "tpm": 0,
        "reqSubscriberHelp": true,
        "reqSubscriberOptin": true,
        "mnoSupport": true,
        "noEmbeddedLink": true,
        "qualify": true,
        "brandDailyCap": 0,
        "brandTier": "string"
      }
    ]
  }
]