Skip to main content

DomainProfileCollection Schema

Data structure for Domain Profile Collection objects.

Item Type​

This is a collection (list) of DomainProfile items.

Usage​

# Example: Working with DomainProfileCollection
items = [
    {"custom_domains":[],"description":"description-value-1","include_company_domains":true,"include_subdomains":true,"predefined_email_domains":[]},
    {"custom_domains":[],"description":"description-value-2","include_company_domains":true,"include_subdomains":true,"predefined_email_domains":[]}
]

# Pass to an action that requires this collection type
resource.some_action(body=items)

JSON Example​

[
  {
    "custom_domains": [],
    "description": "description-value-1",
    "include_company_domains": true,
    "include_subdomains": true,
    "predefined_email_domains": []
  },
  {
    "custom_domains": [],
    "description": "description-value-2",
    "include_company_domains": true,
    "include_subdomains": true,
    "predefined_email_domains": []
  }
]