Qualify a Brand for All Use Cases

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

Endpoint

GET /v1/brands/{id}/qualification

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.

Request Body

None

Returns

Returns an array of Use Case objects containing the use cases the brand is qualified to run.

The following information is returned for each use case: 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"
      }
    ]
  }
]