# Email Channels

Create and manage email sending channels for campaign automations.

Supported providers include verified customer domains through Brevo and OAuth-backed channels such as Gmail.

## GET /email-channels

> List Email Channels

```json
{"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"email-channels","description":"Create and manage email sending channels for campaign automations.\n\nSupported providers include verified customer domains through Brevo and OAuth-backed channels such as Gmail."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"EmailChannelOut":{"properties":{"name":{"type":"string","maxLength":160,"minLength":1,"title":"Name"},"provider":{"type":"string","enum":["brevo","gmail_oauth","outlook_oauth","smtp"],"title":"Provider","default":"brevo"},"status":{"type":"string","enum":["draft","active","disabled","needs_auth"],"title":"Status","default":"active"},"sender_email":{"title":"Sender Email","type":"string","maxLength":320},"sender_name":{"title":"Sender Name","type":"string","maxLength":160},"reply_to_email":{"title":"Reply To Email","type":"string","maxLength":320},"reply_to_name":{"title":"Reply To Name","type":"string","maxLength":160},"config":{"additionalProperties":true,"type":"object","title":"Config"},"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["name","id","created_at","updated_at"],"title":"EmailChannelOut"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/email-channels":{"get":{"tags":["email-channels"],"summary":"List Email Channels","operationId":"list_email_channels_email_channels_get","parameters":[{"name":"include_disabled","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Disabled"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmailChannelOut"},"title":"Response List Email Channels Email Channels Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## POST /email-channels

> Create Email Channel

```json
{"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"email-channels","description":"Create and manage email sending channels for campaign automations.\n\nSupported providers include verified customer domains through Brevo and OAuth-backed channels such as Gmail."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"EmailChannelCreate":{"properties":{"name":{"type":"string","maxLength":160,"minLength":1,"title":"Name"},"provider":{"type":"string","enum":["brevo","gmail_oauth","outlook_oauth","smtp"],"title":"Provider","default":"brevo"},"status":{"type":"string","enum":["draft","active","disabled","needs_auth"],"title":"Status","default":"active"},"sender_email":{"title":"Sender Email","type":"string","maxLength":320},"sender_name":{"title":"Sender Name","type":"string","maxLength":160},"reply_to_email":{"title":"Reply To Email","type":"string","maxLength":320},"reply_to_name":{"title":"Reply To Name","type":"string","maxLength":160},"config":{"additionalProperties":true,"type":"object","title":"Config"}},"type":"object","required":["name"],"title":"EmailChannelCreate"},"EmailChannelOut":{"properties":{"name":{"type":"string","maxLength":160,"minLength":1,"title":"Name"},"provider":{"type":"string","enum":["brevo","gmail_oauth","outlook_oauth","smtp"],"title":"Provider","default":"brevo"},"status":{"type":"string","enum":["draft","active","disabled","needs_auth"],"title":"Status","default":"active"},"sender_email":{"title":"Sender Email","type":"string","maxLength":320},"sender_name":{"title":"Sender Name","type":"string","maxLength":160},"reply_to_email":{"title":"Reply To Email","type":"string","maxLength":320},"reply_to_name":{"title":"Reply To Name","type":"string","maxLength":160},"config":{"additionalProperties":true,"type":"object","title":"Config"},"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["name","id","created_at","updated_at"],"title":"EmailChannelOut"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/email-channels":{"post":{"tags":["email-channels"],"summary":"Create Email Channel","operationId":"create_email_channel_email_channels_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailChannelCreate"}}}},"responses":{"201":{"description":"Resource created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailChannelOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## DELETE /email-channels/{channel\_id}

> Delete Email Channel

```json
{"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"email-channels","description":"Create and manage email sending channels for campaign automations.\n\nSupported providers include verified customer domains through Brevo and OAuth-backed channels such as Gmail."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/email-channels/{channel_id}":{"delete":{"tags":["email-channels"],"summary":"Delete Email Channel","operationId":"delete_email_channel_email_channels__channel_id__delete","parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Channel Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"responses":{"204":{"description":"Request completed successfully with no response body."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## PATCH /email-channels/{channel\_id}

> Update Email Channel

```json
{"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"email-channels","description":"Create and manage email sending channels for campaign automations.\n\nSupported providers include verified customer domains through Brevo and OAuth-backed channels such as Gmail."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"EmailChannelUpdate":{"properties":{"name":{"title":"Name","type":"string","maxLength":160,"minLength":1},"provider":{"title":"Provider","type":"string","enum":["brevo","gmail_oauth","outlook_oauth","smtp"]},"status":{"title":"Status","type":"string","enum":["draft","active","disabled","needs_auth"]},"sender_email":{"title":"Sender Email","type":"string","maxLength":320},"sender_name":{"title":"Sender Name","type":"string","maxLength":160},"reply_to_email":{"title":"Reply To Email","type":"string","maxLength":320},"reply_to_name":{"title":"Reply To Name","type":"string","maxLength":160},"config":{"title":"Config","additionalProperties":true,"type":"object"}},"type":"object","title":"EmailChannelUpdate"},"EmailChannelOut":{"properties":{"name":{"type":"string","maxLength":160,"minLength":1,"title":"Name"},"provider":{"type":"string","enum":["brevo","gmail_oauth","outlook_oauth","smtp"],"title":"Provider","default":"brevo"},"status":{"type":"string","enum":["draft","active","disabled","needs_auth"],"title":"Status","default":"active"},"sender_email":{"title":"Sender Email","type":"string","maxLength":320},"sender_name":{"title":"Sender Name","type":"string","maxLength":160},"reply_to_email":{"title":"Reply To Email","type":"string","maxLength":320},"reply_to_name":{"title":"Reply To Name","type":"string","maxLength":160},"config":{"additionalProperties":true,"type":"object","title":"Config"},"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["name","id","created_at","updated_at"],"title":"EmailChannelOut"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/email-channels/{channel_id}":{"patch":{"tags":["email-channels"],"summary":"Update Email Channel","operationId":"update_email_channel_email_channels__channel_id__patch","parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Channel Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailChannelUpdate"}}}},"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailChannelOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## POST /email-channels/{channel\_id}/brevo/refresh

> Refresh Brevo Email Channel

```json
{"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"email-channels","description":"Create and manage email sending channels for campaign automations.\n\nSupported providers include verified customer domains through Brevo and OAuth-backed channels such as Gmail."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"EmailChannelOut":{"properties":{"name":{"type":"string","maxLength":160,"minLength":1,"title":"Name"},"provider":{"type":"string","enum":["brevo","gmail_oauth","outlook_oauth","smtp"],"title":"Provider","default":"brevo"},"status":{"type":"string","enum":["draft","active","disabled","needs_auth"],"title":"Status","default":"active"},"sender_email":{"title":"Sender Email","type":"string","maxLength":320},"sender_name":{"title":"Sender Name","type":"string","maxLength":160},"reply_to_email":{"title":"Reply To Email","type":"string","maxLength":320},"reply_to_name":{"title":"Reply To Name","type":"string","maxLength":160},"config":{"additionalProperties":true,"type":"object","title":"Config"},"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["name","id","created_at","updated_at"],"title":"EmailChannelOut"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/email-channels/{channel_id}/brevo/refresh":{"post":{"tags":["email-channels"],"summary":"Refresh Brevo Email Channel","operationId":"refresh_brevo_email_channel_email_channels__channel_id__brevo_refresh_post","parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Channel Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailChannelOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.aurorasuite.ai/api-reference/integrations/email-channels.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.