Qualify By Usecase

GET 
/campaignBuilder/brand/:brandId/usecase/:usecase

This endpoint allows you to see whether or not the supplied brand is suitable for your desired campaign use case.

Path Parameters

usecase Usecaserequired
brandId Brandidrequired

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

annualFee Annualfee (number)

Campaign annual subscription fee

maxSubUsecases Maxsubusecases (integer)

Maximum number of sub-usecases declaration required.

minSubUsecases Minsubusecases (integer)

Minimum number of sub-usecases declaration required.

mnoMetadata object

Map of usecase metadata for each MNO. Key is the network ID of the MNO (e.g. 10017), Value is the mno metadata for the usecase.

monthlyFee Monthlyfee (number)

Campaign monthly subscription fee

quarterlyFee Quarterlyfee (number)

Campaign quarterly subscription fee

usecase Usecase (string)

Campaign usecase

{
  "annualFee": 0,
  "maxSubUsecases": 0,
  "minSubUsecases": 0,
  "mnoMetadata": {},
  "monthlyFee": 0,
  "quarterlyFee": 0,
  "usecase": "string"
}

422: Validation Error

application/json

• Schema
• Example (from schema)

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

• MOD1
• MOD2

string

integer

]

msg Message (string)required

type Error Type (string)required

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/10dlc/campaignBuilder/brand/:brandId/usecase/:usecase' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• 422

---

{
  "annualFee": 0,
  "maxSubUsecases": 0,
  "minSubUsecases": 0,
  "mnoMetadata": {},
  "monthlyFee": 0,
  "quarterlyFee": 0,
  "usecase": "string"
}

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}