Email Domain Set
get
Authorizations
Path parameters
idintegerRequired
Responses
200
Getting a specific email domain set
application/json
get
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": 3,
"name": "Example",
"account_id": 34,
"canvas_root_account_uuid": "35WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
"created_at": "2025/06/10 13:42:05 +0000",
"updated_at": "2025/06/10 13:42:05 +0000",
"deleted_at": null
}
put
Authorizations
Path parameters
idintegerRequired
Body
Responses
200
Updating an email domain set
application/json
put
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": 1,
"name": "API Name",
"account_id": 30,
"email_domains": [
{
"id": 2,
"domain": "example1.com",
"email_domain_set_id": 1,
"canvas_root_account_uuid": "31WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
"created_at": "2025/06/10 13:42:04 +0000",
"updated_at": "2025/06/10 13:42:04 +0000",
"deleted_at": null
},
{
"id": 3,
"domain": "example2.org",
"email_domain_set_id": 1,
"canvas_root_account_uuid": "31WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
"created_at": "2025/06/10 13:42:04 +0000",
"updated_at": "2025/06/10 13:42:04 +0000",
"deleted_at": null
},
{
"id": 1,
"domain": "example.com",
"email_domain_set_id": 1,
"canvas_root_account_uuid": "31WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
"created_at": "2025/06/10 13:42:04 +0000",
"updated_at": "2025/06/10 13:42:04 +0000",
"deleted_at": null
}
]
}
}
get
Authorizations
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
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": 2,
"name": "Example",
"account_id": 32,
"email_domains": [
{
"id": 4,
"domain": "example.com",
"email_domain_set_id": 2,
"canvas_root_account_uuid": "33WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
"created_at": "2025/06/10 13:42:04 +0000",
"updated_at": "2025/06/10 13:42:04 +0000",
"deleted_at": null
}
]
}
],
"meta": {
"total_pages": 0
}
}
get
Authorizations
Path parameters
idintegerRequired
Responses
200
List promotions by email domain set
application/json
get
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": 37,
"product_id": null,
"product_title": null,
"account_name": "Domain Account 38",
"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": "2025/06/10 13:42:05 +0000",
"updated_at": "2025/06/10 13:42:05 +0000",
"deleted_at": null,
"usage_type": "once-per-user",
"canvas_root_account_uuid": "38WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
"email_domain_set_id": 4,
"email_domain_set_name": "Example",
"email_domains": [
{
"id": 6,
"domain": "example.com",
"email_domain_set_id": 4,
"canvas_root_account_uuid": "37WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
"created_at": "2025/06/10 13:42:05 +0000",
"updated_at": "2025/06/10 13:42:05 +0000",
"deleted_at": null
}
],
"status": "inactive"
}
]
}
Last updated
Was this helpful?