GroupData

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/dottedsign-com/json-schema/dottedsign-com-group-data-schema.json",
  "title": "GroupData",
  "description": "Group data.",
  "x-generated": "2026-11-06",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/dottedsign-com-groups-api-openapi.yml#/components/schemas/GroupData",
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/$defs/Group"
    }
  },
  "$defs": {
    "DeclineOption": {
      "type": "object",
      "description": "Decline option.",
      "properties": {
        "decline_option_id": {
          "type": "integer",
          "description": "Decline option ID."
        },
        "status": {
          "type": "string",
          "description": "Decline option status.",
          "enum": [
            "active",
            "inactive"
          ]
        },
        "system_reserved": {
          "type": "boolean",
          "description": "If decline option is reserved by system."
        },
        "content": {
          "type": "string",
          "description": "Decline option content."
        }
      }
    },
    "Group": {
      "type": "object",
      "description": "Group.",
      "properties": {
        "group_id": {
          "type": "integer",
          "description": "Group ID."
        },
        "name": {
          "type": "string",
          "description": "Group name."
        },
        "status": {
          "type": "string",
          "description": "Group status.",
          "enum": [
            "active",
            "expired",
            "archived"
          ]
        },
        "email_sender_rule": {
          "type": "string",
          "description": "Display rule for email sender.",
          "enum": [
            "default",
            "custom_name",
            "sender_email",
            "sender_name"
          ]
        },
        "email_custom_name": {
          "type": "string",
          "description": "Custom name for email sender. *Required if `email_sender_rule` is provided.*"
        },
        "icon_url": {
          "type": "object",
          "properties": {
            "100": {
              "type": "string",
              "description": "Icon URL with 100px width."
            },
            "280": {
              "type": "string",
              "description": "Icon URL with 280px width."
            }
          }
        },
        "decline_options": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/DeclineOption"
          }
        }
      }
    }
  }
}