Email Domain Sets
Returns every email domain set in the catalog. Root-account and sub-account keys see the same list.
Filter email domain sets by name
When set, only return exact name matches
email domain sets listed
GET /api/v1/email_domain_sets HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*
email domain sets listed
{
"email_domain_sets": [
{
"id": 1,
"name": "text",
"account_id": 1,
"email_domains": [
{
"id": 1,
"domain": "text",
"email_domain_set_id": 1,
"canvas_root_account_uuid": "text",
"created_at": "text",
"updated_at": "text",
"deleted_at": "text"
}
]
}
],
"meta": {
"total_pages": 1
}
}Returns any email domain set in the catalog, whichever account owns it.
Email domain set ID
email domain set found
Email domain set ID
Name of the email domain set
Owning account ID
GET /api/v1/email_domain_sets/{id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*
email domain set found
{
"id": 1,
"name": "text",
"account_id": 1,
"canvas_root_account_uuid": "text",
"created_at": "text",
"updated_at": "text",
"deleted_at": "text"
}Requires a root-account key. A sub-account key is rejected with 403, even for a set in its own subtree.
Email domain set ID
email domain set updated
requires a root-account API key
PUT /api/v1/email_domain_sets/{id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"email_domain_set": {
"name": "text",
"email_domains_attributes": [
{
"domain": "text"
}
]
}
}{
"email_domain_set": {
"id": 1,
"name": "text",
"account_id": 1,
"email_domains": [
{
"id": 1,
"domain": "text",
"email_domain_set_id": 1,
"canvas_root_account_uuid": "text",
"created_at": "text",
"updated_at": "text",
"deleted_at": "text"
}
]
}
}Returns the promotions restricted to this set that belong to the key's account or its sub-accounts.
Email domain set ID
promotions listed
GET /api/v1/email_domain_sets/{id}/promotions HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*
promotions listed
{
"promotions": [
{
"id": 1,
"account_id": 1,
"product_id": 1,
"product_title": "text",
"product_archived_at": "text",
"account_name": "text",
"currency": "text",
"amount": "text",
"discount_type": "text",
"code": "text",
"name": "text",
"description": "text",
"active": true,
"start_date": "text",
"end_date": "text",
"created_at": "text",
"updated_at": "text",
"deleted_at": "text",
"usage_type": "text",
"canvas_root_account_uuid": "text",
"email_domain_set_id": 1,
"email_domain_set_name": "text",
"email_domains": [
{
"id": 1,
"domain": "text",
"email_domain_set_id": 1,
"canvas_root_account_uuid": "text",
"created_at": "text",
"updated_at": "text",
"deleted_at": "text"
}
],
"status": "text",
"max_per_user": 1,
"max_total_use": 1,
"enable_for_multi_seat_purchases": true
}
]
}Last updated
Was this helpful?