Campaign

Qualify By Usecase

Changed on

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

get/10dlc/campaignBuilder/brand/{brandId}/usecase/{usecase}

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/10dlc/campaignBuilder/brand/{brandId}/usecase/{usecase}
  • Auth: HTTP bearer

Path parameters

usecasestring required

Unique identifier of the usecase.

brandIdstring required

Unique identifier of the brand.

Response

Successful Response

annualFeenumber

Campaign annual subscription fee

maxSubUsecasesinteger

Maximum number of sub-usecases declaration required.

minSubUsecasesinteger

Minimum number of sub-usecases declaration required.

mnoMetadataobject

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.

monthlyFeenumber

Campaign monthly subscription fee

quarterlyFeenumber

Campaign quarterly subscription fee

usecasestring

Campaign usecase

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • info

      added the optional property // to the response with the status