Email Domain Sets

List email domain sets

get

Authorizations

api_key

AuthorizationstringRequired

Query parameters

searchstringOptional

Filter email domain sets by name

exactstringOptional

When set, only return exact name matches

Responses

200

email domain sets listed

application/json

get/api/v1/email_domain_sets

HTTPcURLJavaScriptPython

GET /api/v1/email_domain_sets HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*

200

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
  }
}

Get a specific email domain set

get

Authorizations

api_key

AuthorizationstringRequired

Path parameters

idintegerRequired

Email domain set ID

Responses

200

email domain set found

application/json

idintegerRequired

Email domain set ID

namestringRequired

Name of the email domain set

account_idintegerRequired

Owning account ID

canvas_root_account_uuidstringRequired

created_atstringRequired

updated_atstringRequired

deleted_atstring · nullableRequired

get/api/v1/email_domain_sets/{id}

HTTPcURLJavaScriptPython

GET /api/v1/email_domain_sets/{id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*

200

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"
}

Update an email domain set

put

Authorizations

api_key

AuthorizationstringRequired

Path parameters

idintegerRequired

Email domain set ID

Body

application/json

Responses

200

email domain set updated

application/json

put/api/v1/email_domain_sets/{id}

HTTPcURLJavaScriptPython

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"
      }
    ]
  }
}

200

email domain set updated

{
  "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"
      }
    ]
  }
}

List promotions for an email domain set

get

Authorizations

api_key

AuthorizationstringRequired

Path parameters

idintegerRequired

Email domain set ID

Responses

200

promotions listed

application/json

get/api/v1/email_domain_sets/{id}/promotions

HTTPcURLJavaScriptPython

GET /api/v1/email_domain_sets/{id}/promotions HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*

200

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
    }
  ]
}