ConstituentSolicitCodeReadCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/blackbaud/main/json-schema/blackbaud-constituent-solicit-code-read-collection-schema.json",
  "title": "ConstituentSolicitCodeReadCollection",
  "description": "A collection of constituent solicit codes.",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/blackbaud-communication-preference-api-openapi.yml#/components/schemas/ConstituentSolicitCodeReadCollection",
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "description": "The number of constituent solicit codes in the list.",
      "format": "int32",
      "readOnly": true
    },
    "value": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/ConstituentSolicitCodeRead"
      },
      "description": "The set of constituent solicit codes included in the response."
    }
  },
  "additionalProperties": false,
  "$defs": {
    "ConstituentSolicitCodeRead": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "string",
            "null"
          ],
          "description": "The immutable system record ID of the constituent solicit code."
        },
        "constituent_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "The immutable system record ID of the constituent associated with the solicit code."
        },
        "end_date": {
          "type": [
            "string",
            "null"
          ],
          "description": "The end date of the solicit code. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
          "format": "date-time"
        },
        "solicit_code": {
          "type": [
            "string",
            "null"
          ],
          "description": "Communication instructions and/or restrictions for a constituent. Available values can be obtained from the <a href=\"https://developer.sky.blackbaud.com/docs/services/communication-preference/operations/ListSolicitCodes\">Solicit Codes List</a>."
        },
        "start_date": {
          "type": [
            "string",
            "null"
          ],
          "description": "The start date of the solicit code. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
          "format": "date-time"
        }
      },
      "additionalProperties": false,
      "description": "Solicit codes provide guidance on how to contact constituents. These rules describe instructions and restrictions about when to reach out to constituents and how to tailor communications to honor their requests."
    }
  }
}