Email Domain Set

get

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Path parameters

idintegerRequired

Responses

200

Getting a specific email domain set

application/json

get

/api/v1/email_domain_sets/{id}

HTTPcURLJavaScriptPython

GET /api/v1/email_domain_sets/{id} HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

200

Getting a specific email domain set

{
  "id": 1,
  "name": "Example",
  "account_id": 25,
  "canvas_root_account_uuid": "25WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
  "created_at": "2024/01/01 00:00:00 +0000",
  "updated_at": "2024/01/01 00:00:00 +0000",
  "deleted_at": null
}

put

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Path parameters

idintegerRequired

Body

application/json

Responses

200

Updating an email domain set

application/json

put

/api/v1/email_domain_sets/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/email_domain_sets/{id} HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "email_domain_set": {
    "name": "text",
    "email_domains_attributes": "text"
  }
}

200

Updating an email domain set

{
  "email_domain_set": {
    "id": 3,
    "name": "API Name",
    "account_id": 29,
    "email_domains": [
      {
        "id": 4,
        "domain": "example1.com",
        "email_domain_set_id": 3,
        "canvas_root_account_uuid": "29WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
        "created_at": "2024/01/01 00:00:00 +0000",
        "updated_at": "2024/01/01 00:00:00 +0000",
        "deleted_at": null
      },
      {
        "id": 5,
        "domain": "example2.org",
        "email_domain_set_id": 3,
        "canvas_root_account_uuid": "29WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
        "created_at": "2024/01/01 00:00:00 +0000",
        "updated_at": "2024/01/01 00:00:00 +0000",
        "deleted_at": null
      },
      {
        "id": 3,
        "domain": "example.com",
        "email_domain_set_id": 3,
        "canvas_root_account_uuid": "29WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
        "created_at": "2024/01/01 00:00:00 +0000",
        "updated_at": "2024/01/01 00:00:00 +0000",
        "deleted_at": null
      }
    ]
  }
}

get

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Path parameters

idintegerRequired

Responses

200

List promotions by email domain set

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v1/email_domain_sets/{id}/promotions HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

200

List promotions by email domain set

{
  "promotions": [
    {
      "id": 4,
      "account_id": 28,
      "product_id": null,
      "product_title": null,
      "product_archived_at": null,
      "account_name": "Domain Account 28",
      "currency": "USD",
      "amount": "10.0",
      "discount_type": "flat",
      "code": "PROMO4",
      "name": "Product 4",
      "description": null,
      "active": false,
      "start_date": null,
      "end_date": null,
      "created_at": "2024/01/01 00:00:00 +0000",
      "updated_at": "2024/01/01 00:00:00 +0000",
      "deleted_at": null,
      "usage_type": "once-per-user",
      "canvas_root_account_uuid": "28WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
      "email_domain_set_id": 2,
      "email_domain_set_name": "Example",
      "email_domains": [
        {
          "id": 2,
          "domain": "example.com",
          "email_domain_set_id": 2,
          "canvas_root_account_uuid": "27WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
          "created_at": "2024/01/01 00:00:00 +0000",
          "updated_at": "2024/01/01 00:00:00 +0000",
          "deleted_at": null
        }
      ],
      "status": "inactive",
      "max_per_user": null,
      "max_total_use": null
    }
  ]
}

get

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Query parameters

searchstringOptional

A value to filter the Email Domain Sets by name

exactstringOptional

A boolean to set whether the search should only include results that match exactly

Responses

200

Listing email domain sets

application/json

Responseobject

get

/api/v1/email_domain_sets

HTTPcURLJavaScriptPython

GET /api/v1/email_domain_sets HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

200

Listing email domain sets

{
  "email_domain_sets": [
    {
      "id": 4,
      "name": "Example",
      "account_id": 31,
      "email_domains": [
        {
          "id": 6,
          "domain": "example.com",
          "email_domain_set_id": 4,
          "canvas_root_account_uuid": "31WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
          "created_at": "2024/01/01 00:00:00 +0000",
          "updated_at": "2024/01/01 00:00:00 +0000",
          "deleted_at": null
        }
      ]
    }
  ],
  "meta": {
    "total_pages": 0
  }
}