SharedCampaignRecordSet

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/telnyx/json-schema/telnyx-shared-campaign-record-set-schema.json",
  "title": "SharedCampaignRecordSet",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-shared-campaigns-api-openapi.yml#/components/schemas/SharedCampaignRecordSet",
  "properties": {
    "page": {
      "title": "Page",
      "type": "integer"
    },
    "records": {
      "items": {
        "$ref": "#/$defs/SharedCampaign"
      },
      "title": "Records",
      "type": "array"
    },
    "totalRecords": {
      "title": "Totalrecords",
      "type": "integer"
    }
  },
  "type": "object",
  "$defs": {
    "SharedCampaign": {
      "description": "Campaign is generated by the 10DLC registry once the corresponding campaign request is approved. Each campaign is assigned a unique identifier - **campaignId**. Once a campaign is activated, limited information is published to the NetNumber OSR service for consumption by members of the ecosystem. When a campaign is suspended(reversible) or expired(non-reversible), campaign data is deleted from the OSR service. Most attributes of campaignare immutable, including **usecase**, **vertical**, **brandId** and **cspId**.",
      "properties": {
        "brandId": {
          "description": "Alphanumeric identifier of the brand associated with this campaign.",
          "title": "Brandid",
          "type": "string"
        },
        "campaignId": {
          "description": "Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC.",
          "title": "Campaignid",
          "type": "string"
        },
        "createDate": {
          "description": "Unix timestamp when campaign was created.",
          "title": "Createdate",
          "type": "string"
        },
        "status": {
          "description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
          "title": "Status",
          "type": "string"
        },
        "usecase": {
          "description": "Campaign usecase. Must be of defined valid types. Use `/10dlc/enum/usecase` operation to retrieve usecases available for given brand.",
          "title": "Usecase",
          "type": "string"
        }
      },
      "required": [
        "brandId",
        "campaignId",
        "usecase"
      ],
      "title": "SharedCampaign",
      "type": "object"
    }
  }
}