# Sendgrid Integration via LowCodeAPI
**Last Updated**: February 11, 2026
## Overview
Email service
The Sendgrid API provides access to:
- **Transactional Email** - Related functionality
## Base Endpoint
```
https://api.lowcodeapi.com/sendgrid/
```
**Important**: Always include the provider name in the URL path after `api.lowcodeapi.com/`
## Authentication
LowCodeAPI handles authentication automatically. You only need to:
1. **Sign up** at [Sendgrid](https://sendgrid.com/en-us)
2. **Get your credentials** from [credential page](https://app.sendgrid.com/settings/api_keys)
3. **Connect your account** in LowCodeAPI dashboard
4. **Use your `api_token`** in all requests
The `api_token` is your LowCodeAPI authentication token. LowCodeAPI will automatically:
- Fetch your provider credentials (API keys, OAuth tokens, etc.)
- Apply them to each request
- Handle token refresh for OAuth providers
**Auth Type**: TOKEN
## URL Format (Important)
LowCodeAPI supports **two URL formats** for endpoints with path parameters. **Always try New Format first**, and only fall back to Old Format if it doesn't work.
### New Format (Priority) - Dynamic Path Parameters
- **Path parameters stay in the URL path** - Do NOT convert to query parameters
- **Provider name is always in the URL path** after `api.lowcodeapi.com/`
- Pattern: `https://api.lowcodeapi.com/{provider}/{path_with_params}?api_token={api_token}`
**Example**:
```bash
# New Format - Path parameter stays in the URL path
https://api.lowcodeapi.com/sendgrid/resource/{RESOURCE_ID}?api_token=YOUR_API_TOKEN
```
### Old Format (Fallback) - Sanitized Path + Query Parameters
- **Path parameters become query parameters**
- **Provider name is always in the URL path**
- Pattern: `https://api.lowcodeapi.com/{provider}/{sanitized_path}?{path_params}&api_token={api_token}`
**Example**:
```bash
# Old Format - Path parameter becomes a query parameter
https://api.lowcodeapi.com/sendgrid/resource/id?id=RESOURCE_ID&api_token=YOUR_API_TOKEN
```
### Decision Flow for AI Agents
1. Always use **New Format first** - Keep path parameters in the URL path
2. If you get a 404 or error, try **Old Format** with sanitized path
3. Log which format worked for future requests to this provider
## API Categories
- **API Key Permissions** - 1 endpoints
- **API Keys** - 6 endpoints
- **Account Provisioning API: Account Operations** - 3 endpoints
- **Account Provisioning API: Account State Operations** - 2 endpoints
- **Account Provisioning API: Offering Operations** - 3 endpoints
- **Alerts** - 5 endpoints
- **Blocks API** - 4 endpoints
- **Bounces API** - 6 endpoints
- **Campaigns API** - 11 endpoints
- **Categories** - 3 endpoints
- **Certificates** - 5 endpoints
- **Contacts** - 13 endpoints
- **Contacts API - Custom Fields** - 5 endpoints
- **Contacts API - Lists** - 10 endpoints
- **Contacts API - Recipients** - 11 endpoints
- **Contacts API - Segments** - 5 endpoints
- **Custom Fields** - 4 endpoints
- **Designs API** - 9 endpoints
- **Domain Authentication** - 12 endpoints
- **E-Mail Activity** - 4 endpoints
- **E-Mail Address Validation** - 1 endpoints
- **E-Mail CNAME Records** - 1 endpoints
- **IP Access Management** - 6 endpoints
- **IP Address** - 5 endpoints
- **IP Address Management API** - 15 endpoints
- **IP Pools** - 7 endpoints
- **IP Warmup** - 4 endpoints
- **Invalid E-Mails API** - 4 endpoints
- **Link Branding** - 10 endpoints
- **Lists** - 7 endpoints
- **Mail Send** - 1 endpoints
- **Marketing Campaign Stats** - 8 endpoints
- **Reverse DNS** - 5 endpoints
- **Segmenting Contacts** - 11 endpoints
- **Send Test E-Mail** - 1 endpoints
- **Sender Identities API** - 6 endpoints
- **Sender Verification** - 8 endpoints
- **Senders** - 1 endpoints
- **Settings - Enforced TLS** - 2 endpoints
- **Settings - Inbound Parse** - 4 endpoints
- **Settings - Mail** - 13 endpoints
- **Settings - Partner** - 1 endpoints
- **Settings - Tracking** - 9 endpoints
- **Single Sends** - 11 endpoints
- **Single Sign-On Settings** - 5 endpoints
- **Single Sign-On Teammates** - 2 endpoints
- **Spam Reports API** - 4 endpoints
- **Stats** - 7 endpoints
- **Subuser Monitor Settings** - 4 endpoints
- **Subuser Statistics** - 4 endpoints
- **Subusers API** - 6 endpoints
- **Suppressions - Global Suppressions** - 4 endpoints
- **Suppressions - Suppressions** - 6 endpoints
- **Suppressions - Unsubscribe Groups** - 5 endpoints
- **Teammates** - 11 endpoints
- **Transactional Templates** - 6 endpoints
- **Transactional Templates Versions** - 5 endpoints
- **Users API** - 9 endpoints
- **Webhooks** - 10 endpoints
## Common Endpoints
### Category: API Key Permissions
#### Retrieve a list of scopes for which this user has access
**Method**: `GET` | **LowCodeAPI Path**: `/v3/scopes`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/scopes?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/scopes?api_token={api_token}
```
**Description**: Retrieve a list of scopes for which this user has access
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/scopes?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a list of scopes for which this user has access](https://docs.sendgrid.com/api-reference/api-key-permissions/retrieve-a-list-of-scopes-for-which-this-user-has-access)
---
### Category: API Keys
#### Create API keys
**Method**: `POST` | **LowCodeAPI Path**: `/v3/api_keys`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/api_keys?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/api_keys?api_token={api_token}
```
**Description**: Create API keys
**Request Body**:
```json
{
"name": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `name` | string | Yes | The name you will use to describe this API Key |
| `scopes` | array | No | The individual permissions that you are giving to this API Key |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/api_keys?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create API keys](https://docs.sendgrid.com/api-reference/api-keys/create-api-keys)
---
#### Retrieve all API Keys belonging to the authenticated user
**Method**: `GET` | **LowCodeAPI Path**: `/v3/api_keys`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/api_keys?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/api_keys?limit={limit}&api_token={api_token}
```
**Description**: Retrieve all API Keys belonging to the authenticated user
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Specifies the number of results to be returned by the API |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/api_keys?limit=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all API Keys belonging to the authenticated user](https://docs.sendgrid.com/api-reference/api-keys/retrieve-all-api-keys-belonging-to-the-authenticated-user)
---
#### Retrieve an existing API Key
**Method**: `GET` | **LowCodeAPI Path**: `/v3/api_keys/{api_key_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/api_keys/{api_key_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/api_keys/api_key_id?api_key_id={api_key_id}&api_token={api_token}
```
**Description**: Retrieve an existing API Key
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `api_key_id` | string | Yes | . |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/api_keys/{api_key_id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve an existing API Key](https://docs.sendgrid.com/api-reference/api-keys/retrieve-an-existing-api-key)
---
#### Update API key name
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/api_keys/{api_key_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/api_keys/{api_key_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/api_keys/api_key_id?api_key_id={api_key_id}&api_token={api_token}
```
**Description**: Update API key name
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `api_key_id` | string | Yes | Api key Id |
**Request Body**:
```json
{
"name": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `name` | string | Yes | The new name of the API Key. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/api_keys/{api_key_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update API key name](https://docs.sendgrid.com/api-reference/api-keys/update-api-key-name)
---
#### Update API key name and scopes
**Method**: `PUT` | **LowCodeAPI Path**: `/v3/api_keys/{api_key_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/api_keys/{api_key_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/api_keys/api_key_id?api_key_id={api_key_id}&api_token={api_token}
```
**Description**: Update API key name and scopes
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `api_key_id` | string | Yes | Api key Id |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `"scopes"` | {
"type" | No | |
| `"text"` | "Scopes"
}
} | No | |
| `{
"name"` | {
"type" | No | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/sendgrid/v3/api_keys/{api_key_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update API key name and scopes](https://docs.sendgrid.com/api-reference/api-keys/update-api-key-name-and-scopes)
---
#### Delete API keys
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/api_keys/{api_key_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/api_keys/{api_key_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/api_keys/api_key_id?api_key_id={api_key_id}&api_token={api_token}
```
**Description**: Delete API keys
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `api_key_id` | string | Yes | Api key Id |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/api_keys/{api_key_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete API keys](https://docs.sendgrid.com/api-reference/api-keys/delete-api-keys)
---
### Category: Account Provisioning API: Account Operations
#### List Accounts
**Method**: `GET` | **LowCodeAPI Path**: `/v3/partners/accounts`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/partners/accounts?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/partners/accounts?limit={limit}&offset={offset}&api_token={api_token}
```
**Description**: List Accounts
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | The number of items to return. |
| `offset` | string | No | The last item successfully retrieved |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/partners/accounts?limit=VALUE&offset=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [List Accounts](https://docs.sendgrid.com/api-reference/account-provisioning-api-account-operations/list-accounts)
---
#### Create Account
**Method**: `POST` | **LowCodeAPI Path**: `/v3/partners/accounts`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/partners/accounts?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/partners/accounts?api_token={api_token}
```
**Description**: Create Account
**Request Body**:
```json
{
"offerings": "<array>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `offerings` | array | Yes | List of offering names to assign to account |
| `profile` | object | No | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/partners/accounts?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create Account](https://docs.sendgrid.com/api-reference/account-provisioning-api-account-operations/create-account)
---
#### Single Sign-On
**Method**: `POST` | **LowCodeAPI Path**: `/v3/partners/accounts/{accountID}/sso`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/partners/accounts/{accountID}/sso?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/partners/accounts/accountid/sso?accountID={accountID}&api_token={api_token}
```
**Description**: Single Sign-On
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accountID` | string | Yes | Twilio SendGrid account ID |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/partners/accounts/{accountID}/sso?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Single Sign-On](https://docs.sendgrid.com/api-reference/account-provisioning-api-account-operations/single-sign-on)
---
### Category: Account Provisioning API: Account State Operations
#### Get Account State
**Method**: `GET` | **LowCodeAPI Path**: `/v3/partners/accounts/{accountID}/state`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/partners/accounts/{accountID}/state?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/partners/accounts/accountid/state?accountID={accountID}&api_token={api_token}
```
**Description**: Get Account State
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accountID` | string | Yes | Twilio SendGrid account ID |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/partners/accounts/{accountID}/state?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Account State](https://docs.sendgrid.com/api-reference/account-provisioning-api-account-state-operations/get-account-state)
---
#### Update Account State
**Method**: `PUT` | **LowCodeAPI Path**: `/v3/partners/accounts/{accountID}/state`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/partners/accounts/{accountID}/state?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/partners/accounts/accountid/state?accountID={accountID}&api_token={api_token}
```
**Description**: Update Account State
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accountID` | string | Yes | Twilio SendGrid account ID |
**Request Body**:
```json
{
"state": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `state` | string | Yes | The state of the account |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/sendgrid/v3/partners/accounts/{accountID}/state?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update Account State](https://docs.sendgrid.com/api-reference/account-provisioning-api-account-state-operations/update-account-state)
---
### Category: Account Provisioning API: Offering Operations
#### Update Account Offerings
**Method**: `PUT` | **LowCodeAPI Path**: `/v3/partners/accounts/{accountID}/offerings`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/partners/accounts/{accountID}/offerings?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/partners/accounts/accountid/offerings?accountID={accountID}&api_token={api_token}
```
**Description**: Update Account Offerings
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accountID` | string | Yes | Twilio SendGrid account ID |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `offerings` | array | No | List of offerings to assign to account |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/sendgrid/v3/partners/accounts/{accountID}/offerings?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update Account Offerings](https://docs.sendgrid.com/api-reference/account-provisioning-api-offering-operations/update-account-offerings)
---
#### List Offerings
**Method**: `GET` | **LowCodeAPI Path**: `/v3/partners/offerings`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/partners/offerings?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/partners/offerings?api_token={api_token}
```
**Description**: List Offerings
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/partners/offerings?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [List Offerings](https://docs.sendgrid.com/api-reference/account-provisioning-api-offering-operations/list-offerings)
---
#### Get Account Offerings
**Method**: `GET` | **LowCodeAPI Path**: `/v3/partners/accounts/{accountID}/offerings`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/partners/accounts/{accountID}/offerings?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/partners/accounts/accountid/offerings?accountID={accountID}&api_token={api_token}
```
**Description**: Get Account Offerings
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accountID` | string | Yes | Twilio SendGrid account ID |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/partners/accounts/{accountID}/offerings?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Account Offerings](https://docs.sendgrid.com/api-reference/account-provisioning-api-offering-operations/get-account-offerings)
---
### Category: Alerts
#### Create a new Alert
**Method**: `POST` | **LowCodeAPI Path**: `/v3/alerts`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/alerts?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/alerts?api_token={api_token}
```
**Description**: Create a new Alert
**Request Body**:
```json
{
"type": "<string>",
"email_to": "<string>",
"frequency": "<string>",
"percentage": "<number>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `type` | string | Yes | The type of alert you want to create |
| `email_to` | string | Yes | The email address the alert will be sent to |
| `frequency` | string | Yes | Required for stats_notification. How frequently the alert will be sent. |
| `percentage` | number | Yes | Required for usage_alert. When this usage threshold is reached the alert will be sent. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/alerts?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a new Alert](https://docs.sendgrid.com/api-reference/alerts/create-a-new-alert)
---
#### Retrieve all alerts
**Method**: `GET` | **LowCodeAPI Path**: `/v3/alerts`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/alerts?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/alerts?api_token={api_token}
```
**Description**: Retrieve all alerts
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/alerts?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all alerts](https://docs.sendgrid.com/api-reference/alerts/retrieve-all-alerts)
---
#### Retrieve a specific alert
**Method**: `GET` | **LowCodeAPI Path**: `/v3/alerts/{alert_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/alerts/{alert_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/alerts/alert_id?alert_id={alert_id}&api_token={api_token}
```
**Description**: Retrieve a specific alert
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `alert_id` | number | Yes | The ID of the alert you would like to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/alerts/{alert_id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a specific alert](https://docs.sendgrid.com/api-reference/alerts/retrieve-a-specific-alert)
---
#### Delete an alert
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/alerts/{alert_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/alerts/{alert_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/alerts/alert_id?alert_id={alert_id}&api_token={api_token}
```
**Description**: Delete an alert
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `alert_id` | number | Yes | The ID of the alert you would like to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/alerts/{alert_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete an alert](https://docs.sendgrid.com/api-reference/alerts/delete-an-alert)
---
#### Update an alert
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/alerts/{alert_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/alerts/{alert_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/alerts/alert_id?alert_id={alert_id}&api_token={api_token}
```
**Description**: Update an alert
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `alert_id` | number | Yes | The ID of the alert you would like to retrieve |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `email_to` | string | No | The new email address you want your alert to be sent to |
| `frequency` | string | No | The new frequency at which to send the stats_notification alert |
| `percentage` | number | No | The new percentage threshold at which the usage_limit alert will be sent. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/alerts/{alert_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update an alert](https://docs.sendgrid.com/api-reference/alerts/update-an-alert)
---
### Category: Blocks API
#### Retrieve all blocks
**Method**: `GET` | **LowCodeAPI Path**: `/v3/suppression/blocks`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/blocks?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/blocks?email={email}&end_time={end_time}&limit={limit}&offset={offset}&start_time={start_time}&api_token={api_token}
```
**Description**: Retrieve all blocks
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Specifies which records to return based on the records' associated email addresses |
| `end_time` | numner | No | The end of the time range when a blocked email was created (inclusive) |
| `limit` | numner | No | Limit the number of results to be displayed per page |
| `offset` | number | No | The point in the list to begin displaying results |
| `start_time` | number | No | The start of the time range when a blocked email was created (inclusive) |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/suppression/blocks?email=VALUE&end_time=VALUE&limit=VALUE&offset=VALUE&start_time=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all blocks](https://docs.sendgrid.com/api-reference/blocks-api/retrieve-all-blocks)
---
#### Retrieve a specific block
**Method**: `GET` | **LowCodeAPI Path**: `/v3/suppression/blocks/{email}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/blocks/{email}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/blocks/email?email={email}&api_token={api_token}
```
**Description**: Retrieve a specific block
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address of the specific block. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/suppression/blocks/{email}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a specific block](https://docs.sendgrid.com/api-reference/blocks-api/retrieve-a-specific-block)
---
#### Delete blocks
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/suppression/blocks`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/blocks?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/blocks?api_token={api_token}
```
**Description**: Delete blocks
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/suppression/blocks?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete blocks](https://docs.sendgrid.com/api-reference/blocks-api/delete-blocks)
---
#### Delete a specific block
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/suppression/blocks/{email}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/blocks/{email}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/blocks/email?email={email}&api_token={api_token}
```
**Description**: Delete a specific block
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address of the specific block. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/suppression/blocks/{email}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a specific block](https://docs.sendgrid.com/api-reference/blocks-api/delete-a-specific-block)
---
### Category: Bounces API
#### Retrieve all bounces
**Method**: `GET` | **LowCodeAPI Path**: `/v3/suppression/bounces`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/bounces?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/bounces?end_time={end_time}&limit={limit}&offset={offset}&start_time={start_time}&api_token={api_token}
```
**Description**: Retrieve all bounces
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_time` | number | No | Refers end of the time range in unix timestamp when a bounce was created |
| `limit` | number | No | Limit the number of results to be displayed per page |
| `offset` | number | No | The point in the list to begin displaying results. |
| `start_time` | number | No | Refers start of the time range in unix timestamp when a bounce was created |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/suppression/bounces?end_time=VALUE&limit=VALUE&offset=VALUE&start_time=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all bounces](https://docs.sendgrid.com/api-reference/bounces-api/retrieve-all-bounces)
---
#### Retrieve a Bounce
**Method**: `GET` | **LowCodeAPI Path**: `/v3/suppression/bounces/{email}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/bounces/{email}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/bounces/email?email={email}&api_token={api_token}
```
**Description**: Retrieve a Bounce
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/suppression/bounces/{email}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a Bounce](https://docs.sendgrid.com/api-reference/bounces-api/retrieve-a-bounce)
---
#### Delete bounces
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/suppression/bounces`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/bounces?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/bounces?delete_all={delete_all}&emails={emails}&api_token={api_token}
```
**Description**: Delete bounces
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `delete_all` | boolean | No | |
| `emails` | array | No | Delete multiple emails from your bounce list at the same time. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/suppression/bounces?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete bounces](https://docs.sendgrid.com/api-reference/bounces-api/delete-bounces)
---
#### Delete a bounce
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/suppression/bounces/{email}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/bounces/{email}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/bounces/email?email={email}&api_token={api_token}
```
**Description**: Delete a bounce
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address you would like to remove from the bounce list |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/suppression/bounces/{email}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a bounce](https://docs.sendgrid.com/api-reference/bounces-api/delete-a-bounce)
---
#### Retrieve bounce totals by classification
**Method**: `GET` | **LowCodeAPI Path**: `/v3/suppression/bounces/classifications`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/bounces/classifications?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/bounces/classifications?end_date={end_date}&start_date={start_date}&api_token={api_token}
```
**Description**: Retrieve bounce totals by classification
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | No | The end of the time range in YYYY-MM-DD format when a bounce was created. |
| `start_date` | string | Yes | The start of the time range in YYYY-MM-DD format when a bounce was created |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/suppression/bounces/classifications?end_date=VALUE&start_date=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve bounce totals by classification](https://docs.sendgrid.com/api-reference/bounces-api/retrieve-bounce-totals-by-classification)
---
#### Retrieve bounces by specific classification
**Method**: `GET` | **LowCodeAPI Path**: `/v3/suppression/bounces/classifications/{classification}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/bounces/classifications/{classification}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/bounces/classifications/classification?classification={classification}&end_date={end_date}&start_date={start_date}&api_token={api_token}
```
**Description**: Retrieve bounces by specific classification
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `classification` | string | Yes | The classification you want to filter by. |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | No | The end of the time range in YYYY-MM-DD format when a bounce was created. |
| `start_date` | string | Yes | The start of the time range in YYYY-MM-DD format when a bounce was created |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/suppression/bounces/classifications/{classification}?end_date=VALUE&start_date=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve bounces by specific classification](https://docs.sendgrid.com/api-reference/bounces-api/retrieve-bounces-by-specific-classification)
---
### Category: Campaigns API
#### Create a Campaign
**Method**: `POST` | **LowCodeAPI Path**: `/v3/campaigns`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns?api_token={api_token}
```
**Description**: Create a Campaign
**Request Body**:
```json
{
"title": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `categories` | array | No | The categories you would like associated to this campaign |
| `custom_unsubscribe_url` | string | No | This is the url of the custom unsubscribe page that you provide for customers to unsubscribe from your suppression groups |
| `editor` | string | No | The editor used in the UI. |
| `html_content` | string | No | The HTML of your marketing email |
| `ip_pool` | string | No | The pool of IPs that you would like to send this email from |
| `plain_content` | string | No | The plain text content of your emails |
| `segment_ids` | array | No | The segment IDs that you are sending this list to |
| `sender_id` | number | No | The ID of the "sender" identity that you have created.
list_ids |
| `subject` | string | No | The subject of your campaign that your recipients will see |
| `suppression_group_id` | number | No | The suppression group that this marketing email belongs to allowing recipients to opt-out of emails of this type |
| `title` | string | Yes | The display title of your campaign |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/campaigns?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a Campaign](https://docs.sendgrid.com/api-reference/campaigns-api/create-a-campaign)
---
#### Retrieve all Campaigns
**Method**: `GET` | **LowCodeAPI Path**: `/v3/campaigns`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns?limit={limit}&offset={offset}&api_token={api_token}
```
**Description**: Retrieve all Campaigns
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | The number of results you would like to receive at a time |
| `offset` | number | No | The index of the first campaign to return where 0 is the first campaign. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/campaigns?limit=VALUE&offset=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all Campaigns](https://docs.sendgrid.com/api-reference/campaigns-api/retrieve-all-campaigns)
---
#### Retrieve a single campaign
**Method**: `GET` | **LowCodeAPI Path**: `/v3/campaigns/{campaign_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns/{campaign_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns/campaign_id?campaign_id={campaign_id}&api_token={api_token}
```
**Description**: Retrieve a single campaign
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | number | Yes | The id of the campaign you would like to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/campaigns/{campaign_id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a single campaign](https://docs.sendgrid.com/api-reference/campaigns-api/retrieve-a-single-campaign)
---
#### Delete a Campaign
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/campaigns/{campaign_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns/{campaign_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns/campaign_id?campaign_id={campaign_id}&api_token={api_token}
```
**Description**: Delete a Campaign
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | number | Yes | The id of the campaign you would like to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/campaigns/{campaign_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a Campaign](https://docs.sendgrid.com/api-reference/campaigns-api/delete-a-campaign)
---
#### Update a Campaign
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/campaigns/{campaign_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns/{campaign_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns/campaign_id?campaign_id={campaign_id}&api_token={api_token}
```
**Description**: Update a Campaign
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | number | Yes | The id of the campaign you would like to retrieve. |
**Request Body**:
```json
{
"categories": "<array>",
"html_content": "<string>",
"plain_content": "<string>",
"title": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `categories` | array | Yes | The categories you want to tag on this campaign |
| `html_content` | string | Yes | The HTML content of this campaign |
| `plain_content` | string | Yes | The plain content of this campaign. |
| `title` | string | Yes | The title of the campaign.
subject |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/campaigns/{campaign_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update a Campaign](https://docs.sendgrid.com/api-reference/campaigns-api/update-a-campaign)
---
#### Send a Campaign
**Method**: `POST` | **LowCodeAPI Path**: `/v3/campaigns/{campaign_id}/schedules/now`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns/{campaign_id}/schedules/now?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns/campaign_id/schedules/now?campaign_id={campaign_id}&api_token={api_token}
```
**Description**: Send a Campaign
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | number | Yes | Campaign Id |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/campaigns/{campaign_id}/schedules/now?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Send a Campaign](https://docs.sendgrid.com/api-reference/campaigns-api/send-a-campaign)
---
#### Schedule a Campaign
**Method**: `POST` | **LowCodeAPI Path**: `/v3/campaigns/{campaign_id}/schedules`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns/{campaign_id}/schedules?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns/campaign_id/schedules?campaign_id={campaign_id}&api_token={api_token}
```
**Description**: Schedule a Campaign
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | number | Yes | Campaign Id |
**Request Body**:
```json
{
"send_at": "<number>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `send_at` | number | Yes | The unix timestamp for the date and time you would like your campaign to be sent out. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/campaigns/{campaign_id}/schedules?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Schedule a Campaign](https://docs.sendgrid.com/api-reference/campaigns-api/schedule-a-campaign)
---
#### Update a Scheduled Campaign
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/campaigns/{campaign_id}/schedules`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns/{campaign_id}/schedules?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns/campaign_id/schedules?campaign_id={campaign_id}&api_token={api_token}
```
**Description**: Update a Scheduled Campaign
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | number | Yes | Campaign Id |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `"required"` | true
}
} | No | |
| `"text'` | "Send at" | No | |
| `{
"send_at"` | {
"type" | No | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/campaigns/{campaign_id}/schedules?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update a Scheduled Campaign](https://docs.sendgrid.com/api-reference/campaigns-api/update-a-scheduled-campaign)
---
#### View Scheduled Time of a Campaign
**Method**: `GET` | **LowCodeAPI Path**: `/v3/campaigns/{campaign_id}/schedules`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns/{campaign_id}/schedules?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns/campaign_id/schedules?campaign_id={campaign_id}&api_token={api_token}
```
**Description**: View Scheduled Time of a Campaign
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | number | Yes | Campaign Id |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/campaigns/{campaign_id}/schedules?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [View Scheduled Time of a Campaign](https://docs.sendgrid.com/api-reference/campaigns-api/view-scheduled-time-of-a-campaign)
---
#### Unschedule a Scheduled Campaign
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/campaigns/{campaign_id}/schedules`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns/{campaign_id}/schedules?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns/campaign_id/schedules?campaign_id={campaign_id}&api_token={api_token}
```
**Description**: Unschedule a Scheduled Campaign
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | number | Yes | . |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/campaigns/{campaign_id}/schedules?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Unschedule a Scheduled Campaign](https://docs.sendgrid.com/api-reference/campaigns-api/unschedule-a-scheduled-campaign)
---
#### Send a Test Campaign
**Method**: `POST` | **LowCodeAPI Path**: `/v3/campaigns/{campaign_id}/schedules/test`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns/{campaign_id}/schedules/test?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/campaigns/campaign_id/schedules/test?campaign_id={campaign_id}&api_token={api_token}
```
**Description**: Send a Test Campaign
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | number | Yes | . |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `to` | string | No | The email address that should receive the test campaign. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/campaigns/{campaign_id}/schedules/test?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Send a Test Campaign](https://docs.sendgrid.com/api-reference/campaigns-api/send-a-test-campaign)
---
### Category: Categories
#### Retrieve all categories
**Method**: `GET` | **LowCodeAPI Path**: `/v3/categories`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/categories?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/categories?category={category}&limit={limit}&offset={offset}&api_token={api_token}
```
**Description**: Retrieve all categories
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category` | string | No | Allows you to perform a prefix search on this particular category |
| `limit` | number | No | The number of categories to display per page |
| `offset` | number | No | The point in the list that you would like to begin displaying results. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/categories?category=VALUE&limit=VALUE&offset=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all categories](https://docs.sendgrid.com/api-reference/categories/retrieve-all-categories)
---
#### Retrieve sums of email stats for each category
**Method**: `GET` | **LowCodeAPI Path**: `/v3/categories/stats/sums`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/categories/stats/sums?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/categories/stats/sums?aggregated_by={aggregated_by}&end_date={end_date}&limit={limit}&offset={offset}&sort_by_direction={sort_by_direction}&sort_by_metric={sort_by_metric}&start_date={start_date}&api_token={api_token}
```
**Description**: Retrieve sums of email stats for each category
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aggregated_by` | string | No | How to group the statistics. |
| `end_date` | string | No | The end date of the statistics to retrieve |
| `limit` | number | No | Limits the number of results returned |
| `offset` | number | No | The point in the list to begin retrieving results |
| `sort_by_direction` | string | No | The direction you want to sort |
| `sort_by_metric` | string | No | The metric that you want to sort by. Must be a single metric |
| `start_date` | string | Yes | The starting date of the statistics to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/categories/stats/sums?aggregated_by=VALUE&end_date=VALUE&limit=VALUE&offset=VALUE&sort_by_direction=VALUE&sort_by_metric=VALUE&start_date=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve sums of email stats for each category](https://docs.sendgrid.com/api-reference/categories/retrieve-sums-of-email-stats-for-each-category)
---
#### Retrieve Email Statistics for Categories
**Method**: `GET` | **LowCodeAPI Path**: `/v3/categories/stats`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/categories/stats?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/categories/stats?aggregated_by={aggregated_by}&categories={categories}&end_date={end_date}&start_date={start_date}&api_token={api_token}
```
**Description**: Retrieve Email Statistics for Categories
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aggregated_by` | string | No | How to group the statistics. |
| `categories` | string | Yes | The individual categories that you want to retrieve statistics for |
| `end_date` | string | No | The end date of the statistics to retrieve |
| `start_date` | string | Yes | The starting date of the statistics to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/categories/stats?aggregated_by=VALUE&categories=VALUE&end_date=VALUE&start_date=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve Email Statistics for Categories](https://docs.sendgrid.com/api-reference/categories/retrieve-email-statistics-for-categories)
---
### Category: Certificates
#### Create an SSO Certificate
**Method**: `POST` | **LowCodeAPI Path**: `/v3/sso/certificates`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/certificates?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/certificates?api_token={api_token}
```
**Description**: Create an SSO Certificate
**Request Body**:
```json
{
"integration_id": "<string>",
"public_certificate": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `enabled` | boolean | No | Indicates if the certificate is enabled |
| `integration_id` | string | Yes | An ID that matches a certificate to a specific IdP integration |
| `public_certificate` | string | Yes | This public certificate allows SendGrid to verify that SAML requests it receives are signed by an IdP that it recognizes |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/sso/certificates?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create an SSO Certificate](https://docs.sendgrid.com/api-reference/certificates/create-an-sso-certificate)
---
#### Get All SSO Certificates by Integration
**Method**: `GET` | **LowCodeAPI Path**: `/v3/sso/integrations/{integration_id}/certificates`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/integrations/{integration_id}/certificates?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/integrations/integration_id/certificates?integration_id={integration_id}&api_token={api_token}
```
**Description**: Get All SSO Certificates by Integration
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `integration_id` | string | Yes | An ID that matches a certificate to a specific IdP integration. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/sso/integrations/{integration_id}/certificates?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get All SSO Certificates by Integration](https://docs.sendgrid.com/api-reference/certificates/get-all-sso-certificates-by-integration)
---
#### Get an SSO Certificate
**Method**: `GET` | **LowCodeAPI Path**: `/v3/sso/certificates/{cert_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/certificates/{cert_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/certificates/cert_id?cert_id={cert_id}&api_token={api_token}
```
**Description**: Get an SSO Certificate
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cert_id` | string | Yes | . |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/sso/certificates/{cert_id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get an SSO Certificate](https://docs.sendgrid.com/api-reference/certificates/get-an-sso-certificate)
---
#### Update SSO Certificate
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/sso/certificates/{cert_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/certificates/{cert_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/certificates/cert_id?cert_id={cert_id}&api_token={api_token}
```
**Description**: Update SSO Certificate
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cert_id` | string | Yes | Cert Id |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `enabled` | boolean | No | Indicates whether or not the certificate is enabled |
| `integration_id` | string | No | An ID that matches a certificate to a specific IdP integration. |
| `public_certificate` | string | No | This public certificate allows SendGrid to verify that SAML requests it receives are signed by an IdP that it recognizes |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/sso/certificates/{cert_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update SSO Certificate](https://docs.sendgrid.com/api-reference/certificates/update-sso-certificate)
---
#### Delete an SSO Certificate
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/sso/certificates/{cert_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/certificates/{cert_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/certificates/cert_id?cert_id={cert_id}&api_token={api_token}
```
**Description**: Delete an SSO Certificate
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cert_id` | string | Yes | Cert Id |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/sso/certificates/{cert_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete an SSO Certificate](https://docs.sendgrid.com/api-reference/certificates/delete-an-sso-certificate)
---
### Category: Contacts
#### Add or Update a Contact
**Method**: `PUT` | **LowCodeAPI Path**: `/v3/marketing/contacts`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts?api_token={api_token}
```
**Description**: Add or Update a Contact
**Request Body**:
```json
{
"contacts": "<array>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `contacts` | array | Yes | One or more contacts objects that you intend to upsert. |
| `list_ids` | array | No | An array of List ID strings that this contact will be added to |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add or Update a Contact](https://docs.sendgrid.com/api-reference/contacts/add-or-update-a-contact)
---
#### Delete Contacts
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/marketing/contacts`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts?delete_all_contacts={delete_all_contacts}&ids={ids}&api_token={api_token}
```
**Description**: Delete Contacts
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `delete_all_contacts` | string | No | Must be set to "true" to delete all contacts |
| `ids` | string | No | A comma-separated list of contact IDs. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete Contacts](https://docs.sendgrid.com/api-reference/contacts/delete-contacts)
---
#### Get Total Contact Count
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/contacts/count`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/count?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/count?api_token={api_token}
```
**Description**: Get Total Contact Count
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/count?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Total Contact Count](https://docs.sendgrid.com/api-reference/contacts/get-total-contact-count)
---
#### Export Contacts
**Method**: `POST` | **LowCodeAPI Path**: `/v3/marketing/contacts/exports`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/exports?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/exports?api_token={api_token}
```
**Description**: Export Contacts
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `list_ids` | array | No | IDs of the contact lists you want to export |
| `notifications` | object | No | Notifications |
| `segment_ids` | array | No | IDs of the contact segments you want to export |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/exports?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Export Contacts](https://docs.sendgrid.com/api-reference/contacts/export-contacts#headers)
---
#### Get a Contact by ID
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/contacts/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/id?id={id}&api_token={api_token}
```
**Description**: Get a Contact by ID
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/{id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get a Contact by ID](https://docs.sendgrid.com/api-reference/contacts/get-a-contact-by-id)
---
#### Search Contacts
**Method**: `POST` | **LowCodeAPI Path**: `/v3/marketing/contacts/search`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/search?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/search?api_token={api_token}
```
**Description**: Search Contacts
**Request Body**:
```json
{
"query": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | An SGQL search string or other pattern. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/search?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Search Contacts](https://docs.sendgrid.com/api-reference/contacts/search-contacts)
---
#### Get Sample Contacts
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/contacts`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts?api_token={api_token}
```
**Description**: Get Sample Contacts
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Sample Contacts](https://docs.sendgrid.com/api-reference/contacts/get-sample-contacts)
---
#### Import Contacts
**Method**: `PUT` | **LowCodeAPI Path**: `/v3/marketing/contacts/imports`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/imports?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/imports?api_token={api_token}
```
**Description**: Import Contacts
**Request Body**:
```json
{
"field_mappings": "<array>",
"file_type": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `field_mappings` | array | Yes | Import file header to reserved/custom field mapping. |
| `file_type` | string | Yes | Upload file type |
| `list_ids` | array | No | All contacts will be added to each of the specified lists |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/imports?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Import Contacts](https://docs.sendgrid.com/api-reference/contacts/import-contacts)
---
#### Import Contacts Status
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/contacts/imports/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/imports/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/imports/id?id={id}&api_token={api_token}
```
**Description**: Import Contacts Status
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/imports/{id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Import Contacts Status](https://docs.sendgrid.com/api-reference/contacts/import-contacts-status)
---
#### Export Contacts Status
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/contacts/exports/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/exports/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/exports/id?id={id}&api_token={api_token}
```
**Description**: Export Contacts Status
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/exports/{id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Export Contacts Status](https://docs.sendgrid.com/api-reference/contacts/export-contacts-status)
---
#### Get All Existing Exports
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/contacts/exports`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/exports?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/exports?api_token={api_token}
```
**Description**: Get All Existing Exports
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/exports?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get All Existing Exports](https://docs.sendgrid.com/api-reference/contacts/get-all-existing-exports)
---
#### Get Batched Contacts by IDs
**Method**: `POST` | **LowCodeAPI Path**: `/v3/marketing/contacts/batch`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/batch?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/batch?api_token={api_token}
```
**Description**: Get Batched Contacts by IDs
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `"text"` | "Ids"
"required" | No | |
| `{
"ids"` | {
"type" | No | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/batch?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Batched Contacts by IDs](https://docs.sendgrid.com/api-reference/contacts/get-batched-contacts-by-ids)
---
#### Get Contacts by Emails
**Method**: `POST` | **LowCodeAPI Path**: `/v3/marketing/contacts/search/emails`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/search/emails?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/search/emails?api_token={api_token}
```
**Description**: Get Contacts by Emails
**Request Body**:
```json
{
"emails": "<array>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `emails` | array | Yes | One or more primary and/or alternate email addresses to search for in your Marketing Campaigns contacts. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/marketing/contacts/search/emails?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Contacts by Emails](https://docs.sendgrid.com/api-reference/contacts/get-contacts-by-emails)
---
### Category: Contacts API - Custom Fields
#### Create a Custom Field
**Method**: `POST` | **LowCodeAPI Path**: `/v3/contactdb/custom_fields`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/custom_fields?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/custom_fields?api_token={api_token}
```
**Description**: Create a Custom Field
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `type` | string | No | Type |
| `name` | string | No | Name |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/contactdb/custom_fields?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a Custom Field](https://docs.sendgrid.com/api-reference/contacts-api-custom-fields/create-a-custom-field)
---
#### Retrieve all custom fields
**Method**: `GET` | **LowCodeAPI Path**: `/v3/contactdb/custom_fields`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/custom_fields?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/custom_fields?api_token={api_token}
```
**Description**: Retrieve all custom fields
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/contactdb/custom_fields?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all custom fields](https://docs.sendgrid.com/api-reference/contacts-api-custom-fields/retrieve-all-custom-fields)
---
#### Retrieve a Custom Field
**Method**: `GET` | **LowCodeAPI Path**: `/v3/contactdb/custom_fields/{custom_field_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/custom_fields/{custom_field_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/custom_fields/custom_field_id?custom_field_id={custom_field_id}&api_token={api_token}
```
**Description**: Retrieve a Custom Field
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `custom_field_id` | number | Yes | The ID of the custom field that you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/contactdb/custom_fields/{custom_field_id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a Custom Field](https://docs.sendgrid.com/api-reference/contacts-api-custom-fields/retrieve-a-custom-field)
---
#### Delete a Custom Field
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/contactdb/custom_fields/{custom_field_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/custom_fields/{custom_field_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/custom_fields/custom_field_id?custom_field_id={custom_field_id}&api_token={api_token}
```
**Description**: Delete a Custom Field
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `custom_field_id` | number | Yes | The ID of the custom field that you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/contactdb/custom_fields/{custom_field_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a Custom Field](https://docs.sendgrid.com/api-reference/contacts-api-custom-fields/delete-a-custom-field)
---
#### Retrieve reserved fields
**Method**: `GET` | **LowCodeAPI Path**: `/v3/contactdb/reserved_fields`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/reserved_fields?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/reserved_fields?api_token={api_token}
```
**Description**: Retrieve reserved fields
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/contactdb/reserved_fields?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve reserved fields](https://docs.sendgrid.com/api-reference/contacts-api-custom-fields/retrieve-reserved-fields)
---
### Category: Contacts API - Lists
#### Create a List
**Method**: `POST` | **LowCodeAPI Path**: `/v3/contactdb/lists`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists?api_token={api_token}
```
**Description**: Create a List
**Request Body**:
```json
{
"name": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `name` | string | Yes | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a List](https://docs.sendgrid.com/api-reference/contacts-api-lists/create-a-list)
---
#### Retrieve all lists
**Method**: `GET` | **LowCodeAPI Path**: `/v3/contactdb/lists`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists?api_token={api_token}
```
**Description**: Retrieve all lists
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all lists](https://docs.sendgrid.com/api-reference/contacts-api-lists/retrieve-all-lists)
---
#### Delete Multiple lists
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/contactdb/lists`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists?api_token={api_token}
```
**Description**: Delete Multiple lists
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete Multiple lists](https://docs.sendgrid.com/api-reference/contacts-api-lists/delete-multiple-lists)
---
#### Retrieve a single list
**Method**: `GET` | **LowCodeAPI Path**: `/v3/contactdb/lists/{list_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/{list_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/list_id?list_id={list_id}&api_token={api_token}
```
**Description**: Retrieve a single list
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/{list_id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a single list](https://docs.sendgrid.com/api-reference/contacts-api-lists/retrieve-a-single-list)
---
#### Update a List
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/contactdb/lists/{list_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/{list_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/list_id?list_id={list_id}&api_token={api_token}
```
**Description**: Update a List
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | |
**Request Body**:
```json
{
"name": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `name` | string | Yes | The new name for your list |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/{list_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update a List](https://docs.sendgrid.com/api-reference/contacts-api-lists/update-a-list)
---
#### Delete a contact list
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/contactdb/lists/{list_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/{list_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/list_id?list_id={list_id}&delete_contacts={delete_contacts}&api_token={api_token}
```
**Description**: Delete a contact list
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | . |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `delete_contacts` | boolean | No | Adds the ability to delete all contacts on the list in addition to deleting the list. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/{list_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a contact list](https://docs.sendgrid.com/api-reference/contacts-api-lists/delete-a-list)
---
#### Retrieve all recipients on a List
**Method**: `GET` | **LowCodeAPI Path**: `/v3/contactdb/lists/{list_id}/recipients`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/{list_id}/recipients?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/list_id/recipients?list_id={list_id}&page={page}&page_size={page_size}&api_token={api_token}
```
**Description**: Retrieve all recipients on a List
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | number | No | The id of the list of recipients you want to retrieve. |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | number | No | Page index of first recipient to return |
| `page_size` | number | No | Number of recipients to return at a time |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/{list_id}/recipients?page=VALUE&page_size=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all recipients on a List](https://docs.sendgrid.com/api-reference/contacts-api-lists/retrieve-all-recipients-on-a-list)
---
#### Add a Single Recipient to a List
**Method**: `POST` | **LowCodeAPI Path**: `/v3/contactdb/lists/{list_id}/recipients/{recipient_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/{list_id}/recipients/{recipient_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/list_id/recipients/recipient_id?list_id={list_id}&recipient_id={recipient_id}&api_token={api_token}
```
**Description**: Add a Single Recipient to a List
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | number | Yes | The ID of the list that you want to add the recipient to |
| `recipient_id` | string | Yes | The ID of the recipient you are adding to the list. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/{list_id}/recipients/{recipient_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add a Single Recipient to a List](https://docs.sendgrid.com/api-reference/contacts-api-lists/add-a-single-recipient-to-a-list)
---
#### Delete a Single Recipient from a Single List
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/contactdb/lists/{list_id}/recipients/{recipient_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/{list_id}/recipients/{recipient_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/list_id/recipients/recipient_id?list_id={list_id}&recipient_id={recipient_id}&api_token={api_token}
```
**Description**: Delete a Single Recipient from a Single List
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | number | Yes | The ID of the list that you want to add the recipient to |
| `recipient_id` | string | No | The ID of the recipient you are adding to the list. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/{list_id}/recipients/{recipient_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a Single Recipient from a Single List](https://docs.sendgrid.com/api-reference/contacts-api-lists/delete-a-single-recipient-from-a-single-list)
---
#### Add Multiple Recipients to a List
**Method**: `POST` | **LowCodeAPI Path**: `/v3/contactdb/lists/{list_id}/recipients`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/{list_id}/recipients?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/list_id/recipients?list_id={list_id}&api_token={api_token}
```
**Description**: Add Multiple Recipients to a List
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | number | Yes | The id of the list of recipients you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/contactdb/lists/{list_id}/recipients?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add Multiple Recipients to a List](https://docs.sendgrid.com/api-reference/contacts-api-lists/add-multiple-recipients-to-a-list)
---
### Category: Contacts API - Recipients
#### Add recipients
**Method**: `POST` | **LowCodeAPI Path**: `/v3/contactdb/recipients`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients?api_token={api_token}
```
**Description**: Add recipients
**Request Body**:
```json
{
"email": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `age` | number | No | The age of the recipient |
| `email` | string | Yes | The email address of the recipient |
| `first_name` | string | No | The first name of the recipient |
| `last_name` | string | No | The last name of the recipient |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add recipients](https://docs.sendgrid.com/api-reference/contacts-api-recipients/add-recipients)
---
#### Get Recipient Upload Status
**Method**: `GET` | **LowCodeAPI Path**: `/ /v3/contactdb/status`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/ /v3/contactdb/status?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid /v3/contactdb/status?api_token={api_token}
```
**Description**: Get Recipient Upload Status
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/ /v3/contactdb/status?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Recipient Upload Status](https://docs.sendgrid.com/api-reference/contacts-api-recipients/get-recipient-upload-status)
---
#### Update Recipient
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/contactdb/recipients`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients?api_token={api_token}
```
**Description**: Update Recipient
**Request Body**:
```json
{
"email": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `email` | string | Yes | |
| `first_name` | string | No | The first name of the recipient. |
| `last_name` | string | No | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update Recipient](https://docs.sendgrid.com/api-reference/contacts-api-recipients/update-recipient)
---
#### Delete Recipients
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/contactdb/recipients`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients?api_token={api_token}
```
**Description**: Delete Recipients
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete Recipients](https://docs.sendgrid.com/api-reference/contacts-api-recipients/delete-recipients)
---
#### Retrieve recipients
**Method**: `GET` | **LowCodeAPI Path**: `/v3/contactdb/recipients`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients?page={page}&page_size={page_size}&api_token={api_token}
```
**Description**: Retrieve recipients
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | number | No | Page index of first recipients to return (must be a positive integer) |
| `page_size` | number | No | Number of recipients to return at a time (must be a positive integer between 1 and 1000) |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients?page=VALUE&page_size=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve recipients](https://docs.sendgrid.com/api-reference/contacts-api-recipients/retrieve-recipients)
---
#### Retrieve a single recipient
**Method**: `GET` | **LowCodeAPI Path**: `/v3/contactdb/recipients/{recipient_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients/{recipient_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients/recipient_id?recipient_id={recipient_id}&api_token={api_token}
```
**Description**: Retrieve a single recipient
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `recipient_id` | string | Yes | The ID of the recipient that you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients/{recipient_id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a single recipient](https://docs.sendgrid.com/api-reference/contacts-api-recipients/retrieve-a-single-recipient)
---
#### Delete a Recipient
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/contactdb/recipients/{recipient_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients/{recipient_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients/recipient_id?recipient_id={recipient_id}&api_token={api_token}
```
**Description**: Delete a Recipient
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `recipient_id` | string | Yes | The ID of the recipient that you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients/{recipient_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a Recipient](https://docs.sendgrid.com/api-reference/contacts-api-recipients/delete-a-recipient)
---
#### Retrieve the lists that a recipient is on
**Method**: `GET` | **LowCodeAPI Path**: `/v3/contactdb/recipients/{recipient_id}/lists`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients/{recipient_id}/lists?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients/recipient_id/lists?recipient_id={recipient_id}&api_token={api_token}
```
**Description**: Retrieve the lists that a recipient is on
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `recipient_id` | string | Yes | The ID of the recipient for whom you are retrieving lists. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients/{recipient_id}/lists?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve the lists that a recipient is on](https://docs.sendgrid.com/api-reference/contacts-api-recipients/retrieve-the-lists-that-a-recipient-is-on)
---
#### Retrieve the count of billable recipients
**Method**: `GET` | **LowCodeAPI Path**: `/v3/contactdb/recipients/billable_count`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients/billable_count?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients/billable_count?api_token={api_token}
```
**Description**: Retrieve the count of billable recipients
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients/billable_count?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve the count of billable recipients](https://docs.sendgrid.com/api-reference/contacts-api-recipients/retrieve-the-count-of-billable-recipients)
---
#### Retrieve a Count of Recipients
**Method**: `GET` | **LowCodeAPI Path**: `/v3/contactdb/recipients/count`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients/count?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients/count?api_token={api_token}
```
**Description**: Retrieve a Count of Recipients
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients/count?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a Count of Recipients](https://docs.sendgrid.com/api-reference/contacts-api-recipients/retrieve-a-count-of-recipients)
---
#### Search recipients
**Method**: `POST` | **LowCodeAPI Path**: `/v3/contactdb/recipients/search`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients/search?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients/search?api_token={api_token}
```
**Description**: Search recipients
**Request Body**:
```json
{
"conditions": "<array>",
"list_id": "<number>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `conditions` | array | Yes | The conditions by which this segment should be created |
| `list_id` | number | Yes | List Id |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/contactdb/recipients/search?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Search recipients](https://docs.sendgrid.com/api-reference/contacts-api-recipients/search-recipients)
---
### Category: Contacts API - Segments
#### Create a Segment
**Method**: `POST` | **LowCodeAPI Path**: `/v3/contactdb/segments`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/segments?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/segments?api_token={api_token}
```
**Description**: Create a Segment
**Request Body**:
```json
{
"conditions": "<array>",
"name": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `conditions` | array | Yes | The conditions for a recipient to be included in this segment |
| `list_id` | number | No | The list id from which to make this segment |
| `name` | string | Yes | The name of this segment |
| `recipient_count` | number | No | The count of recipients in this list. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/contactdb/segments?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a Segment](https://docs.sendgrid.com/api-reference/contacts-api-segments/create-a-segment)
---
#### Retrieve all segments
**Method**: `GET` | **LowCodeAPI Path**: `/v3/contactdb/segments`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/segments?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/segments?api_token={api_token}
```
**Description**: Retrieve all segments
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/contactdb/segments?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all segments](https://docs.sendgrid.com/api-reference/contacts-api-segments/retrieve-all-segments)
---
#### Retrieve a segment
**Method**: `GET` | **LowCodeAPI Path**: `/v3/contactdb/segments/{segment_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/segments/{segment_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/segments/segment_id?segment_id={segment_id}&api_token={api_token}
```
**Description**: Retrieve a segment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | string | Yes | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/contactdb/segments/{segment_id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a segment](https://docs.sendgrid.com/api-reference/contacts-api-segments/retrieve-a-segment)
---
#### Delete a segment
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/contactdb/segments/{segment_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/segments/{segment_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/segments/segment_id?segment_id={segment_id}&delete_contacts={delete_contacts}&api_token={api_token}
```
**Description**: Delete a segment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | string | Yes | Segment Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `delete_contacts` | boolean | No | True to delete all contacts matching the segment in addition to deleting the segment |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/contactdb/segments/{segment_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a segment](https://docs.sendgrid.com/api-reference/contacts-api-segments/delete-a-segment)
---
#### Retrieve recipients on a segment
**Method**: `GET` | **LowCodeAPI Path**: `/v3/contactdb/segments/{segment_id}/recipients`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/segments/{segment_id}/recipients?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/contactdb/segments/segment_id/recipients?segment_id={segment_id}&page={page}&page_size={page_size}&api_token={api_token}
```
**Description**: Retrieve recipients on a segment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | number | Yes | The ID of the segment from which you want to retrieve recipients. |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | number | No | number of results to return |
| `page_size` | number | No | number of results to return |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/contactdb/segments/{segment_id}/recipients?page=VALUE&page_size=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve recipients on a segment](https://docs.sendgrid.com/api-reference/contacts-api-segments/retrieve-recipients-on-a-segment)
---
### Category: Custom Fields
#### Create Custom Field Definition
**Method**: `POST` | **LowCodeAPI Path**: `/v3/marketing/field_definitions`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/field_definitions?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/field_definitions?api_token={api_token}
```
**Description**: Create Custom Field Definition
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `"enum"` | [
true | No | |
| `"field_type"` | {
"type" | No | |
| `"text"` | "Field type"
"required" | No | |
| `false
]
}
}` | | No | |
| `{
"name"` | {
"type" | No | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/marketing/field_definitions?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create Custom Field Definition](https://docs.sendgrid.com/api-reference/custom-fields/create-custom-field-definition)
---
#### Get All Field Definitions
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/field_definitions`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/field_definitions?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/field_definitions?api_token={api_token}
```
**Description**: Get All Field Definitions
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/field_definitions?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get All Field Definitions](https://docs.sendgrid.com/api-reference/custom-fields/get-all-field-definitions)
---
#### Update Custom Field Definition
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/marketing/field_definitions/{custom_field_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/field_definitions/{custom_field_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/field_definitions/custom_field_id?custom_field_id={custom_field_id}&api_token={api_token}
```
**Description**: Update Custom Field Definition
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `custom_field_id` | string | Yes | Custom field Id |
**Request Body**:
```json
{
"name": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `name` | string | Yes | Name |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/marketing/field_definitions/{custom_field_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update Custom Field Definition](https://docs.sendgrid.com/api-reference/custom-fields/update-custom-field-definition)
---
#### Delete Custom Field Definition
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/marketing/field_definitions/{custom_field_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/field_definitions/{custom_field_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/field_definitions/custom_field_id?custom_field_id={custom_field_id}&api_token={api_token}
```
**Description**: Delete Custom Field Definition
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `custom_field_id` | string | Yes | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/marketing/field_definitions/{custom_field_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete Custom Field Definition](https://docs.sendgrid.com/api-reference/custom-fields/delete-custom-field-definition)
---
### Category: Designs API
#### Create Design
**Method**: `POST` | **LowCodeAPI Path**: `/v3/designs`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/designs?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/designs?api_token={api_token}
```
**Description**: Create Design
**Request Body**:
```json
{
"html_content": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `categories` | array | No | The list of categories applied to the design. |
| `editor` | string | No | The editor used in the UI |
| `generate_plain_content` | boolean | No | If true plain_content is always generated from html_content |
| `html_content` | string | Yes | The HTML content of the Design |
| `name` | string | No | The name of the new design |
| `plain_content` | string | No | Plain text content of the Design |
| `subject` | string | No | Subject of the Design |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/designs?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create Design](https://docs.sendgrid.com/api-reference/designs-api/create-design)
---
#### Duplicate Design
**Method**: `POST` | **LowCodeAPI Path**: `/v3/designs/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/designs/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/designs/id?id={id}&api_token={api_token}
```
**Description**: Duplicate Design
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Design you want to duplicate |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `editor` | string | No | The editor used in the UI. |
| `name` | string | No | The name of the new design |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/designs/{id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Duplicate Design](https://docs.sendgrid.com/api-reference/designs-api/duplicate-design)
---
#### List Designs
**Method**: `GET` | **LowCodeAPI Path**: `/v3/designs`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/designs?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/designs?page_size={page_size}&page_token={page_token}&summary={summary}&api_token={api_token}
```
**Description**: List Designs
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | number | No | number of results to return |
| `page_token` | string | No | token corresponding to a specific page of results as provided by metadata |
| `summary` | boolean | No | set to false to return all fields. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/designs?page_size=VALUE&page_token=VALUE&summary=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [List Designs](https://docs.sendgrid.com/api-reference/designs-api/list-designs)
---
#### Get Design
**Method**: `GET` | **LowCodeAPI Path**: `/v3/designs/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/designs/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/designs/id?id={id}&api_token={api_token}
```
**Description**: Get Design
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Design you want to duplicate |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/designs/{id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Design](https://docs.sendgrid.com/api-reference/designs-api/get-design)
---
#### Duplicate SendGrid Pre-built Design
**Method**: `POST` | **LowCodeAPI Path**: `/v3/designs/pre-builts/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/designs/pre-builts/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/designs/pre-builts/id?id={id}&api_token={api_token}
```
**Description**: Duplicate SendGrid Pre-built Design
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the pre-built Design you want to duplicate |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `editor` | string | No | The editor used in the UI. |
| `name` | string | No | The name of the new design |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/designs/pre-builts/{id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Duplicate SendGrid Pre-built Design](https://docs.sendgrid.com/api-reference/designs-api/duplicate-sendgrid-pre-built-design)
---
#### List SendGrid Pre-built Designs
**Method**: `GET` | **LowCodeAPI Path**: `/v3/designs/pre-builts`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/designs/pre-builts?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/designs/pre-builts?page_size={page_size}&page_token={page_token}&summary={summary}&api_token={api_token}
```
**Description**: List SendGrid Pre-built Designs
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | number | No | number of results to return |
| `page_token` | string | No | token corresponding to a specific page of results as provided by metadata |
| `summary` | boolean | No | set to false to return all fields |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/designs/pre-builts?page_size=VALUE&page_token=VALUE&summary=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [List SendGrid Pre-built Designs](https://docs.sendgrid.com/api-reference/designs-api/list-sendgrid-pre-built-designs)
---
#### Get SendGrid Pre-built Design
**Method**: `GET` | **LowCodeAPI Path**: `/v3/designs/pre-builts/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/designs/pre-builts/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/designs/pre-builts/id?id={id}&api_token={api_token}
```
**Description**: Get SendGrid Pre-built Design
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the pre-built Design you want to duplicate |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/designs/pre-builts/{id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get SendGrid Pre-built Design](https://docs.sendgrid.com/api-reference/designs-api/get-sendgrid-pre-built-design)
---
#### Update Design
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/designs/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/designs/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/designs/id?id={id}&api_token={api_token}
```
**Description**: Update Design
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Design you want to duplicate |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `categories` | array | No | The list of categories applied to the design. |
| `generate_plain_content` | boolean | No | If true plain_content is always generated from html_content |
| `html_content` | string | No | The HTML content of the Design |
| `name` | string | No | Name of the Design |
| `plain_content` | string | No | Plain text content of the Design |
| `subject` | string | No | Subject of the Design |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/designs/{id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update Design](https://docs.sendgrid.com/api-reference/designs-api/update-design)
---
#### Delete Design
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/designs/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/designs/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/designs/id?id={id}&api_token={api_token}
```
**Description**: Delete Design
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Design you want to duplicate |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/designs/{id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete Design](https://docs.sendgrid.com/api-reference/designs-api/delete-design)
---
### Category: Domain Authentication
#### List all authenticated domains
**Method**: `GET` | **LowCodeAPI Path**: `/v3/whitelabel/domains`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains?domain={domain}&exclude_subusers={exclude_subusers}&limit={limit}&offset={offset}&username={username}&api_token={api_token}
```
**Description**: List all authenticated domains
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | No | Search for authenticated domains. |
| `exclude_subusers` | boolean | No | Exclude subuser domains from the result |
| `limit` | number | No | Number of domains to return |
| `offset` | number | No | Paging offset |
| `username` | string | No | The username associated with an authenticated domain |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains?domain=VALUE&exclude_subusers=VALUE&limit=VALUE&offset=VALUE&username=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [List all authenticated domains](https://docs.sendgrid.com/api-reference/domain-authentication/list-all-authenticated-domains)
---
#### Retrieve an authenticated domain
**Method**: `GET` | **LowCodeAPI Path**: `/v3/whitelabel/domains/{domain_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/{domain_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/domain_id?domain_id={domain_id}&api_token={api_token}
```
**Description**: Retrieve an authenticated domain
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain_id` | string | Yes | Domain Id |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/{domain_id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve an authenticated domain](https://docs.sendgrid.com/api-reference/domain-authentication/retrieve-an-authenticated-domain)
---
#### Authenticate a domain
**Method**: `POST` | **LowCodeAPI Path**: `/v3/whitelabel/domains`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains?api_token={api_token}
```
**Description**: Authenticate a domain
**Request Body**:
```json
{
"domain": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `automatic_security` | boolean | No | Whether to allow SendGrid to manage your SPF records DKIM keys and DKIM key rotation |
| `custom_dkim_selector` | string | No | Add a custom DKIM selector |
| `custom_spf` | boolean | No | Specify whether to use a custom SPF or allow SendGrid to manage your SPF |
| `default` | boolean | No | Whether to use this authenticated domain as the fallback if no authenticated domains match the sender's domain |
| `domain` | string | Yes | Domain being authenticated |
| `ips` | array | No | The IP addresses that will be included in the custom SPF record for this authenticated domain |
| `subdomain` | string | No | The subdomain to use for this authenticated domain |
| `username` | string | No | The username associated with this domain |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Authenticate a domain](https://docs.sendgrid.com/api-reference/domain-authentication/authenticate-a-domain)
---
#### Update an authenticated domain
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/whitelabel/domains/{domain_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/{domain_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/domain_id?domain_id={domain_id}&api_token={api_token}
```
**Description**: Update an authenticated domain
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain_id` | string | Yes | Domain Id |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `custom_spf` | boolean | No | Indicates whether to generate a custom SPF record for manual security. |
| `default` | boolean | No | Indicates whether this is the default authenticated domain |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/{domain_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update an authenticated domain](https://docs.sendgrid.com/api-reference/domain-authentication/update-an-authenticated-domain)
---
#### Delete an authenticated domain
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/whitelabel/domains/{domain_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/{domain_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/domain_id?domain_id={domain_id}&api_token={api_token}
```
**Description**: Delete an authenticated domain
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain_id` | string | Yes | Domain Id |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/{domain_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete an authenticated domain](https://docs.sendgrid.com/api-reference/domain-authentication/delete-an-authenticated-domain)
---
#### Get the default authentication
**Method**: `GET` | **LowCodeAPI Path**: `/v3/whitelabel/domains/default`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/default?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/default?domain={domain}&api_token={api_token}
```
**Description**: Get the default authentication
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | No | The domain to find a default authentication. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/default?domain=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get the default authentication](https://docs.sendgrid.com/api-reference/domain-authentication/get-the-default-authentication)
---
#### Add an IP to an authenticated domain
**Method**: `POST` | **LowCodeAPI Path**: `/v3/whitelabel/domains/{id}/ips`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/{id}/ips?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/id/ips?id={id}&api_token={api_token}
```
**Description**: Add an IP to an authenticated domain
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | number | Yes | ID of the domain to which you are adding an IP |
**Request Body**:
```json
{
"ip": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `ip` | string | Yes | IP to associate with the domain |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/{id}/ips?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add an IP to an authenticated domain](https://docs.sendgrid.com/api-reference/domain-authentication/add-an-ip-to-an-authenticated-domain)
---
#### Remove an IP from an authenticated domain
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/whitelabel/domains/{id}/ips/{ip}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/{id}/ips/{ip}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/id/ips/ip?id={id}&ip={ip}&api_token={api_token}
```
**Description**: Remove an IP from an authenticated domain
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | number | Yes | ID of the domain to delete the IP from |
| `ip` | string | Yes | IP to remove from the domain. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/{id}/ips/{ip}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Remove an IP from an authenticated domain](https://docs.sendgrid.com/api-reference/domain-authentication/remove-an-ip-from-an-authenticated-domain)
---
#### Validate a domain authentication
**Method**: `POST` | **LowCodeAPI Path**: `/v3/whitelabel/domains/{id}/validate`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/{id}/validate?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/id/validate?id={id}&api_token={api_token}
```
**Description**: Validate a domain authentication
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | number | No | required |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/{id}/validate?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Validate a domain authentication](https://docs.sendgrid.com/api-reference/domain-authentication/validate-a-domain-authentication)
---
#### List the authenticated domain associated with the given user
**Method**: `GET` | **LowCodeAPI Path**: `/v3/whitelabel/domains/subuser`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/subuser?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/subuser?username={username}&api_token={api_token}
```
**Description**: List the authenticated domain associated with the given user
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `username` | string | Yes | Username for the subuser to find associated authenticated domain. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/subuser?username=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [List the authenticated domain associated with the given user](https://docs.sendgrid.com/api-reference/domain-authentication/list-the-authenticated-domain-associated-with-the-given-user)
---
#### Disassociate a authenticated domain from a given user
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/whitelabel/domains/subuser`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/subuser?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/subuser?username={username}&api_token={api_token}
```
**Description**: Disassociate a authenticated domain from a given user
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `username` | string | No | Username for the subuser to find associated authenticated domain. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/subuser?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Disassociate a authenticated domain from a given user](https://docs.sendgrid.com/api-reference/domain-authentication/disassociate-a-authenticated-domain-from-a-given-user)
---
#### Associate a authenticated domain with a given user
**Method**: `POST` | **LowCodeAPI Path**: `/v3/whitelabel/domains/{domain_id}/subuser`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/{domain_id}/subuser?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/domain_id/subuser?domain_id={domain_id}&api_token={api_token}
```
**Description**: Associate a authenticated domain with a given user
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain_id` | number | Yes | ID of the authenticated domain to associate with the subuser |
**Request Body**:
```json
{
"username": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `username` | string | Yes | Username to associate with the authenticated domain |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/domains/{domain_id}/subuser?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Associate a authenticated domain with a given user](https://docs.sendgrid.com/api-reference/domain-authentication/associate-a-authenticated-domain-with-a-given-user)
---
### Category: E-Mail Activity
#### Filter all messages
**Method**: `GET` | **LowCodeAPI Path**: `/v3/messages`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/messages?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/messages?limit={limit}&query={query}&api_token={api_token}
```
**Description**: Filter all messages
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | The number of messages returned. |
| `query` | string | Yes | Use the query syntax to filter your email activity. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/messages?limit=VALUE&query=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Filter all messages](https://docs.sendgrid.com/api-reference/e-mail-activity/filter-all-messages)
---
#### Filter messages by message ID
**Method**: `GET` | **LowCodeAPI Path**: `/v3/messages/{msg_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/messages/{msg_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/messages/msg_id?msg_id={msg_id}&api_token={api_token}
```
**Description**: Filter messages by message ID
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `msg_id` | string | Yes | The ID of the message you are requesting details for. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/messages/{msg_id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Filter messages by message ID](https://docs.sendgrid.com/api-reference/e-mail-activity/filter-messages-by-message-id)
---
#### Request a CSV
**Method**: `POST` | **LowCodeAPI Path**: `/v3/messages/download`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/messages/download?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/messages/download?query={query}&api_token={api_token}
```
**Description**: Request a CSV
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Uses a SQL like syntax to indicate which messages to include in the CSV |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/messages/download?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Request a CSV](https://docs.sendgrid.com/api-reference/e-mail-activity/request-a-csv)
---
#### Download CSV
**Method**: `GET` | **LowCodeAPI Path**: `/v3/messages/download/{download_uuid}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/messages/download/{download_uuid}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/messages/download/download_uuid?download_uuid={download_uuid}&api_token={api_token}
```
**Description**: Download CSV
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `download_uuid` | string | Yes | UUID used to locate the download csv request entry in the DB. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/messages/download/{download_uuid}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Download CSV](https://docs.sendgrid.com/api-reference/e-mail-activity/download-csv)
---
### Category: E-Mail Address Validation
#### Validate an email
**Method**: `POST` | **LowCodeAPI Path**: `/v3/validations/email`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/validations/email?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/validations/email?api_token={api_token}
```
**Description**: Validate an email
**Request Body**:
```json
{
"email": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `email` | string | Yes | The email address that you want to validate |
| `source` | string | No | A one-word classifier for where this validation originated |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/validations/email?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Validate an email](https://docs.sendgrid.com/api-reference/e-mail-address-validation/validate-an-email)
---
### Category: E-Mail CNAME Records
#### Email DNS records to a co-worker
**Method**: `POST` | **LowCodeAPI Path**: `/v3/whitelabel/dns/email`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/dns/email?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/dns/email?api_token={api_token}
```
**Description**: Email DNS records to a co-worker
**Request Body**:
```json
{
"email": "<string>",
"link_id": "<number>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `email` | string | Yes | The email address to send the DNS information to |
| `link_id` | number | Yes | The ID of the branded link.
domain_id |
| `message` | string | No | A custom text block to include in the email body sent with the records. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/dns/email?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Email DNS records to a co-worker](https://docs.sendgrid.com/api-reference/e-mail-cname-records/email-dns-records-to-a-co-worker)
---
### Category: IP Access Management
#### Add one or more IPs to the allow list
**Method**: `POST` | **LowCodeAPI Path**: `/v3/access_settings/whitelist`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/access_settings/whitelist?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/access_settings/whitelist?api_token={api_token}
```
**Description**: Add one or more IPs to the allow list
**Request Body**:
```json
{
"ips": "<array>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `ips` | array | Yes | An array containing the IP(s) you want to allow. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/access_settings/whitelist?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add one or more IPs to the allow list](https://docs.sendgrid.com/api-reference/ip-access-management/add-one-or-more-ips-to-the-allow-list)
---
#### Retrieve all recent access attempts
**Method**: `GET` | **LowCodeAPI Path**: `/v3/access_settings/activity`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/access_settings/activity?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/access_settings/activity?limit={limit}&api_token={api_token}
```
**Description**: Retrieve all recent access attempts
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Limits the number of IPs to return |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/access_settings/activity?limit=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all recent access attempts](https://docs.sendgrid.com/api-reference/ip-access-management/retrieve-all-recent-access-attempts)
---
#### Retrieve a list of currently allowed IPs
**Method**: `GET` | **LowCodeAPI Path**: `/v3/access_settings/whitelist`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/access_settings/whitelist?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/access_settings/whitelist?api_token={api_token}
```
**Description**: Retrieve a list of currently allowed IPs
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/access_settings/whitelist?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a list of currently allowed IPs](https://docs.sendgrid.com/api-reference/ip-access-management/retrieve-a-list-of-currently-allowed-ips)
---
#### Retrieve a specific allowed IP
**Method**: `GET` | **LowCodeAPI Path**: `/v3/access_settings/whitelist/{rule_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/access_settings/whitelist/{rule_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/access_settings/whitelist/rule_id?rule_id={rule_id}&api_token={api_token}
```
**Description**: Retrieve a specific allowed IP
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rule_id` | string | Yes | The ID of the allowed IP address that you want to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/access_settings/whitelist/{rule_id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a specific allowed IP](https://docs.sendgrid.com/api-reference/ip-access-management/retrieve-a-specific-allowed-ip)
---
#### Remove one or more IPs from the allow list
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/access_settings/whitelist`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/access_settings/whitelist?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/access_settings/whitelist?api_token={api_token}
```
**Description**: Remove one or more IPs from the allow list
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/access_settings/whitelist?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Remove one or more IPs from the allow list](https://docs.sendgrid.com/api-reference/ip-access-management/remove-one-or-more-ips-from-the-allow-list)
---
#### Remove a specific IP from the allowed list
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/access_settings/whitelist/{rule_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/access_settings/whitelist/{rule_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/access_settings/whitelist/rule_id?rule_id={rule_id}&api_token={api_token}
```
**Description**: Remove a specific IP from the allowed list
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rule_id` | string | Yes | The ID of the allowed IP address that you want to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/access_settings/whitelist/{rule_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Remove a specific IP from the allowed list](https://docs.sendgrid.com/api-reference/ip-access-management/remove-a-specific-ip-from-the-allowed-list)
---
### Category: IP Address
#### Add IPs
**Method**: `POST` | **LowCodeAPI Path**: `/v3/ips`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips?api_token={api_token}
```
**Description**: Add IPs
**Request Body**:
```json
{
"count": "<number>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `count` | number | Yes | The amount of IPs to add to the account |
| `subusers` | array | No | Array of usernames to be assigned a send IP |
| `warmup` | boolean | No | Whether or not to warmup the IPs being added. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/ips?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add IPs](https://docs.sendgrid.com/api-reference/ip-address/add-ips)
---
#### Get remaining IPs count
**Method**: `GET` | **LowCodeAPI Path**: `/v3/ips/remaining`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/remaining?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/remaining?api_token={api_token}
```
**Description**: Get remaining IPs count
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/ips/remaining?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get remaining IPs count](https://docs.sendgrid.com/api-reference/ip-address/get-remaining-ips-count)
---
#### Retrieve all IP addresses
**Method**: `GET` | **LowCodeAPI Path**: `/v3/ips`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips?exclude_whitelabels={exclude_whitelabels}&ip={ip}&limit={limit}&offset={offset}&sort_by_direction={sort_by_direction}&subuser={subuser}&api_token={api_token}
```
**Description**: Retrieve all IP addresses
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `exclude_whitelabels` | boolean | No | Should we exclude reverse DNS records |
| `ip` | string | No | The IP address to get |
| `limit` | number | No | The number of IPs you want returned at the same time |
| `offset` | number | No | The offset for the number of IPs that you are requesting |
| `sort_by_direction` | string | No | The direction to sort the results. |
| `subuser` | string | No | The subuser you are requesting for |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/ips?exclude_whitelabels=VALUE&ip=VALUE&limit=VALUE&offset=VALUE&sort_by_direction=VALUE&subuser=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all IP addresses](https://docs.sendgrid.com/api-reference/ip-address/retrieve-all-ip-addresses)
---
#### Retrieve all assigned IPs
**Method**: `GET` | **LowCodeAPI Path**: `/v3/ips/assigned`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/assigned?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/assigned?api_token={api_token}
```
**Description**: Retrieve all assigned IPs
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/ips/assigned?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all assigned IPs](https://docs.sendgrid.com/api-reference/ip-address/retrieve-all-assigned-ips)
---
#### Retrieve all IP pools an IP address belongs to
**Method**: `GET` | **LowCodeAPI Path**: `/v3/ips/{ip_address}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/{ip_address}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/ip_address?ip_address={ip_address}&api_token={api_token}
```
**Description**: Retrieve all IP pools an IP address belongs to
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip_address` | string | Yes | The IP address you are retrieving the IP pools for |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/ips/{ip_address}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all IP pools an IP address belongs to](https://docs.sendgrid.com/api-reference/ip-address/retrieve-all-ip-pools-an-ip-address-belongs-to)
---
### Category: IP Address Management API
#### Get a List of all IP Addresses on your Account
**Method**: `GET` | **LowCodeAPI Path**: `/v3/send_ips/ips`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips?after_key={after_key}&before_key={before_key}&end_added_at={end_added_at}&ip={ip}&is_enabled={is_enabled}&is_parent_assigned={is_parent_assigned}&limit={limit}&pool={pool}&start_added_at={start_added_at}&api_token={api_token}
```
**Description**: Get a List of all IP Addresses on your Account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after_key` | number | No | Specifies which items to be returned by the API |
| `before_key` | string | No | Specifies which items to be returned by the API |
| `end_added_at` | number | No | The start_added_at and end_added_at parameters are used to set a time window. |
| `ip` | string | No | Specifices an IP address |
| `is_enabled` | boolean | No | Indicates if the IP address is billed and able to send email |
| `is_parent_assigned` | boolean | No | Indicates if a parent on the account is able to send email from the IP address |
| `limit` | number | No | Specifies the number of results to be returned by the API |
| `pool` | string | No | Specifies the unique ID for an IP Pool |
| `start_added_at` | number | No | The start_added_at and end_added_at parameters are used to set a time window |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips?after_key=VALUE&before_key=VALUE&end_added_at=VALUE&ip=VALUE&is_enabled=VALUE&is_parent_assigned=VALUE&limit=VALUE&pool=VALUE&start_added_at=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get a List of all IP Addresses on your Account](https://docs.sendgrid.com/api-reference/ip-address-management-api/get-a-list-of-all-ip-addresses-on-your-account)
---
#### Add a Twilio SendGrid IP Address
**Method**: `POST` | **LowCodeAPI Path**: `/v3/send_ips/ips`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips?api_token={api_token}
```
**Description**: Add a Twilio SendGrid IP Address
**Request Body**:
```json
{
"is_auto_warmup": "<boolean>",
"is_parent_assigned": "<boolean>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `is_auto_warmup` | boolean | Yes | Indicates if the IP address is set to automatically warmup |
| `is_parent_assigned` | boolean | Yes | Indicates if a parent on the account is able to send email from the IP address |
| `subusers` | array | No | An array of Subuser IDs the IP address will be assigned to. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add a Twilio SendGrid IP Address](https://docs.sendgrid.com/api-reference/ip-address-management-api/add-a-twilio-sendgrid-ip-address)
---
#### Get Details for an IP Address
**Method**: `GET` | **LowCodeAPI Path**: `/v3/send_ips/ips/{ip}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips/{ip}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips/ip?ip={ip}&api_token={api_token}
```
**Description**: Get Details for an IP Address
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | Yes | The ip path parameter specifies an IP address to make the request against. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips/{ip}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Details for an IP Address](https://docs.sendgrid.com/api-reference/ip-address-management-api/get-details-for-an-ip-address)
---
#### Update Details for an IP Address
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/send_ips/ips/{ip}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips/{ip}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips/ip?ip={ip}&api_token={api_token}
```
**Description**: Update Details for an IP Address
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | Yes | The ip path parameter specifies an IP address to make the request against. |
**Request Body**:
```json
{
"is_auto_warmup": "<boolean>",
"is_parent_assigned": "<boolean>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `is_auto_warmup` | boolean | Yes | Indicates if the IP address is set to automatically warmup |
| `is_enabled` | boolean | No | Indicates if the IP address is billed and able to send email. |
| `is_parent_assigned` | boolean | Yes | Indicates if a parent on the account is able to send email from the IP address |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips/{ip}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update Details for an IP Address](https://docs.sendgrid.com/api-reference/ip-address-management-api/update-details-for-an-ip-address)
---
#### GET all IP Pools that have Associated IPs
**Method**: `GET` | **LowCodeAPI Path**: `/v3/send_ips/pools`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools?after_key={after_key}&ip={ip}&limit={limit}&api_token={api_token}
```
**Description**: GET all IP Pools that have Associated IPs
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after_key` | number | No | Specifies which items to be returned by the API |
| `ip` | string | No | Specifices an IP address. |
| `limit` | number | No | Specifies the number of results to be returned by the API |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools?after_key=VALUE&ip=VALUE&limit=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [GET all IP Pools that have Associated IPs](https://docs.sendgrid.com/api-reference/ip-address-management-api/get-all-ip-pools-that-have-associated-ips)
---
#### Create an IP Pool with a Name and IP Assignments
**Method**: `POST` | **LowCodeAPI Path**: `/v3/send_ips/pools`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools?api_token={api_token}
```
**Description**: Create an IP Pool with a Name and IP Assignments
**Request Body**:
```json
{
"name": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `ips` | array | No | An array of IP addresses to assign to the IP Pool. |
| `name` | string | Yes | The name to assign to the IP Pool |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create an IP Pool with a Name and IP Assignments](https://docs.sendgrid.com/api-reference/ip-address-management-api/create-an-ip-pool-with-a-name-and-ip-assignments)
---
#### Get Details for an IP Pool
**Method**: `GET` | **LowCodeAPI Path**: `/v3/send_ips/pools/{poolid}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools/{poolid}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools/poolid?poolid={poolid}&api_token={api_token}
```
**Description**: Get Details for an IP Pool
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `poolid` | string | Yes | Specifies the unique ID for an IP Pool |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools/{poolid}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Details for an IP Pool](https://docs.sendgrid.com/api-reference/ip-address-management-api/get-details-for-an-ip-pool)
---
#### Update an IP Pool Name
**Method**: `PUT` | **LowCodeAPI Path**: `/v3/send_ips/pools/{poolid}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools/{poolid}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools/poolid?poolid={poolid}&api_token={api_token}
```
**Description**: Update an IP Pool Name
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `poolid` | string | Yes | Specifies the unique ID for an IP Pool |
**Request Body**:
```json
{
"name": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `name` | string | Yes | The name to assign to the IP Pool |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools/{poolid}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update an IP Pool Name](https://docs.sendgrid.com/api-reference/ip-address-management-api/update-an-ip-pool-name)
---
#### Delete an IP Pool using pool id
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/send_ips/pools/{poolid}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools/{poolid}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools/poolid?poolid={poolid}&api_token={api_token}
```
**Description**: Delete an IP Pool using pool id
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `poolid` | string | Yes | Specifies the unique ID for an IP Pool |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools/{poolid}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete an IP Pool using pool id](https://docs.sendgrid.com/api-reference/ip-address-management-api/delete-an-ip-pool)
---
#### Get IPs Assigned to an IP Pool
**Method**: `GET` | **LowCodeAPI Path**: `/v3/send_ips/pools/{poolid}/ips`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools/{poolid}/ips?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools/poolid/ips?poolid={poolid}&after_key={after_key}&limit={limit}&api_token={api_token}
```
**Description**: Get IPs Assigned to an IP Pool
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `poolid` | string | Yes | Specifies the unique ID for an IP Pool |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after_key` | number | No | Specifies which items to be returned by the API |
| `limit` | number | No | Specifies the number of results to be returned by the API |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools/{poolid}/ips?after_key=VALUE&limit=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get IPs Assigned to an IP Pool](https://docs.sendgrid.com/api-reference/ip-address-management-api/get-ips-assigned-to-an-ip-pool)
---
#### Add a Batch of IPs to an IP Pool
**Method**: `POST` | **LowCodeAPI Path**: `/v3/send_ips/pools/{poolid}/ips:batchAdd`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools/{poolid}/ips:batchAdd?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools/poolid/ips-batchadd?poolid={poolid}&api_token={api_token}
```
**Description**: Add a Batch of IPs to an IP Pool
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `poolid` | string | Yes | Specifies the unique ID for an IP Pool |
**Request Body**:
```json
{
"ips": "<array>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `ips` | array | Yes | An array of IP addresses to assign to the specified IP Pool. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools/{poolid}/ips:batchAdd?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add a Batch of IPs to an IP Pool](https://docs.sendgrid.com/api-reference/ip-address-management-api/add-a-batch-of-ips-to-an-ip-pool)
---
#### Delete a Batch of IPs from an IP Pool
**Method**: `POST` | **LowCodeAPI Path**: `/v3/send_ips/pools/{poolid}/ips:batchDelete`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools/{poolid}/ips:batchDelete?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools/poolid/ips-batchdelete?poolid={poolid}&ips={ips}&api_token={api_token}
```
**Description**: Delete a Batch of IPs from an IP Pool
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `poolid` | string | Yes | Specifies the unique ID for an IP Pool. |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ips` | array | Yes | An array of IP addresses to remove from the specified IP Pool. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/send_ips/pools/{poolid}/ips:batchDelete?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a Batch of IPs from an IP Pool](https://docs.sendgrid.com/api-reference/ip-address-management-api/delete-a-batch-of-ips-from-an-ip-pool)
---
#### Get a List of Subusers Assigned to an IP
**Method**: `GET` | **LowCodeAPI Path**: `/v3/send_ips/ips/{ip}/subusers`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips/{ip}/subusers?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips/ip/subusers?ip={ip}&after_key={after_key}&limit={limit}&api_token={api_token}
```
**Description**: Get a List of Subusers Assigned to an IP
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | Yes | The ip path parameter specifies an IP address to make the request against. |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after_key` | number | No | Specifies which items to be returned by the API |
| `limit` | number | No | Specifies the number of results to be returned by the API. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips/{ip}/subusers?after_key=VALUE&limit=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get a List of Subusers Assigned to an IP](https://docs.sendgrid.com/api-reference/ip-address-management-api/get-a-list-of-subusers-assigned-to-an-ip)
---
#### Assign a Batch of Subusers to an IP
**Method**: `POST` | **LowCodeAPI Path**: `/v3/send_ips/ips/{ip}/subusers:batchAdd`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips/{ip}/subusers:batchAdd?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips/ip/subusers-batchadd?ip={ip}&api_token={api_token}
```
**Description**: Assign a Batch of Subusers to an IP
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | Yes | The ip path parameter specifies an IP address to make the request against. |
**Request Body**:
```json
{
"subusers": "<array>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `subusers` | array | Yes | An array of Subuser IDs to be assigned to the specified IP address. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips/{ip}/subusers:batchAdd?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Assign a Batch of Subusers to an IP](https://docs.sendgrid.com/api-reference/ip-address-management-api/assign-a-batch-of-subusers-to-an-ip)
---
#### Delete a Batch of Subusers from an IP
**Method**: `POST` | **LowCodeAPI Path**: `/v3/send_ips/ips/{ip}/subusers:batchDelete`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips/{ip}/subusers:batchDelete?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips/ip/subusers-batchdelete?ip={ip}&api_token={api_token}
```
**Description**: Delete a Batch of Subusers from an IP
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | Yes | The ip path parameter specifies an IP address to make the request against. |
**Request Body**:
```json
{
"subusers": "<array>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `subusers` | array | Yes | The ip path parameter specifies an IP address to make the request against. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/send_ips/ips/{ip}/subusers:batchDelete?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a Batch of Subusers from an IP](https://docs.sendgrid.com/api-reference/ip-address-management-api/delete-a-batch-of-subusers-from-an-ip)
---
### Category: IP Pools
#### Create an IP pool
**Method**: `POST` | **LowCodeAPI Path**: `/v3/ips/pools`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/pools?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/pools?api_token={api_token}
```
**Description**: Create an IP pool
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `name` | string | No | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/ips/pools?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create an IP pool](https://docs.sendgrid.com/api-reference/ip-pools/create-an-ip-pool)
---
#### Add an IP address to a pool
**Method**: `POST` | **LowCodeAPI Path**: `/v3/ips/pools/{pool_name}/ips`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/pools/{pool_name}/ips?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/pools/pool_name/ips?pool_name={pool_name}&api_token={api_token}
```
**Description**: Add an IP address to a pool
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pool_name` | string | Yes | The name of the IP pool you want to add the address to |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `ip` | string | No | The IP address that you want to add to the named pool |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/ips/pools/{pool_name}/ips?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add an IP address to a pool](https://docs.sendgrid.com/api-reference/ip-pools/add-an-ip-address-to-a-pool)
---
#### Retrieve all IP pools
**Method**: `GET` | **LowCodeAPI Path**: `/v3/ips/pools`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/pools?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/pools?api_token={api_token}
```
**Description**: Retrieve all IP pools
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/ips/pools?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all IP pools](https://docs.sendgrid.com/api-reference/ip-pools/retrieve-all-ip-pools)
---
#### Retrieve all the IPs in a specified pool
**Method**: `GET` | **LowCodeAPI Path**: `/v3/ips/pools/{pool_name}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/pools/{pool_name}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/pools/pool_name?pool_name={pool_name}&api_token={api_token}
```
**Description**: Retrieve all the IPs in a specified pool
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pool_name` | string | Yes | The name of the IP pool that you want to retrieve the IP addresses for |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/ips/pools/{pool_name}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all the IPs in a specified pool](https://www.twilio.com/docs/sendgrid/api-reference/ip-pools/retrieve-all-the-ips-in-a-specified-pool)
---
#### Rename an IP pool
**Method**: `PUT` | **LowCodeAPI Path**: `/v3/ips/pools/{pool_name}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/pools/{pool_name}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/pools/pool_name?pool_name={pool_name}&api_token={api_token}
```
**Description**: Rename an IP pool
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pool_name` | string | Yes | The name of the IP pool that you want to retrieve the IP addresses for |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `name` | string | No | The new name for your IP pool |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/sendgrid/v3/ips/pools/{pool_name}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Rename an IP pool](https://docs.sendgrid.com/api-reference/ip-pools/rename-an-ip-pool)
---
#### Delete an IP pool
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/ips/pools/{pool_name}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/pools/{pool_name}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/pools/pool_name?pool_name={pool_name}&api_token={api_token}
```
**Description**: Delete an IP pool
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pool_name` | string | No | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/ips/pools/{pool_name}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete an IP pool](https://docs.sendgrid.com/api-reference/ip-pools/delete-an-ip-pool)
---
#### Remove an IP address from a pool
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/ips/pools/{pool_name}/ips/{ip}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/pools/{pool_name}/ips/{ip}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/pools/pool_name/ips/ip?ip={ip}&pool_name={pool_name}&api_token={api_token}
```
**Description**: Remove an IP address from a pool
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | Yes | The IP address that you wish to remove |
| `pool_name` | string | Yes | The name of the IP pool that you are removing the IP address from |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/ips/pools/{pool_name}/ips/{ip}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Remove an IP address from a pool](https://docs.sendgrid.com/api-reference/ip-pools/remove-an-ip-address-from-a-pool)
---
### Category: IP Warmup
#### Start warming up an IP address
**Method**: `POST` | **LowCodeAPI Path**: `/v3/ips/warmup`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/warmup?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/warmup?api_token={api_token}
```
**Description**: Start warming up an IP address
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `ip` | string | No | The IP address that you want to begin warming up |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/ips/warmup?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Start warming up an IP address](https://docs.sendgrid.com/api-reference/ip-warmup/start-warming-up-an-ip-address)
---
#### Retrieve all IPs currently in warmup
**Method**: `GET` | **LowCodeAPI Path**: `/v3/ips/warmup`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/warmup?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/warmup?api_token={api_token}
```
**Description**: Retrieve all IPs currently in warmup
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/ips/warmup?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all IPs currently in warmup](https://docs.sendgrid.com/api-reference/ip-warmup/retrieve-all-ips-currently-in-warmup)
---
#### Retrieve the warmup status for a specific IP address
**Method**: `GET` | **LowCodeAPI Path**: `/v3/ips/warmup/{ip_address}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/warmup/{ip_address}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/warmup/ip_address?ip_address={ip_address}&api_token={api_token}
```
**Description**: Retrieve the warmup status for a specific IP address
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip_address` | string | Yes | The IP address that you want to retrieve the warmup status for |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/ips/warmup/{ip_address}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve the warmup status for a specific IP address](https://docs.sendgrid.com/api-reference/ip-warmup/retrieve-the-warmup-status-for-a-specific-ip-address)
---
#### Stop warming up an IP address
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/ips/warmup/{ip_address}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/warmup/{ip_address}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/ips/warmup/ip_address?ip_address={ip_address}&api_token={api_token}
```
**Description**: Stop warming up an IP address
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip_address` | string | Yes | The IP address that you want to retrieve the warmup status for |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/ips/warmup/{ip_address}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Stop warming up an IP address](https://docs.sendgrid.com/api-reference/ip-warmup/stop-warming-up-an-ip-address)
---
### Category: Invalid E-Mails API
#### Retrieve all invalid emails
**Method**: `GET` | **LowCodeAPI Path**: `/v3/suppression/invalid_emails`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/invalid_emails?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/invalid_emails?email={email}&end_time={end_time}&limit={limit}&offset={offset}&start_time={start_time}&api_token={api_token}
```
**Description**: Retrieve all invalid emails
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | This parameter allows you to filter results by email address. |
| `end_time` | number | No | Refers end of the time range in unix timestamp when an invalid email was created (inclusive) |
| `limit` | number | No | Limit the number of results to be displayed per page |
| `offset` | number | No | Paging offset. The point in the list to begin displaying results |
| `start_time` | number | No | Refers start of the time range in unix timestamp when an invalid email was created (inclusive) |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/suppression/invalid_emails?email=VALUE&end_time=VALUE&limit=VALUE&offset=VALUE&start_time=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all invalid emails](https://docs.sendgrid.com/api-reference/invalid-e-mails-api/retrieve-all-invalid-emails)
---
#### Retrieve a specific invalid email
**Method**: `GET` | **LowCodeAPI Path**: `/v3/suppression/invalid_emails/{email}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/invalid_emails/{email}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/invalid_emails/email?email={email}&api_token={api_token}
```
**Description**: Retrieve a specific invalid email
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The specific email address of the invalid email entry that you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/suppression/invalid_emails/{email}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a specific invalid email](https://docs.sendgrid.com/api-reference/invalid-e-mails-api/retrieve-a-specific-invalid-email)
---
#### Delete invalid emails
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/suppression/invalid_emails`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/invalid_emails?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/invalid_emails?api_token={api_token}
```
**Description**: Delete invalid emails
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/suppression/invalid_emails?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete invalid emails](https://docs.sendgrid.com/api-reference/invalid-e-mails-api/delete-invalid-emails)
---
#### Delete a specific invalid email
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/suppression/invalid_emails/{email}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/invalid_emails/{email}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/invalid_emails/email?api_token={api_token}
```
**Description**: Delete a specific invalid email
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/suppression/invalid_emails/{email}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a specific invalid email](https://docs.sendgrid.com/api-reference/invalid-e-mails-api/delete-invalid-emails)
---
### Category: Link Branding
#### Create a branded link
**Method**: `POST` | **LowCodeAPI Path**: `/v3/whitelabel/links`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links?api_token={api_token}
```
**Description**: Create a branded link
**Request Body**:
```json
{
"domain": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `default` | boolean | No | Indicates if you want to use this link branding as the default or fallback. |
| `domain` | string | Yes | The root domain for the subdomain that you are creating the link branding for |
| `subdomain` | string | No | The subdomain to create the link branding for. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a branded link](https://docs.sendgrid.com/api-reference/link-branding/create-a-branded-link)
---
#### Validate a branded link
**Method**: `POST` | **LowCodeAPI Path**: `/v3/whitelabel/links/{id}/validate`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/{id}/validate?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/id/validate?id={id}&api_token={api_token}
```
**Description**: Validate a branded link
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | number | Yes | The ID of the branded link that you want to validate |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/{id}/validate?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Validate a branded link](https://docs.sendgrid.com/api-reference/link-branding/validate-a-branded-link)
---
#### Associate a branded link with a subuser
**Method**: `POST` | **LowCodeAPI Path**: `/v3/whitelabel/links/{link_id}/subuser`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/{link_id}/subuser?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/link_id/subuser?link_id={link_id}&api_token={api_token}
```
**Description**: Associate a branded link with a subuser
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `link_id` | number | Yes | The ID of the branded link you want to associate |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `username` | string | No | The username of the subuser account that you want to associate the branded link with |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/{link_id}/subuser?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Associate a branded link with a subuser](https://docs.sendgrid.com/api-reference/link-branding/associate-a-branded-link-with-a-subuser)
---
#### Retrieve all branded links
**Method**: `GET` | **LowCodeAPI Path**: `/v3/whitelabel/links`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links?limit={limit}&api_token={api_token}
```
**Description**: Retrieve all branded links
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Limits the number of results returned per page |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links?limit=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all branded links](https://docs.sendgrid.com/api-reference/link-branding/retrieve-all-branded-links)
---
#### Retrieve a branded link
**Method**: `GET` | **LowCodeAPI Path**: `/v3/whitelabel/links/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/id?limit={limit}&api_token={api_token}
```
**Description**: Retrieve a branded link
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | Yes | The ID of the branded link you want to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/{id}?limit=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a branded link](https://docs.sendgrid.com/api-reference/link-branding/retrieve-a-branded-link)
---
#### Retrieve the default branded link
**Method**: `GET` | **LowCodeAPI Path**: `/v3/whitelabel/links/default`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/default?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/default?domain={domain}&api_token={api_token}
```
**Description**: Retrieve the default branded link
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | No | The domain to match against when finding the default branded link |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/default?domain=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve the default branded link](https://docs.sendgrid.com/api-reference/link-branding/retrieve-the-default-branded-link)
---
#### Retrieve a subuser's branded link
**Method**: `GET` | **LowCodeAPI Path**: `/v3/whitelabel/links/subuser`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/subuser?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/subuser?username={username}&api_token={api_token}
```
**Description**: Retrieve a subuser's branded link
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `username` | string | Yes | The username of the subuser to retrieve associated branded links for |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/subuser?username=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a subuser's branded link](https://docs.sendgrid.com/api-reference/link-branding/retrieve-a-subusers-branded-link)
---
#### Update a branded link
**Method**: `PUT` | **LowCodeAPI Path**: `/v3/whitelabel/links/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/id?id={id}&api_token={api_token}
```
**Description**: Update a branded link
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | number | Yes | The ID of the branded link you want to retrieve |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `default` | boolean | No | Indicates if the branded link is set as the default. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/{id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update a branded link](https://docs.sendgrid.com/api-reference/link-branding/update-a-branded-link)
---
#### Delete a branded link
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/whitelabel/links/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/id?id={id}&api_token={api_token}
```
**Description**: Delete a branded link
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | number | No | The ID of the branded link you want to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/{id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a branded link](https://docs.sendgrid.com/api-reference/link-branding/delete-a-branded-link)
---
#### Disassociate a branded link from a subuser
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/whitelabel/links/subuser`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/subuser?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/subuser?username={username}&api_token={api_token}
```
**Description**: Disassociate a branded link from a subuser
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `username` | string | No | The username of the subuser account that you want to disassociate a branded link from. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/links/subuser?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Disassociate a branded link from a subuser](https://docs.sendgrid.com/api-reference/link-branding/disassociate-a-branded-link-from-a-subuser)
---
### Category: Lists
#### Create List
**Method**: `POST` | **LowCodeAPI Path**: `/v3/marketing/lists`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/lists?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/lists?api_token={api_token}
```
**Description**: Create List
**Request Body**:
```json
{
"name": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `name` | string | Yes | Your name for your list. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/marketing/lists?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create List](https://docs.sendgrid.com/api-reference/lists/create-list)
---
#### Get List Contact Count
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/lists/{id}/contacts/count`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/lists/{id}/contacts/count?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/lists/id/contacts/count?id={id}&api_token={api_token}
```
**Description**: Get List Contact Count
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/lists/{id}/contacts/count?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get List Contact Count](https://docs.sendgrid.com/api-reference/lists/get-list-contact-count)
---
#### Get a List by ID
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/lists/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/lists/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/lists/id?id={id}&api_token={api_token}
```
**Description**: Get a List by ID
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/lists/{id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get a List by ID](https://docs.sendgrid.com/api-reference/lists/get-a-list-by-id)
---
#### Get All Lists
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/lists`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/lists?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/lists?page_size={page_size}&page_token={page_token}&api_token={api_token}
```
**Description**: Get All Lists
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | number | No | Maximum number of elements to return |
| `page_token` | string | No | token corresponding to a specific page of results as provided by metadata. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/lists?page_size=VALUE&page_token=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get All Lists](https://docs.sendgrid.com/api-reference/lists/get-all-lists)
---
#### Update List
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/marketing/lists/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/lists/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/lists/id?id={id}&api_token={api_token}
```
**Description**: Update List
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/marketing/lists/{id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update List](https://docs.sendgrid.com/api-reference/lists/update-list)
---
#### Delete marketing list
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/marketing/lists/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/lists/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/lists/id?id={id}&delete_contacts={delete_contacts}&api_token={api_token}
```
**Description**: Delete marketing list
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve. |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `delete_contacts` | boolean | No | Flag indicates that all contacts on the list are also to be deleted |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/marketing/lists/{id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete marketing list](https://docs.sendgrid.com/api-reference/lists/delete-a-list)
---
#### Remove Contacts from a List
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/marketing/lists/{id}/contacts`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/lists/{id}/contacts?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/lists/id/contacts?contact_ids={contact_ids}&api_token={api_token}
```
**Description**: Remove Contacts from a List
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_ids` | string | Yes | comma separated list of contact ids |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/marketing/lists/{id}/contacts?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Remove Contacts from a List](https://docs.sendgrid.com/api-reference/lists/remove-contacts-from-a-list)
---
### Category: Mail Send
#### Send a mail
**Method**: `POST` | **LowCodeAPI Path**: `/v3/mail/send`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail/send?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail/send?api_token={api_token}
```
**Description**: Send a mail
**Request Body**:
```json
{
"content": "<array>",
"from": "<object>",
"personalizations": "<array>",
"subject": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `asm` | object | No | An object allowing you to specify how to handle unsubscribes |
| `attachments` | array | No | An array of objects where you can specify any attachments you want to include |
| `batch_id` | string | No | An ID representing a batch of emails to be sent at the same time |
| `categories` | array | No | An array of category names for this message |
| `content` | array | Yes | An array where you can specify the content of your email |
| `custom_args` | string | No | Values that are specific to the entire send that will be carried along with the email and its activity data |
| `from` | object | Yes | The From email address used to deliver the message |
| `headers` | object | No | An object containing key/value pairs of header names and the value to substitute for them |
| `ip_pool_name` | string | No | The IP Pool that you would like to send this email from |
| `mail_settings` | object | No | A collection of different mail settings that you can use to specify how you would like this email to be handled |
| `personalizations` | array | Yes | An array of messages and their metadata |
| `reply_to` | object | No | The email address where any replies or bounces will be returned |
| `reply_to_list` | array | No | An array of recipients who will receive replies and/or bounces |
| `send_at` | number | No | A unix timestamp allowing you to specify when you want your email to be delivered |
| `subject` | string | Yes | The global or message level subject of your email |
| `template_id` | string | No | An email template ID |
| `tracking_settings` | object | No | Settings to determine how you would like to track the metrics of how your recipients interact with your email. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/mail/send?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Send a mail](https://docs.sendgrid.com/api-reference/mail-send/mail-send)
---
### Category: Marketing Campaign Stats
#### Get All Automation Stats
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/stats/automations`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/automations?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/automations?automation_ids={automation_ids}&page_size={page_size}&page_token={page_token}&api_token={api_token}
```
**Description**: Get All Automation Stats
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `automation_ids` | array | No | This endpoint returns all automation IDs if no automation_ids are specified |
| `page_size` | number | No | The number of elements you want returned on each page |
| `page_token` | string | No | The stats endpoints are paginated. To get the next page call the passed _metadata next URL. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/automations?automation_ids=VALUE&page_size=VALUE&page_token=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get All Automation Stats](https://docs.sendgrid.com/api-reference/marketing-campaign-stats/get-all-automation-stats)
---
#### Get Automation Stats by ID
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/stats/automations/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/automations/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/automations/id?aggregated_by={aggregated_by}&end_date={end_date}&group_by={group_by}&page_size={page_size}&page_token={page_token}&start_date={start_date}&step_ids={step_ids}&timezone={timezone}&api_token={api_token}
```
**Description**: Get Automation Stats by ID
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aggregated_by` | string | No | Dictates how the stats are time-sliced |
| `end_date` | string | No | this parameter is included the stats' end date is included in the search |
| `group_by` | array | No | Automations can have multiple steps |
| `page_size` | number | No | The number of elements you want returned on each page |
| `page_token` | string | No | The stats endpoints are paginated |
| `start_date` | string | Yes | If this parameter is included the stats' start date is included in the search |
| `step_ids` | array | No | Comma-separated list of step_ids that you want the link stats for |
| `timezone` | string | No | IANA Area/Region string representing the timezone in which the stats are to be presented |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/automations/{id}?aggregated_by=VALUE&end_date=VALUE&group_by=VALUE&page_size=VALUE&page_token=VALUE&start_date=VALUE&step_ids=VALUE&timezone=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Automation Stats by ID](https://docs.sendgrid.com/api-reference/marketing-campaign-stats/get-automation-stats-by-id)
---
#### Get All Single Sends Stats
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/stats/singlesends`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/singlesends?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/singlesends?page_size={page_size}&page_token={page_token}&singlesend_ids={singlesend_ids}&api_token={api_token}
```
**Description**: Get All Single Sends Stats
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | number | No | The number of elements you want returned on each page |
| `page_token` | string | No | The stats endpoints are paginated. |
| `singlesend_ids` | array | No | This endpoint returns all Single Send IDs if no IDs are included in singlesend_ids |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/singlesends?page_size=VALUE&page_token=VALUE&singlesend_ids=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get All Single Sends Stats](https://docs.sendgrid.com/api-reference/marketing-campaign-stats/get-all-single-sends-stats)
---
#### Get Single Send Stats by ID
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/stats/singlesends/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/singlesends/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/singlesends/id?aggregated_by={aggregated_by}&end_date={end_date}&group_by={group_by}&page_size={page_size}&page_token={page_token}&start_date={start_date}&timezone={timezone}&api_token={api_token}
```
**Description**: Get Single Send Stats by ID
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aggregated_by` | string | No | Dictates how the stats are time-sliced |
| `end_date` | string | No | If this parameter is included the stats' end date is included in the search |
| `group_by` | array | No | A/B Single Sends have multiple variation IDs and phase IDs. |
| `page_size` | number | No | The number of elements you want returned on each page |
| `page_token` | string | No | The stats endpoints are paginated |
| `start_date` | string | Yes | If this parameter is included the stats' start date is included in the search |
| `timezone` | string | No | IANA Area/Region string representing the timezone in which the stats are to be presented |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/singlesends/{id}?aggregated_by=VALUE&end_date=VALUE&group_by=VALUE&page_size=VALUE&page_token=VALUE&start_date=VALUE&timezone=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Single Send Stats by ID](https://docs.sendgrid.com/api-reference/marketing-campaign-stats/get-single-send-stats-by-id)
---
#### Get Automation Click Tracking Stats by ID
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/stats/automations/{id}/links`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/automations/{id}/links?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/automations/id/links?group_by={group_by}&page_size={page_size}&page_token={page_token}&step_ids={step_ids}&api_token={api_token}
```
**Description**: Get Automation Click Tracking Stats by ID
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_by` | array | No | Automations can have multiple steps |
| `page_size` | number | No | The number of elements you want returned on each page |
| `page_token` | string | No | The stats endpoints are paginated. |
| `step_ids` | array | No | Comma-separated list of step_ids that you want the link stats for |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/automations/{id}/links?group_by=VALUE&page_size=VALUE&page_token=VALUE&step_ids=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Automation Click Tracking Stats by ID](https://docs.sendgrid.com/api-reference/marketing-campaign-stats/get-automation-click-tracking-stats-by-id)
---
#### Get Single Send Click Tracking Stats by ID
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/stats/singlesends/{id}/links`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/singlesends/{id}/links?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/singlesends/id/links?id={id}&ab_phase_idstring={ab_phase_idstring}&ab_variation_id={ab_variation_id}&group_by={group_by}&page_size={page_size}&page_token={page_token}&api_token={api_token}
```
**Description**: Get Single Send Click Tracking Stats by ID
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | The ID of the Event Webhook you want to retrieve. |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ab_phase_idstring` | | No | |
| `ab_variation_id` | string | No | |
| `group_by` | array | No | A/B Single Sends have multiple variation IDs and phase IDs |
| `page_size` | number | No | The number of elements you want returned on each page |
| `page_token` | string | No | The stats endpoints are paginated |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/singlesends/{id}/links?ab_phase_idstring=VALUE&ab_variation_id=VALUE&group_by=VALUE&page_size=VALUE&page_token=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Single Send Click Tracking Stats by ID](https://docs.sendgrid.com/api-reference/marketing-campaign-stats/get-single-send-click-tracking-stats-by-id)
---
#### Export Single Send Stats
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/stats/singlesends/export`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/singlesends/export?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/singlesends/export?ids={ids}&timezone={timezone}&api_token={api_token}
```
**Description**: Export Single Send Stats
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | The IDs of Single Sends for which to export stats |
| `timezone` | string | No | This parameter changes the timezone format only it does not alter which stats are returned. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/singlesends/export?ids=VALUE&timezone=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Export Single Send Stats](https://docs.sendgrid.com/api-reference/marketing-campaign-stats/export-single-send-stats)
---
#### Export Automation Stats
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/stats/automations/export`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/automations/export?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/automations/export?ids={ids}&timezone={timezone}&api_token={api_token}
```
**Description**: Export Automation Stats
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | The IDs of Automations for which to export stats |
| `timezone` | string | No | This parameter changes the timezone format only it does not alter which stats are returned. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/stats/automations/export?ids=VALUE&timezone=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Export Automation Stats](https://docs.sendgrid.com/api-reference/marketing-campaign-stats/export-automation-stats)
---
### Category: Reverse DNS
#### Set up reverse DNS
**Method**: `POST` | **LowCodeAPI Path**: `/v3/whitelabel/ips`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/ips?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/ips?api_token={api_token}
```
**Description**: Set up reverse DNS
**Request Body**:
```json
{
"domain": "<string>",
"ip": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `domain` | string | Yes | The root or sending domain that will be used to send message from the IP address |
| `ip` | string | Yes | The IP address for which you want to set up reverse DNS |
| `subdomain` | string | No | The subdomain that will be used to send emails from the IP address |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/ips?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Set up reverse DNS](https://docs.sendgrid.com/api-reference/reverse-dns/set-up-reverse-dns)
---
#### Validate a reverse DNS record
**Method**: `POST` | **LowCodeAPI Path**: `/v3/whitelabel/ips/{id}/validate`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/ips/{id}/validate?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/ips/id/validate?id={id}&api_token={api_token}
```
**Description**: Validate a reverse DNS record
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the reverse DNS record that you would like to validate |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/ips/{id}/validate?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Validate a reverse DNS record](https://docs.sendgrid.com/api-reference/reverse-dns/validate-a-reverse-dns-record)
---
#### Retrieve all reverse DNS records
**Method**: `GET` | **LowCodeAPI Path**: `/v3/whitelabel/ips`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/ips?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/ips?ip={ip}&limit={limit}&offset={offset}&api_token={api_token}
```
**Description**: Retrieve all reverse DNS records
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | No | The IP address segment that you'd like to use in a prefix search |
| `limit` | number | No | The maximum number of results to retrieve |
| `offset` | number | No | The point in the list of results to begin retrieving IP addresses from |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/ips?ip=VALUE&limit=VALUE&offset=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all reverse DNS records](https://docs.sendgrid.com/api-reference/reverse-dns/retrieve-all-reverse-dns-records)
---
#### Retrieve a reverse DNS record
**Method**: `GET` | **LowCodeAPI Path**: `/v3/whitelabel/ips/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/ips/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/ips/id?id={id}&api_token={api_token}
```
**Description**: Retrieve a reverse DNS record
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the reverse DNS record that you would like to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/ips/{id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a reverse DNS record](https://docs.sendgrid.com/api-reference/reverse-dns/retrieve-a-reverse-dns-record)
---
#### Delete a reverse DNS record
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/whitelabel/ips/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/ips/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/whitelabel/ips/id?id={id}&api_token={api_token}
```
**Description**: Delete a reverse DNS record
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the reverse DNS record that you would like to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/whitelabel/ips/{id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a reverse DNS record](https://docs.sendgrid.com/api-reference/reverse-dns/delete-a-reverse-dns-record)
---
### Category: Segmenting Contacts
#### Create Segment
**Method**: `POST` | **LowCodeAPI Path**: `/v3/marketing/segments/2.0`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/2.0?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/2.0?api_token={api_token}
```
**Description**: Create Segment
**Request Body**:
```json
{
"name": "<string>",
"query_dsl": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `name` | string | Yes | Name of the segment |
| `parent_list_ids` | array | No | The array of list ids to filter contacts on when building this segment |
| `query_dsl` | string | Yes | SQL query which will filter contacts based on the conditions provided. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/2.0?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create Segment](https://docs.sendgrid.com/api-reference/segmenting-contacts-v2/create-segment)
---
#### Update Segment
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/marketing/segments/2.0/{segment_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/2.0/{segment_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/2.0/segment_id?segment_id={segment_id}&api_token={api_token}
```
**Description**: Update Segment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | string | No | required |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `name` | string | No | Name of the segment |
| `query_dsl` | string | No | SQL query which will filter contacts based on the conditions provided. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/2.0/{segment_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update Segment](https://docs.sendgrid.com/api-reference/segmenting-contacts-v2/update-segment)
---
#### Get List of Segments
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/segments/2.0`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/2.0?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/2.0?ids={ids}&no_parent_list_id={no_parent_list_id}&parent_list_ids={parent_list_ids}&api_token={api_token}
```
**Description**: Get List of Segments
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | Yes | A list of segment IDs to retrieve |
| `no_parent_list_id` | boolean | No | If set to true segments with an empty value of parent_list_id will be returned in the filter. |
| `parent_list_ids` | string | No | A comma separated list up to 50 in size to filter segments on |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/2.0?ids=VALUE&no_parent_list_id=VALUE&parent_list_ids=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get List of Segments](https://docs.sendgrid.com/api-reference/segmenting-contacts-v2/get-list-of-segments)
---
#### Get Segment by ID
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/segments/2.0/{segment_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/2.0/{segment_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/2.0/segment_id?segment_id={segment_id}&contacts_sample={contacts_sample}&api_token={api_token}
```
**Description**: Get Segment by ID
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | string | Yes | |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contacts_sample` | boolean | No | Defaults to true. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/2.0/{segment_id}?contacts_sample=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Segment by ID](https://docs.sendgrid.com/api-reference/segmenting-contacts-v2/get-segment-by-id)
---
#### Delete segment
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/marketing/segments/2.0/{segment_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/2.0/{segment_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/2.0/segment_id?segment_id={segment_id}&api_token={api_token}
```
**Description**: Delete segment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | string | Yes | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/2.0/{segment_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete segment](https://docs.sendgrid.com/api-reference/segmenting-contacts-v2/delete-segment)
---
#### Refresh Segment
**Method**: `POST` | **LowCodeAPI Path**: `/v3/marketing/segments/2.0/refresh/{segment_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/2.0/refresh/{segment_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/2.0/refresh/segment_id?segment_id={segment_id}&api_token={api_token}
```
**Description**: Refresh Segment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | string | Yes | |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `user_time_zone` | string | No | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/2.0/refresh/{segment_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Refresh Segment](https://docs.sendgrid.com/api-reference/segmenting-contacts-v2/refresh-segment)
---
#### Create Segment
**Method**: `POST` | **LowCodeAPI Path**: `/v3/marketing/segments`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments?api_token={api_token}
```
**Description**: Create Segment
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/marketing/segments?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create Segment](https://docs.sendgrid.com/api-reference/segmenting-contacts/create-segment)
---
#### Get Segment by ID
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/segments/{segment_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/{segment_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/segment_id?segment_id={segment_id}&query_json={query_json}&api_token={api_token}
```
**Description**: Get Segment by ID
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | string | Yes | |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query_json` | boolean | No | Defaults to false. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/{segment_id}?query_json=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Segment by ID](https://docs.sendgrid.com/api-reference/segmenting-contacts/get-segment-by-id)
---
#### Get List of Segments
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/segments`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments?ids={ids}&no_parent_list_id={no_parent_list_id}&parent_list_ids={parent_list_ids}&api_token={api_token}
```
**Description**: Get List of Segments
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | A list of segment IDs to retrieve |
| `no_parent_list_id` | boolean | No | If set to true segments with an empty value of parent_list_id will be returned in the filter. |
| `parent_list_ids` | string | No | A comma separated list of list ids to be used when searching for segments with the specified parent_list_id no more than 50 is allowed |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/segments?ids=VALUE&no_parent_list_id=VALUE&parent_list_ids=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get List of Segments](https://docs.sendgrid.com/api-reference/segmenting-contacts/get-list-of-segments)
---
#### Update Segment
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/marketing/segments/{segment_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/{segment_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/segment_id?segment_id={segment_id}&api_token={api_token}
```
**Description**: Update Segment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | string | Yes | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/{segment_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update Segment](https://docs.sendgrid.com/api-reference/segmenting-contacts/update-segment)
---
#### Delete marketing segment
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/marketing/segments/{segment_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/{segment_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/segment_id?segment_id={segment_id}&api_token={api_token}
```
**Description**: Delete marketing segment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | string | Yes | Segment Id |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/marketing/segments/{segment_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete marketing segment](https://docs.sendgrid.com/api-reference/segmenting-contacts/delete-segment)
---
### Category: Send Test E-Mail
#### Send a Test Marketing Email
**Method**: `POST` | **LowCodeAPI Path**: `/v3/marketing/test/send_email`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/test/send_email?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/test/send_email?api_token={api_token}
```
**Description**: Send a Test Marketing Email
**Request Body**:
```json
{
"template_id": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `custom_unsubscribe_url` | string | No | A custom unsubscribe URL. |
| `sender_id` | number | No | This ID must belong to a verified sender |
| `template_id` | string | Yes | The ID of the template that you would like to use |
| `version_id_override` | string | No | You can override the active template with an alternative template version by passing the version ID in this field |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/marketing/test/send_email?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Send a Test Marketing Email](https://docs.sendgrid.com/api-reference/send-test-e-mail/send-a-test-marketing-email)
---
### Category: Sender Identities API
#### Create a Sender Identity
**Method**: `POST` | **LowCodeAPI Path**: `/v3/senders`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/senders?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/senders?api_token={api_token}
```
**Description**: Create a Sender Identity
**Request Body**:
```json
{
"address": "<string>",
"city": "<string>",
"country": "<string>",
"nickname": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `address` | string | Yes | The physical address of the sender identity |
| `address_2` | string | No | Additional sender identity address information |
| `city` | string | Yes | The city of the sender identity |
| `country` | string | Yes | The country of the sender identity. |
| `from` | object | No | |
| `nickname` | string | Yes | A nickname for the sender identity |
| `reply_to` | object | No | |
| `state` | string | No | The state of the sender identity |
| `zip` | string | No | The zipcode of the sender identity |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/senders?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a Sender Identity](https://docs.sendgrid.com/api-reference/sender-identities-api/create-a-sender-identity)
---
#### Get all Sender Identities
**Method**: `GET` | **LowCodeAPI Path**: `/v3/senders`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/senders?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/senders?api_token={api_token}
```
**Description**: Get all Sender Identities
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/senders?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all Sender Identities](https://docs.sendgrid.com/api-reference/sender-identities-api/get-all-sender-identities)
---
#### Update a Sender Identity
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/senders/{sender_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/senders/{sender_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/senders/sender_id?sender_id={sender_id}&api_token={api_token}
```
**Description**: Update a Sender Identity
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sender_id` | number | Yes | The ID of the sender identity that you want to retrieve. |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `address` | string | No | The physical address of the sender identity |
| `address_2` | string | No | Additional sender identity address information |
| `city` | string | No | The city of the sender identity |
| `country` | string | No | The country of the sender identity. |
| `from` | object | No | |
| `nickname` | string | No | A nickname for the sender identity |
| `reply_to` | object | No | |
| `state` | string | No | The state of the sender identity |
| `zip` | string | No | The zipcode of the sender identity |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/senders/{sender_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update a Sender Identity](https://docs.sendgrid.com/api-reference/sender-identities-api/update-a-sender-identity)
---
#### Delete a Sender Identity
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/senders/{sender_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/senders/{sender_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/senders/sender_id?sender_id={sender_id}&api_token={api_token}
```
**Description**: Delete a Sender Identity
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sender_id` | number | Yes | The ID of the sender identity that you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/senders/{sender_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a Sender Identity](https://docs.sendgrid.com/api-reference/sender-identities-api/delete-a-sender-identity)
---
#### Resend Sender Identity Verification
**Method**: `POST` | **LowCodeAPI Path**: `/v3/senders/{sender_id}/resend_verification`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/senders/{sender_id}/resend_verification?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/senders/sender_id/resend_verification?sender_id={sender_id}&api_token={api_token}
```
**Description**: Resend Sender Identity Verification
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sender_id` | number | Yes | The ID of the sender identity for which you would like to resend a verification email. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/senders/{sender_id}/resend_verification?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Resend Sender Identity Verification](https://docs.sendgrid.com/api-reference/sender-identities-api/resend-sender-identity-verification)
---
#### View a Sender Identity
**Method**: `GET` | **LowCodeAPI Path**: `/v3/senders/{sender_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/senders/{sender_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/senders/sender_id?sender_id={sender_id}&api_token={api_token}
```
**Description**: View a Sender Identity
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sender_id` | number | Yes | The ID of the sender identity that you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/senders/{sender_id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [View a Sender Identity](https://docs.sendgrid.com/api-reference/sender-identities-api/view-a-sender-identity)
---
### Category: Sender Verification
#### Domain Warn List
**Method**: `GET` | **LowCodeAPI Path**: `/v3/verified_senders/domains`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/verified_senders/domains?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/verified_senders/domains?api_token={api_token}
```
**Description**: Domain Warn List
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/verified_senders/domains?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Domain Warn List](https://docs.sendgrid.com/api-reference/sender-verification/domain-warn-list)
---
#### Completed Steps
**Method**: `GET` | **LowCodeAPI Path**: `/v3/verified_senders/steps_completed`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/verified_senders/steps_completed?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/verified_senders/steps_completed?api_token={api_token}
```
**Description**: Completed Steps
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/verified_senders/steps_completed?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Completed Steps](https://docs.sendgrid.com/api-reference/sender-verification/completed-steps)
---
#### Create Verified Sender Request
**Method**: `POST` | **LowCodeAPI Path**: `/v3/verified_senders`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/verified_senders?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/verified_senders?api_token={api_token}
```
**Description**: Create Verified Sender Request
**Request Body**:
```json
{
"from_email": "<string>",
"nickname": "<string>",
"reply_to": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `address` | string | No | |
| `address2` | string | No | |
| `city` | string | No | |
| `country` | string | No | |
| `from_email` | string | Yes | |
| `from_name` | string | No | |
| `nickname` | string | Yes | |
| `reply_to` | string | Yes | |
| `reply_to_name` | string | No | |
| `state` | string | No | |
| `zip` | string | No | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/verified_senders?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create Verified Sender Request](https://docs.sendgrid.com/api-reference/sender-verification/create-verified-sender-request)
---
#### Verify Sender Request
**Method**: `GET` | **LowCodeAPI Path**: `/v3/verified_senders/verify/{token}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/verified_senders/verify/{token}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/verified_senders/verify/token?token={token}&api_token={api_token}
```
**Description**: Verify Sender Request
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token` | string | Yes | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/verified_senders/verify/{token}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Verify Sender Request](https://docs.sendgrid.com/api-reference/sender-verification/verify-sender-request)
---
#### Edit Verified Sender
**Method**: `GET` | **LowCodeAPI Path**: `/v3/verified_senders/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/verified_senders/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/verified_senders/id?id={id}&api_token={api_token}
```
**Description**: Edit Verified Sender
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/verified_senders/{id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Edit Verified Sender](https://docs.sendgrid.com/api-reference/sender-verification/edit-verified-sender)
---
#### Delete Verified Sender
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/verified_senders/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/verified_senders/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/verified_senders/id?id={id}&api_token={api_token}
```
**Description**: Delete Verified Sender
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/verified_senders/{id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete Verified Sender](https://docs.sendgrid.com/api-reference/sender-verification/delete-verified-sender)
---
#### Get All Verified Senders
**Method**: `GET` | **LowCodeAPI Path**: `/v3/verified_senders`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/verified_senders?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/verified_senders?id={id}&lastSeenID={lastSeenID}&limit={limit}&api_token={api_token}
```
**Description**: Get All Verified Senders
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | number | No | |
| `lastSeenID` | number | No | |
| `limit` | number | No | Specifies the number of results to be returned by the API |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/verified_senders?id=VALUE&lastSeenID=VALUE&limit=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get All Verified Senders](https://docs.sendgrid.com/api-reference/sender-verification/get-all-verified-senders)
---
#### Resend Verified Sender Request
**Method**: `POST` | **LowCodeAPI Path**: `/v3/verified_senders/resend/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/verified_senders/resend/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/verified_senders/resend/id?id={id}&api_token={api_token}
```
**Description**: Resend Verified Sender Request
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/verified_senders/resend/{id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Resend Verified Sender Request](https://docs.sendgrid.com/api-reference/sender-verification/resend-verified-sender-request)
---
### Category: Senders
#### Create a Sender Identity for marketing
**Method**: `POST` | **LowCodeAPI Path**: `/v3/marketing/senders`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/senders?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/senders?api_token={api_token}
```
**Description**: Create a Sender Identity for marketing
**Request Body**:
```json
{
"from": "<object>",
"nickname": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `from` | object | Yes | |
| `nickname` | string | Yes | A nickname for the sender identity |
| `reply_to` | object | No | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/marketing/senders?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a Sender Identity for marketing](https://docs.sendgrid.com/api-reference/senders/create-a-sender-identity)
---
### Category: Settings - Enforced TLS
#### Retrieve current Enforced TLS settings
**Method**: `GET` | **LowCodeAPI Path**: `/v3/user/settings/enforced_tls`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/settings/enforced_tls?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/settings/enforced_tls?api_token={api_token}
```
**Description**: Retrieve current Enforced TLS settings
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/user/settings/enforced_tls?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve current Enforced TLS settings](https://docs.sendgrid.com/api-reference/settings-enforced-tls/retrieve-current-enforced-tls-settings)
---
#### Update Enforced TLS settings
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/user/settings/enforced_tls`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/settings/enforced_tls?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/settings/enforced_tls?api_token={api_token}
```
**Description**: Update Enforced TLS settings
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `require_tls` | boolean | No | Indicates if you want to require your recipients to support TLS |
| `require_valid_cert` | boolean | No | Indicates if you want to require your recipients to have a valid certificate |
| `version` | number | No | The minimum required TLS certificate version. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/user/settings/enforced_tls?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update Enforced TLS settings](https://docs.sendgrid.com/api-reference/settings-enforced-tls/update-enforced-tls-settings)
---
### Category: Settings - Inbound Parse
#### Create a parse setting
**Method**: `POST` | **LowCodeAPI Path**: `/v3/user/webhooks/parse/settings`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/parse/settings?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/parse/settings?api_token={api_token}
```
**Description**: Create a parse setting
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `hostname` | string | No | A specific and unique domain or subdomain that you have created to use exclusively to parse your incoming email |
| `send_raw` | boolean | No | Indicates if you would like SendGrid to post the original MIME-type content of your parsed email. |
| `spam_check` | boolean | No | Indicates if you would like SendGrid to check the content parsed from your emails for spam before POSTing them to your domain |
| `url` | string | No | The public URL where you would like SendGrid to POST the data parsed from your email |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/parse/settings?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a parse setting](https://docs.sendgrid.com/api-reference/settings-inbound-parse/create-a-parse-setting)
---
#### Retrieve a specific parse setting
**Method**: `GET` | **LowCodeAPI Path**: `/v3/user/webhooks/parse/settings/{hostname}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/parse/settings/{hostname}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/parse/settings/hostname?api_token={api_token}
```
**Description**: Retrieve a specific parse setting
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/parse/settings/{hostname}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a specific parse setting](https://docs.sendgrid.com/api-reference/settings-inbound-parse/retrieve-all-parse-settings)
---
#### Update a parse setting
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/user/webhooks/parse/settings/{hostname}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/parse/settings/{hostname}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/parse/settings/hostname?hostname={hostname}&api_token={api_token}
```
**Description**: Update a parse setting
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hostname` | string | Yes | The hostname associated with the inbound parse setting that you would like to retrieve. |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `hostname` | string | No | A specific and unique domain or subdomain that you have created to use exclusively to parse your incoming email |
| `send_raw` | boolean | No | Indicates if you would like SendGrid to post the original MIME-type content of your parsed email. |
| `spam_check` | boolean | No | Indicates if you would like SendGrid to check the content parsed from your emails for spam before POSTing them to your domain |
| `url` | string | No | The public URL where you would like SendGrid to POST the data parsed from your email |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/parse/settings/{hostname}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update a parse setting](https://docs.sendgrid.com/api-reference/settings-inbound-parse/update-a-parse-setting)
---
#### Delete a parse setting
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/user/webhooks/parse/settings/{hostname}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/parse/settings/{hostname}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/parse/settings/hostname?hostname={hostname}&api_token={api_token}
```
**Description**: Delete a parse setting
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hostname` | string | Yes | The hostname associated with the inbound parse setting that you would like to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/parse/settings/{hostname}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a parse setting](https://docs.sendgrid.com/api-reference/settings-inbound-parse/delete-a-parse-setting)
---
### Category: Settings - Mail
#### Retrieve all mail settings
**Method**: `GET` | **LowCodeAPI Path**: `/ /v3/mail_settings`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/ /v3/mail_settings?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid /v3/mail_settings?limit={limit}&offset={offset}&api_token={api_token}
```
**Description**: Retrieve all mail settings
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | The number of settings to return |
| `offset` | number | No | Where in the list of results to begin displaying settings |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/ /v3/mail_settings?limit=VALUE&offset=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all mail settings](https://docs.sendgrid.com/api-reference/settings-mail/retrieve-all-mail-settings)
---
#### Update address whitelist mail settings
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/mail_settings/address_whitelist`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/address_whitelist?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/address_whitelist?api_token={api_token}
```
**Description**: Update address whitelist mail settings
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `enabled` | boolean | No | Indicates if your email address whitelist is enabled |
| `list` | array | No | Either a single email address that you want whitelisted or a domain, for which all email addresses belonging to this domain will be whitelisted |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/mail_settings/address_whitelist?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update address whitelist mail settings](https://docs.sendgrid.com/api-reference/settings-mail/update-address-whitelist-mail-settings)
---
#### Retrieve address whitelist mail settings
**Method**: `GET` | **LowCodeAPI Path**: `/v3/mail_settings/address_whitelist`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/address_whitelist?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/address_whitelist?api_token={api_token}
```
**Description**: Retrieve address whitelist mail settings
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/mail_settings/address_whitelist?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve address whitelist mail settings](https://docs.sendgrid.com/api-reference/settings-mail/retrieve-address-whitelist-mail-settings)
---
#### Update footer mail settings
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/mail_settings/footer`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/footer?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/footer?api_token={api_token}
```
**Description**: Update footer mail settings
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `enabled` | boolean | No | Indicates if the Footer mail setting is currently enabled |
| `html_content` | string | No | The custom HTML content of your email footer |
| `plain_content` | string | No | The plain text content of your email footer |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/mail_settings/footer?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update footer mail settings](https://docs.sendgrid.com/api-reference/settings-mail/update-footer-mail-settings)
---
#### Retrieve footer mail settings
**Method**: `GET` | **LowCodeAPI Path**: `/v3/mail_settings/footer`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/footer?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/footer?api_token={api_token}
```
**Description**: Retrieve footer mail settings
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/mail_settings/footer?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve footer mail settings](https://docs.sendgrid.com/api-reference/settings-mail/retrieve-footer-mail-settings)
---
#### Update forward spam mail settings
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/mail_settings/forward_spam`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/forward_spam?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/forward_spam?api_token={api_token}
```
**Description**: Update forward spam mail settings
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `email` | string | No | The email address where you would like the spam reports to be forwarded |
| `enabled` | boolean | No | Indicates if the Forward Spam setting is enabled |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/mail_settings/forward_spam?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update forward spam mail settings](https://docs.sendgrid.com/api-reference/settings-mail/update-forward-spam-mail-settings)
---
#### Retrieve forward spam mail settings
**Method**: `GET` | **LowCodeAPI Path**: `/v3/mail_settings/forward_spam`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/forward_spam?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/forward_spam?api_token={api_token}
```
**Description**: Retrieve forward spam mail settings
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/mail_settings/forward_spam?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve forward spam mail settings](https://docs.sendgrid.com/api-reference/settings-mail/retrieve-forward-spam-mail-settings)
---
#### Update template mail settings
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/mail_settings/template`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/template?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/template?api_token={api_token}
```
**Description**: Update template mail settings
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `enabled` | boolean | No | Indicates if you want to enable the legacy email template mail setting |
| `html_content` | string | No | The new HTML content for your legacy email template. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/mail_settings/template?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update template mail settings](https://docs.sendgrid.com/api-reference/settings-mail/update-template-mail-settings)
---
#### Retrieve legacy template mail settings
**Method**: `GET` | **LowCodeAPI Path**: `/v3/mail_settings/template`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/template?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/template?api_token={api_token}
```
**Description**: Retrieve legacy template mail settings
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/mail_settings/template?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve legacy template mail settings](https://docs.sendgrid.com/api-reference/settings-mail/retrieve-legacy-template-mail-settings)
---
#### Update bounce purge mail settings
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/mail_settings/bounce_purge`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/bounce_purge?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/bounce_purge?api_token={api_token}
```
**Description**: Update bounce purge mail settings
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `enabled` | boolean | No | Indicates if the bounce purge mail setting is enabled |
| `hard_bounces` | number | No | The number of days after which SendGrid will purge all contacts from your hard bounces suppression lists. |
| `soft_bounces` | number | No | The number of days after which SendGrid will purge all contacts from your soft bounces suppression lists |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/mail_settings/bounce_purge?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update bounce purge mail settings](https://docs.sendgrid.com/api-reference/settings-mail/update-bounce-purge-mail-settings)
---
#### Retrieve bounce purge mail settings
**Method**: `GET` | **LowCodeAPI Path**: `/v3/mail_settings/bounce_purge`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/bounce_purge?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/bounce_purge?api_token={api_token}
```
**Description**: Retrieve bounce purge mail settings
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/mail_settings/bounce_purge?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve bounce purge mail settings](https://docs.sendgrid.com/api-reference/settings-mail/retrieve-bounce-purge-mail-settings)
---
#### Update forward bounce mail settings
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/mail_settings/forward_bounce`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/forward_bounce?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/forward_bounce?api_token={api_token}
```
**Description**: Update forward bounce mail settings
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `email` | string | No | The email address that you would like your bounce reports forwarded to |
| `enabled` | boolean | No | Indicates if the bounce forwarding mail setting is enable. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/mail_settings/forward_bounce?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update forward bounce mail settings](https://docs.sendgrid.com/api-reference/settings-mail/update-forward-bounce-mail-settings)
---
#### Retrieve forward bounce mail settings
**Method**: `GET` | **LowCodeAPI Path**: `/v3/mail_settings/forward_bounce`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/forward_bounce?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mail_settings/forward_bounce?api_token={api_token}
```
**Description**: Retrieve forward bounce mail settings
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/mail_settings/forward_bounce?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve forward bounce mail settings](https://docs.sendgrid.com/api-reference/settings-mail/retrieve-forward-bounce-mail-settings)
---
### Category: Settings - Partner
#### Returns a list of all partner settings
**Method**: `GET` | **LowCodeAPI Path**: `/v3/partner_settings`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/partner_settings?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/partner_settings?limit={limit}&offset={offset}&api_token={api_token}
```
**Description**: Returns a list of all partner settings
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | The number of settings to return per page |
| `offset` | number | No | The paging offset. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/partner_settings?limit=VALUE&offset=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Returns a list of all partner settings](https://docs.sendgrid.com/api-reference/settings-partner/returns-a-list-of-all-partner-settings)
---
### Category: Settings - Tracking
#### Retrieve Tracking Settings
**Method**: `GET` | **LowCodeAPI Path**: `/v3/tracking_settings`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/tracking_settings?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/tracking_settings?api_token={api_token}
```
**Description**: Retrieve Tracking Settings
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/tracking_settings?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve Tracking Settings](https://docs.sendgrid.com/api-reference/settings-tracking/retrieve-tracking-settings)
---
#### Retrieve Click Track Settings
**Method**: `GET` | **LowCodeAPI Path**: `/v3/tracking_settings/click`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/click?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/click?api_token={api_token}
```
**Description**: Retrieve Click Track Settings
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/click?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve Click Track Settings](https://docs.sendgrid.com/api-reference/settings-tracking/retrieve-click-track-settings)
---
#### Update Click Tracking Settings
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/tracking_settings/click`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/click?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/click?api_token={api_token}
```
**Description**: Update Click Tracking Settings
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `enabled` | boolean | No | The setting you want to use for click tracking. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/click?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update Click Tracking Settings](https://docs.sendgrid.com/api-reference/settings-tracking/update-click-tracking-settings)
---
#### Retrieve Google Analytics Settings
**Method**: `GET` | **LowCodeAPI Path**: `/v3/tracking_settings/google_analytic`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/google_analytic?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/google_analytic?api_token={api_token}
```
**Description**: Retrieve Google Analytics Settings
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/google_analytic?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve Google Analytics Settings](https://docs.sendgrid.com/api-reference/settings-tracking/retrieve-google-analytics-settings)
---
#### Update Google Analytics Settings
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/tracking_settings/google_analytics`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/google_analytics?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/google_analytics?api_token={api_token}
```
**Description**: Update Google Analytics Settings
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `enabled` | boolean | No | Indicates if Google Analytics is enabled |
| `utm_campaign` | string | No | The name of the campaign |
| `utm_content` | string | No | Used to differentiate ads |
| `utm_medium` | string | No | Name of the marketing medium |
| `utm_source` | string | No | Name of the referrer source |
| `utm_term` | string | No | Any paid keywords. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/google_analytics?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update Google Analytics Settings](https://docs.sendgrid.com/api-reference/settings-tracking/update-google-analytics-settings)
---
#### Get Open Tracking Settings
**Method**: `GET` | **LowCodeAPI Path**: `/v3/tracking_settings/open`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/open?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/open?api_token={api_token}
```
**Description**: Get Open Tracking Settings
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/open?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Open Tracking Settings](https://docs.sendgrid.com/api-reference/settings-tracking/get-open-tracking-settings)
---
#### Update Open Tracking Settings
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/tracking_settings/open`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/open?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/open?api_token={api_token}
```
**Description**: Update Open Tracking Settings
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `enabled` | boolean | No | The new status that you want to set for open tracking |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/open?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update Open Tracking Settings](https://docs.sendgrid.com/api-reference/settings-tracking/update-open-tracking-settings)
---
#### Retrieve Subscription Tracking Settings
**Method**: `GET` | **LowCodeAPI Path**: `/v3/tracking_settings/subscription`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/subscription?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/subscription?api_token={api_token}
```
**Description**: Retrieve Subscription Tracking Settings
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/subscription?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve Subscription Tracking Settings](https://docs.sendgrid.com/api-reference/settings-tracking/retrieve-subscription-tracking-settings)
---
#### Update Subscription Tracking Settings
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/tracking_settings/subscription`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/subscription?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/subscription?api_token={api_token}
```
**Description**: Update Subscription Tracking Settings
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `enabled` | boolean | No | Indicates if subscription tracking is enabled |
| `html_content` | string | No | The information and HTML for your unsubscribe link |
| `landing` | string | No | The HTML that will be displayed on the page that your customers will see after clicking unsubscribe hosted on SendGrid’s server |
| `plain_content` | string | No | The information in plain text for your unsubscribe link |
| `replace` | string | No | Your custom defined replacement tag for your templates |
| `url` | string | No | The URL where you would like your users sent to unsubscribe. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/tracking_settings/subscription?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update Subscription Tracking Settings](https://docs.sendgrid.com/api-reference/settings-tracking/update-subscription-tracking-settings)
---
### Category: Single Sends
#### Create Single Send
**Method**: `POST` | **LowCodeAPI Path**: `/v3/marketing/singlesends`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends?api_token={api_token}
```
**Description**: Create Single Send
**Request Body**:
```json
{
"name": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `categories` | array | No | The categories to associate with this Single Send |
| `email_config` | object | No | |
| `name` | string | Yes | The name of the Single Send |
| `send_at` | string | No | Set this property to an ISO 8601 formatted date-time when you would like to send the Single Send |
| `send_to` | object | No | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create Single Send](https://docs.sendgrid.com/api-reference/single-sends/create-single-send)
---
#### Duplicate Single Send
**Method**: `POST` | **LowCodeAPI Path**: `/v3/marketing/singlesends/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/id?id={id}&api_token={api_token}
```
**Description**: Duplicate Single Send
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve. |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `name` | string | No | The name of the duplicate Single Send |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/{id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Duplicate Single Send](https://docs.sendgrid.com/api-reference/single-sends/duplicate-single-send)
---
#### Get Single Sends Search
**Method**: `POST` | **LowCodeAPI Path**: `/v3/marketing/singlesends/search`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/search?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/search?api_token={api_token}
```
**Description**: Get Single Sends Search
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `categories` | array | No | categories to associate with this Single Send |
| `name` | string | No | leading and trailing wildcard search on name of the Single Send |
| `status` | array | No | current status of the Single Send |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/search?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Single Sends Search](https://docs.sendgrid.com/api-reference/single-sends/get-single-sends-search)
---
#### Update Single Send
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/marketing/singlesends/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/id?id={id}&api_token={api_token}
```
**Description**: Update Single Send
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve |
**Request Body**:
```json
{
"name": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `categories` | array | No | The categories to associate with this Single Send |
| `email_config` | object | No | |
| `name` | string | Yes | The name of the Single Send |
| `send_at` | string | No | Set this property to an ISO 8601 formatted date-time when you would like to send the Single Send |
| `send_to` | object | No | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/{id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update Single Send](https://docs.sendgrid.com/api-reference/single-sends/update-single-send)
---
#### Schedule Single Send
**Method**: `PUT` | **LowCodeAPI Path**: `/v3/marketing/singlesends/{id}/schedule`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/{id}/schedule?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/id/schedule?id={id}&api_token={api_token}
```
**Description**: Schedule Single Send
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve. |
**Request Body**:
```json
{
"send_at": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `send_at` | string | Yes | The ISO 8601 time at which to send the Single Send. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/{id}/schedule?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Schedule Single Send](https://docs.sendgrid.com/api-reference/single-sends/schedule-single-send)
---
#### Get All Single Sends
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/singlesends`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends?page_size={page_size}&page_token={page_token}&api_token={api_token}
```
**Description**: Get All Single Sends
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | number | No | number of results to return |
| `page_token` | string | No | token corresponding to a specific page of results as provided by metadata. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends?page_size=VALUE&page_token=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get All Single Sends](https://docs.sendgrid.com/api-reference/single-sends/get-all-single-sends)
---
#### Get Single Send by ID
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/singlesends/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/id?id={id}&api_token={api_token}
```
**Description**: Get Single Send by ID
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/{id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Single Send by ID](https://docs.sendgrid.com/api-reference/single-sends/get-single-send-by-id)
---
#### Get All Categories
**Method**: `GET` | **LowCodeAPI Path**: `/v3/marketing/singlesends/categories`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/categories?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/categories?api_token={api_token}
```
**Description**: Get All Categories
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/categories?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get All Categories](https://docs.sendgrid.com/api-reference/single-sends/get-all-categories)
---
#### Delete Single Send by ID
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/marketing/singlesends/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/id?id={id}&api_token={api_token}
```
**Description**: Delete Single Send by ID
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/{id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete Single Send by ID](https://docs.sendgrid.com/api-reference/single-sends/delete-single-send-by-id)
---
#### Bulk Delete Single Sends
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/marketing/singlesends`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends?ids={ids}&api_token={api_token}
```
**Description**: Bulk Delete Single Sends
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Single Send IDs to delete |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Bulk Delete Single Sends](https://docs.sendgrid.com/api-reference/single-sends/bulk-delete-single-sends)
---
#### Delete Single Send Schedule
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/marketing/singlesends/{id}/schedule`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/{id}/schedule?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/id/schedule?id={id}&api_token={api_token}
```
**Description**: Delete Single Send Schedule
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | The ID of the Event Webhook you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/marketing/singlesends/{id}/schedule?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete Single Send Schedule](https://docs.sendgrid.com/api-reference/single-sends/delete-single-send-schedule)
---
### Category: Single Sign-On Settings
#### Create an SSO Integration
**Method**: `POST` | **LowCodeAPI Path**: `/v3/sso/integrations`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/integrations?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/integrations?api_token={api_token}
```
**Description**: Create an SSO Integration
**Request Body**:
```json
{
"enabled": "<boolean>",
"entity_id": "<string>",
"name": "<string>",
"signin_url": "<string>",
"signout_url": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `completed_integration` | boolean | No | Indicates if the integration is complete |
| `enabled` | boolean | Yes | Indicates if the integration is enabled |
| `entity_id` | string | Yes | An identifier provided by your IdP to identify Twilio SendGrid in the SAML interaction |
| `name` | string | Yes | The name of your integration |
| `signin_url` | string | Yes | The IdP's SAML POST endpoint |
| `signout_url` | string | Yes | This URL is relevant only for an IdP-initiated authentication flow. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/sso/integrations?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create an SSO Integration](https://docs.sendgrid.com/api-reference/single-sign-on-settings/create-an-sso-integration)
---
#### Get All SSO Integrations
**Method**: `GET` | **LowCodeAPI Path**: `/v3/sso/integrations`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/integrations?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/integrations?si={si}&api_token={api_token}
```
**Description**: Get All SSO Integrations
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `si` | boolean | No | If this parameter is set to true the response will include the completed_integration field. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/sso/integrations?si=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get All SSO Integrations](https://docs.sendgrid.com/api-reference/single-sign-on-settings/get-all-sso-integrations)
---
#### Get an SSO Integration
**Method**: `GET` | **LowCodeAPI Path**: `/v3/sso/integrations/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/integrations/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/integrations/id?id={id}&si={si}&api_token={api_token}
```
**Description**: Get an SSO Integration
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `si` | boolean | No | If this parameter is set to true the response will include the completed_integration field |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/sso/integrations/{id}?si=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get an SSO Integration](https://docs.sendgrid.com/api-reference/single-sign-on-settings/get-an-sso-integration)
---
#### Update an SSO Integration
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/sso/integrations/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/integrations/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/integrations/id?id={id}&si={si}&api_token={api_token}
```
**Description**: Update an SSO Integration
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `si` | boolean | No | If this parameter is set to true the response will include the completed_integration field |
**Request Body**:
```json
{
"enabled": "<boolean>",
"entity_id": "<string>",
"last_updated": "<number>",
"name": "<string>",
"signin_url": "<string>",
"signout_url": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `audience_url` | string | No | The URL where your IdP should POST its SAML response. |
| `completed_integration` | boolean | No | Indicates if the integration is complete |
| `enabled` | boolean | Yes | Indicates if the integration is enabled |
| `entity_id` | string | Yes | An identifier provided by your IdP to identify Twilio SendGrid in the SAML interaction |
| `last_updated` | number | Yes | A timestamp representing the last time the configuration was modified |
| `name` | string | Yes | The name of your integration |
| `signin_url` | string | Yes | The IdP's SAML POST endpoint |
| `signout_url` | string | Yes | This URL is relevant only for an IdP-initiated authentication flow |
| `single_signon_url` | string | No | The URL where your IdP should POST its SAML response |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/sso/integrations/{id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update an SSO Integration](https://docs.sendgrid.com/api-reference/single-sign-on-settings/update-an-sso-integration)
---
#### Delete an SSO Integration
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/sso/integrations/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/integrations/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/integrations/id?id={id}&api_token={api_token}
```
**Description**: Delete an SSO Integration
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/sso/integrations/{id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete an SSO Integration](https://docs.sendgrid.com/api-reference/single-sign-on-settings/delete-an-sso-integration)
---
### Category: Single Sign-On Teammates
#### Create SSO Teammate
**Method**: `POST` | **LowCodeAPI Path**: `/v3/sso/teammates`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/teammates?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/teammates?api_token={api_token}
```
**Description**: Create SSO Teammate
**Request Body**:
```json
{
"firemail": "<string>",
"first_name": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `firemail` | string | Yes | Set this property to the Teammate's email address |
| `first_name` | string | Yes | Set this property to the Teammate's first name |
| `has_restricted_subuser_access` | boolean | No | Set this property to true to give the Teammate permissions to operate only on behalf of a Subuser |
| `is_admin` | boolean | No | Set this property to true if the Teammate has admin permissions |
| `persona` | string | No | A persona represents a group of permissions often required by a type of Teammate such as a developer or marketer |
| `scopes` | array | No | Add or remove permissions from a Teammate using this scopes property |
| `subuser_access` | array | No | Specify which Subusers the Teammate may access and act on behalf of with this |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/sso/teammates?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create SSO Teammate](https://docs.sendgrid.com/api-reference/single-sign-on-teammates/create-sso-teammate)
---
#### Edit an SSO Teammate
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/sso/teammates/{username}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/teammates/{username}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/sso/teammates/username?username={username}&api_token={api_token}
```
**Description**: Edit an SSO Teammate
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `username` | string | Yes | Set this parameter to the Teammate's email address |
**Request Body**:
```json
{
"first_name": "<string>",
"last_name": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `first_name` | string | Yes | Set this property to the Teammate's first name |
| `has_restricted_subuser_access` | boolean | No | Set this property to true to give the Teammate permissions to operate only on behalf of a Subuser |
| `is_admin` | boolean | No | Set this property to true if the Teammate has admin permissions |
| `last_name` | string | Yes | Set this property to the Teammate's last name |
| `persona` | string | No | A persona represents a group of permissions often required by a type of Teammate such as a developer or marketer. |
| `scopes` | array | No | Add or remove permissions from a Teammate using this scopes property. |
| `subuser_accessarray` | | No | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/sso/teammates/{username}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Edit an SSO Teammate](https://docs.sendgrid.com/api-reference/single-sign-on-teammates/edit-an-sso-teammate)
---
### Category: Spam Reports API
#### Retrieve all spam reports
**Method**: `GET` | **LowCodeAPI Path**: `/v3/suppression/spam_reports`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/spam_reports?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/spam_reports?end_time={end_time}&limit={limit}&offset={offset}&start_time={start_time}&api_token={api_token}
```
**Description**: Retrieve all spam reports
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_time` | number | No | The end of the time range when a spam report was created (inclusive) |
| `limit` | number | No | Limit the number of results to be displayed per page |
| `offset` | number | No | Paging offset .The point in the list to begin displaying results. |
| `start_time` | number | No | The start of the time range when a spam report was created (inclusive) |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/suppression/spam_reports?end_time=VALUE&limit=VALUE&offset=VALUE&start_time=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all spam reports](https://docs.sendgrid.com/api-reference/spam-reports-api/retrieve-all-spam-reports)
---
#### Retrieve a specific spam report
**Method**: `GET` | **LowCodeAPI Path**: `/v3/suppression/spam_reports/{email}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/spam_reports/{email}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/spam_reports/email?email={email}&api_token={api_token}
```
**Description**: Retrieve a specific spam report
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address of a specific spam report that you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/suppression/spam_reports/{email}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a specific spam report](https://docs.sendgrid.com/api-reference/spam-reports-api/retrieve-a-specific-spam-report)
---
#### Delete spam reports
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/suppression/spam_reports`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/spam_reports?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/spam_reports?api_token={api_token}
```
**Description**: Delete spam reports
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/suppression/spam_reports?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete spam reports](https://docs.sendgrid.com/api-reference/spam-reports-api/delete-spam-reports)
---
#### Delete a specific spam report
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/suppression/spam_reports/{email}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/spam_reports/{email}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/spam_reports/email?email={email}&api_token={api_token}
```
**Description**: Delete a specific spam report
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address of a specific spam report that you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/suppression/spam_reports/{email}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a specific spam report](https://docs.sendgrid.com/api-reference/spam-reports-api/delete-a-specific-spam-report)
---
### Category: Stats
#### Retrieve global email statistics
**Method**: `GET` | **LowCodeAPI Path**: `/v3/stats`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/stats?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/stats?end_date={end_date}&limit={limit}&offset={offset}&start_date={start_date}&api_token={api_token}
```
**Description**: Retrieve global email statistics
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | No | The end date of the statistics to retrieve. |
| `limit` | number | No | The number of results to return |
| `offset` | number | No | The point in the list to begin retrieving results.
aggregated_by |
| `start_date` | string | Yes | The starting date of the statistics to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/stats?end_date=VALUE&limit=VALUE&offset=VALUE&start_date=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve global email statistics](https://docs.sendgrid.com/api-reference/stats/retrieve-global-email-statistics)
---
#### Retrieve email statistics by country and state/province
**Method**: `GET` | **LowCodeAPI Path**: `/v3/geo/stats`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/geo/stats?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/geo/stats?aggregated_by={aggregated_by}&country={country}&end_date={end_date}&limit={limit}&offset={offset}&start_date={start_date}&api_token={api_token}
```
**Description**: Retrieve email statistics by country and state/province
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aggregated_by` | string | No | How to group the statistics |
| `country` | string | No | The country you would like to see statistics for |
| `end_date` | string | No | The end date of the statistics to retrieve. |
| `limit` | number | No | The number of results to return |
| `offset` | number | No | The point in the list to begin retrieving results |
| `start_date` | string | Yes | The starting date of the statistics to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/geo/stats?aggregated_by=VALUE&country=VALUE&end_date=VALUE&limit=VALUE&offset=VALUE&start_date=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve email statistics by country and state/province](https://docs.sendgrid.com/api-reference/stats/retrieve-email-statistics-by-country-and-stateprovince)
---
#### Retrieve email statistics by device type
**Method**: `GET` | **LowCodeAPI Path**: `/v3/devices/stats`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/devices/stats?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/devices/stats?aggregated_by={aggregated_by}&end_date={end_date}&limit={limit}&offset={offset}&start_date={start_date}&api_token={api_token}
```
**Description**: Retrieve email statistics by device type
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aggregated_by` | string | No | How to group the statistics |
| `end_date` | string | No | The end date of the statistics to retrieve. |
| `limit` | number | No | The number of results to return |
| `offset` | number | No | The point in the list to begin retrieving results |
| `start_date` | string | Yes | The starting date of the statistics to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/devices/stats?aggregated_by=VALUE&end_date=VALUE&limit=VALUE&offset=VALUE&start_date=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve email statistics by device type](https://docs.sendgrid.com/api-reference/stats/retrieve-email-statistics-by-device-type)
---
#### Retrieve email statistics by client type
**Method**: `GET` | **LowCodeAPI Path**: `/v3/clients/stats`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/clients/stats?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/clients/stats?aggregated_by={aggregated_by}&end_date={end_date}&start_date={start_date}&api_token={api_token}
```
**Description**: Retrieve email statistics by client type
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aggregated_by` | string | No | How to group the statistics |
| `end_date` | string | No | The end date of the statistics to retrieve. Defaults to today |
| `start_date` | string | Yes | The starting date of the statistics to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/clients/stats?aggregated_by=VALUE&end_date=VALUE&start_date=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve email statistics by client type](https://docs.sendgrid.com/api-reference/stats/retrieve-email-statistics-by-client-type)
---
#### Retrieve stats by a specific client type
**Method**: `GET` | **LowCodeAPI Path**: `/v3/clients/{client_type}/stats`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/clients/{client_type}/stats?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/clients/client_type/stats?aggregated_by={aggregated_by}&end_date={end_date}&start_date={start_date}&api_token={api_token}
```
**Description**: Retrieve stats by a specific client type
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aggregated_by` | string | No | How to group the statistics. |
| `end_date` | string | No | The end date of the statistics to retrieve |
| `start_date` | string | Yes | The starting date of the statistics to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/clients/{client_type}/stats?aggregated_by=VALUE&end_date=VALUE&start_date=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve stats by a specific client type](https://docs.sendgrid.com/api-reference/stats/retrieve-stats-by-a-specific-client-type)
---
#### Retrieve email statistics by mailbox provider
**Method**: `GET` | **LowCodeAPI Path**: `/v3/mailbox_providers/stats`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mailbox_providers/stats?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/mailbox_providers/stats?aggregated_by={aggregated_by}&end_date={end_date}&limit={limit}&mailbox_providers={mailbox_providers}&offset={offset}&start_date={start_date}&api_token={api_token}
```
**Description**: Retrieve email statistics by mailbox provider
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aggregated_by` | string | No | How to group the statistics |
| `end_date` | string | No | The end date of the statistics to retrieve. Defaults to today. |
| `limit` | number | No | The number of results to return |
| `mailbox_providers` | string | No | The mail box providers to get statistics for |
| `offset` | number | No | The point in the list to begin retrieving results |
| `start_date` | string | Yes | The starting date of the statistics to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/mailbox_providers/stats?aggregated_by=VALUE&end_date=VALUE&limit=VALUE&mailbox_providers=VALUE&offset=VALUE&start_date=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve email statistics by mailbox provider](https://docs.sendgrid.com/api-reference/stats/retrieve-email-statistics-by-mailbox-provider)
---
#### Retrieve email statistics by browser
**Method**: `GET` | **LowCodeAPI Path**: `/v3/browsers/stats`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/browsers/stats?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/browsers/stats?aggregated_by={aggregated_by}&browsers={browsers}&end_date={end_date}&limit={limit}&offset={offset}&api_token={api_token}
```
**Description**: Retrieve email statistics by browser
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aggregated_by` | string | No | How to group the statistics.
start_date |
| `browsers` | string | No | The browsers to get statistics for |
| `end_date` | string | No | The end date of the statistics to retrieve. |
| `limit` | number | No | The number of results to return |
| `offset` | number | No | The point in the list to begin retrieving results |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/browsers/stats?aggregated_by=VALUE&browsers=VALUE&end_date=VALUE&limit=VALUE&offset=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve email statistics by browser](https://docs.sendgrid.com/api-reference/stats/retrieve-email-statistics-by-browser)
---
### Category: Subuser Monitor Settings
#### Retrieve monitor settings for a subuser
**Method**: `GET` | **LowCodeAPI Path**: `/v3/subusers/{subuser_name}/monitor`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/{subuser_name}/monitor?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/subuser_name/monitor?subuser_name={subuser_name}&api_token={api_token}
```
**Description**: Retrieve monitor settings for a subuser
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subuser_name` | string | No | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/subusers/{subuser_name}/monitor?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve monitor settings for a subuser](https://docs.sendgrid.com/api-reference/subuser-monitor-settings/retrieve-monitor-settings-for-a-subuser)
---
#### Create monitor settings
**Method**: `POST` | **LowCodeAPI Path**: `/v3/subusers/{subuser_name}/monitor`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/{subuser_name}/monitor?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/subuser_name/monitor?subuser_name={subuser_name}&api_token={api_token}
```
**Description**: Create monitor settings
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subuser_name` | string | No | |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `email_to` | string | No | |
| `frequency` | string | No | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/subusers/{subuser_name}/monitor?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create monitor settings](https://docs.sendgrid.com/api-reference/subuser-monitor-settings/create-monitor-settings)
---
#### Update Monitor Settings for a subuser
**Method**: `PUT` | **LowCodeAPI Path**: `/v3/subusers/{subuser_name}/monitor`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/{subuser_name}/monitor?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/subuser_name/monitor?subuser_name={subuser_name}&api_token={api_token}
```
**Description**: Update Monitor Settings for a subuser
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subuser_name` | string | No | |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `email_to` | string | No | |
| `frequency` | string | No | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/sendgrid/v3/subusers/{subuser_name}/monitor?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update Monitor Settings for a subuser](https://docs.sendgrid.com/api-reference/subuser-monitor-settings/update-monitor-settings-for-a-subuser)
---
#### Delete monitor settings
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/subusers/{subuser_name}/monitor`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/{subuser_name}/monitor?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/subuser_name/monitor?subuser_name={subuser_name}&api_token={api_token}
```
**Description**: Delete monitor settings
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subuser_name` | string | No | |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/subusers/{subuser_name}/monitor?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete monitor settings](https://docs.sendgrid.com/api-reference/subuser-monitor-settings/delete-monitor-settings)
---
### Category: Subuser Statistics
#### Retrieve the monthly email statistics for a single subuser
**Method**: `GET` | **LowCodeAPI Path**: `/v3/subusers/{subuser_name}/stats/monthly`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/{subuser_name}/stats/monthly?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/subuser_name/stats/monthly?subuser_name={subuser_name}&date={date}&limit={limit}&offset={offset}&sort_by_direction={sort_by_direction}&sort_by_metric={sort_by_metric}&api_token={api_token}
```
**Description**: Retrieve the monthly email statistics for a single subuser
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subuser_name` | string | Yes | The username of the Subuser |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | The date of the month to retrieve statistics for |
| `limit` | number | No | Optional field to limit the number of results returned |
| `offset` | number | No | Optional beginning point in the list to retrieve from |
| `sort_by_direction` | string | No | The direction you want to sort |
| `sort_by_metric` | string | No | The metric that you want to sort by |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/subusers/{subuser_name}/stats/monthly?date=VALUE&limit=VALUE&offset=VALUE&sort_by_direction=VALUE&sort_by_metric=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve the monthly email statistics for a single subuser](https://docs.sendgrid.com/api-reference/subuser-statistics/retrieve-the-monthly-email-statistics-for-a-single-subuser)
---
#### Retrieve monthly stats for all subusers
**Method**: `GET` | **LowCodeAPI Path**: `/v3/subusers/stats/monthly`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/stats/monthly?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/stats/monthly?date={date}&limit={limit}&offset={offset}&sort_by_direction={sort_by_direction}&sort_by_metric={sort_by_metric}&subuser={subuser}&api_token={api_token}
```
**Description**: Retrieve monthly stats for all subusers
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | The date of the month to retrieve statistics for |
| `limit` | number | No | Optional field to limit the number of results returned |
| `offset` | number | No | Optional beginning point in the list to retrieve from. |
| `sort_by_direction` | string | No | The direction you want to sort |
| `sort_by_metric` | string | No | The metric that you want to sort by |
| `subuser` | string | No | A substring search of your subusers |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/subusers/stats/monthly?date=VALUE&limit=VALUE&offset=VALUE&sort_by_direction=VALUE&sort_by_metric=VALUE&subuser=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve monthly stats for all subusers](https://docs.sendgrid.com/api-reference/subuser-statistics/retrieve-monthly-stats-for-all-subusers)
---
#### Retrieve the totals for each email statistic metric for all subusers
**Method**: `GET` | **LowCodeAPI Path**: `/v3/subusers/stats/sums`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/stats/sums?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/stats/sums?aggregated_by={aggregated_by}&end_date={end_date}&limit={limit}&offset={offset}&sort_by_direction={sort_by_direction}&sort_by_metric={sort_by_metric}&start_date={start_date}&api_token={api_token}
```
**Description**: Retrieve the totals for each email statistic metric for all subusers
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aggregated_by` | string | No | How to group the statistics |
| `end_date` | string | No | The end date of the statistics to retrieve |
| `limit` | number | No | Limits the number of results returned per page |
| `offset` | number | No | The point in the list to begin retrieving results from |
| `sort_by_direction` | string | No | The direction you want to sort |
| `sort_by_metric` | string | No | The metric that you want to sort by. |
| `start_date` | string | Yes | The starting date of the statistics to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/subusers/stats/sums?aggregated_by=VALUE&end_date=VALUE&limit=VALUE&offset=VALUE&sort_by_direction=VALUE&sort_by_metric=VALUE&start_date=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve the totals for each email statistic metric for all subusers](https://docs.sendgrid.com/api-reference/subuser-statistics/retrieve-the-totals-for-each-email-statistic-metric-for-all-subusers)
---
#### Retrieve email statistics for your subuser
**Method**: `GET` | **LowCodeAPI Path**: `/v3/subusers/stats`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/stats?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/stats?aggregated_by={aggregated_by}&end_date={end_date}&imit={imit}&offset={offset}&start_date={start_date}&subusers={subusers}&api_token={api_token}
```
**Description**: Retrieve email statistics for your subuser
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aggregated_by` | string | No | How to group the statistics |
| `end_date` | string | No | The end date of the statistics to retrieve. Defaults to today. |
| `imit` | number | No | Limits the number of results returned per page |
| `offset` | number | No | The point in the list to begin retrieving results from |
| `start_date` | string | Yes | The starting date of the statistics to retrieve |
| `subusers` | string | Yes | The subuser you want to retrieve statistics for |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/subusers/stats?aggregated_by=VALUE&end_date=VALUE&imit=VALUE&offset=VALUE&start_date=VALUE&subusers=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve email statistics for your subuser](https://docs.sendgrid.com/api-reference/subuser-statistics/retrieve-email-statistics-for-your-subuser)
---
### Category: Subusers API
#### List all Subusers
**Method**: `GET` | **LowCodeAPI Path**: `/v3/subusers`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers?limit={limit}&offset={offset}&username={username}&api_token={api_token}
```
**Description**: List all Subusers
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | The number of results you would like to get in each request |
| `offset` | number | No | The number of subusers to skip. |
| `username` | string | No | The username of this subuser |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/subusers?limit=VALUE&offset=VALUE&username=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [List all Subusers](https://docs.sendgrid.com/api-reference/subusers-api/list-all-subusers)
---
#### Create Subuser
**Method**: `POST` | **LowCodeAPI Path**: `/v3/subusers`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers?api_token={api_token}
```
**Description**: Create Subuser
**Request Body**:
```json
{
"email": "<string>",
"ips": "<array>",
"password": "<string>",
"username": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `email` | string | Yes | The email address of the subuser |
| `ips` | array | Yes | The IP addresses that should be assigned to this subuser. |
| `password` | string | Yes | The password this subuser will use when logging into SendGrid |
| `username` | string | Yes | The username for this subuser |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/subusers?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create Subuser](https://docs.sendgrid.com/api-reference/subusers-api/create-subuser)
---
#### Enable/disable a subuser
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/subusers/{subuser_name}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/{subuser_name}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/subuser_name?"text"={"text"}&{
"subuser_name"={{
"subuser_name"}&api_token={api_token}
```
**Description**: Enable/disable a subuser
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `"text"` | "The username of the Subuser"
"required" | No | |
| `{
"subuser_name"` | {
"type" | No | |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `disabled` | boolean | No | Whether or not this subuser is disabled |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/subusers/{subuser_name}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Enable/disable a subuser](https://docs.sendgrid.com/api-reference/subusers-api/enabledisable-a-subuser)
---
#### Delete a subuser
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/subusers/{subuser_name}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/{subuser_name}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/subuser_name?subuser_name={subuser_name}&api_token={api_token}
```
**Description**: Delete a subuser
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subuser_name` | string | Yes | The username of the Subuser |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/subusers/{subuser_name}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a subuser](https://docs.sendgrid.com/api-reference/subusers-api/delete-a-subuser)
---
#### Retrieve Subuser Reputations
**Method**: `GET` | **LowCodeAPI Path**: `/v3/subusers/reputations`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/reputations?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/reputations?api_token={api_token}
```
**Description**: Retrieve Subuser Reputations
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/subusers/reputations?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve Subuser Reputations](https://docs.sendgrid.com/api-reference/subusers-api/retrieve-subuser-reputations)
---
#### Update IPs assigned to a subuser
**Method**: `PUT` | **LowCodeAPI Path**: `/v3/subusers/{subuser_name}/ips`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/{subuser_name}/ips?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/subusers/subuser_name/ips?subuser_name={subuser_name}&api_token={api_token}
```
**Description**: Update IPs assigned to a subuser
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subuser_name` | string | Yes | The username of the Subuser |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/sendgrid/v3/subusers/{subuser_name}/ips?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update IPs assigned to a subuser](https://docs.sendgrid.com/api-reference/subusers-api/update-ips-assigned-to-a-subuser)
---
### Category: Suppressions - Global Suppressions
#### Add recipient addresses to the global suppression group
**Method**: `POST` | **LowCodeAPI Path**: `/v3/asm/suppressions/global`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/suppressions/global?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/suppressions/global?api_token={api_token}
```
**Description**: Add recipient addresses to the global suppression group
**Request Body**:
```json
{
"recipient_emails": "<array>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `recipient_emails` | array | Yes | The array of email addresses to add or find |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/asm/suppressions/global?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add recipient addresses to the global suppression group](https://docs.sendgrid.com/api-reference/suppressions-global-suppressions/add-recipient-addresses-to-the-global-suppression-group)
---
#### Retrieve all global suppressions
**Method**: `GET` | **LowCodeAPI Path**: `/v3/suppression/unsubscribes`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/unsubscribes?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/suppression/unsubscribes?end_time={end_time}&limit={limit}&offset={offset}&start_time={start_time}&api_token={api_token}
```
**Description**: Retrieve all global suppressions
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_time` | number | No | Refers end of the time range in unix timestamp when an unsubscribe email was created (inclusive) |
| `limit` | number | No | The number of results to display on each page |
| `offset` | number | No | The point in the list of results to begin displaying global suppressions. |
| `start_time` | number | No | Refers start of the time range in unix timestamp when an unsubscribe email was created (inclusive) |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/suppression/unsubscribes?end_time=VALUE&limit=VALUE&offset=VALUE&start_time=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all global suppressions](https://docs.sendgrid.com/api-reference/suppressions-global-suppressions/retrieve-all-global-suppressions)
---
#### Retrieve a Global Suppression
**Method**: `GET` | **LowCodeAPI Path**: `/v3/asm/suppressions/global/{email}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/suppressions/global/{email}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/suppressions/global/email?email={email}&api_token={api_token}
```
**Description**: Retrieve a Global Suppression
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address of the global suppression you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/asm/suppressions/global/{email}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a Global Suppression](https://docs.sendgrid.com/api-reference/suppressions-global-suppressions/retrieve-a-global-suppression)
---
#### Delete a Global Suppression
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/asm/suppressions/global/{email}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/suppressions/global/{email}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/suppressions/global/email?email={email}&api_token={api_token}
```
**Description**: Delete a Global Suppression
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address of the global suppression you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/asm/suppressions/global/{email}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a Global Suppression](https://docs.sendgrid.com/api-reference/suppressions-global-suppressions/delete-a-global-suppression)
---
### Category: Suppressions - Suppressions
#### Add suppressions to a suppression group
**Method**: `POST` | **LowCodeAPI Path**: `/v3/asm/groups/{group_id}/suppressions`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/groups/{group_id}/suppressions?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/groups/group_id/suppressions?group_id={group_id}&api_token={api_token}
```
**Description**: Add suppressions to a suppression group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | The id of the unsubscribe group that you are adding suppressions to. |
**Request Body**:
```json
{
"ecipient_emails": "<array>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `ecipient_emails` | array | Yes | The array of email addresses to add or find. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/asm/groups/{group_id}/suppressions?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add suppressions to a suppression group](https://docs.sendgrid.com/api-reference/suppressions-suppressions/add-suppressions-to-a-suppression-group)
---
#### Search for suppressions within a group
**Method**: `POST` | **LowCodeAPI Path**: `/v3/asm/groups/{group_id}/suppressions/search`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/groups/{group_id}/suppressions/search?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/groups/group_id/suppressions/search?group_id={group_id}&api_token={api_token}
```
**Description**: Search for suppressions within a group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | The ID of the suppression group that you would like to search. |
**Request Body**:
```json
{
"recipient_emails": "<array>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `recipient_emails` | array | Yes | The array of email addresses to add or find |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/asm/groups/{group_id}/suppressions/search?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Search for suppressions within a group](https://docs.sendgrid.com/api-reference/suppressions-suppressions/search-for-suppressions-within-a-group)
---
#### Retrieve all suppressions for a suppression group
**Method**: `GET` | **LowCodeAPI Path**: `/v3/asm/groups/{group_id}/suppressions`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/groups/{group_id}/suppressions?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/groups/group_id/suppressions?group_id={group_id}&api_token={api_token}
```
**Description**: Retrieve all suppressions for a suppression group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | The id of the unsubscribe group that you are adding suppressions to. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/asm/groups/{group_id}/suppressions?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all suppressions for a suppression group](https://docs.sendgrid.com/api-reference/suppressions-suppressions/retrieve-all-suppressions-for-a-suppression-group)
---
#### Retrieve all suppressions
**Method**: `GET` | **LowCodeAPI Path**: `/v3/asm/suppressions`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/suppressions?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/suppressions?api_token={api_token}
```
**Description**: Retrieve all suppressions
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/asm/suppressions?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all suppressions](https://docs.sendgrid.com/api-reference/suppressions-suppressions/retrieve-all-suppressions)
---
#### Retrieve all suppression groups for an email address
**Method**: `GET` | **LowCodeAPI Path**: `/v3/asm/suppressions/{email}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/suppressions/{email}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/suppressions/email?email={email}&api_token={api_token}
```
**Description**: Retrieve all suppression groups for an email address
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address that you want to search suppression groups for. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/asm/suppressions/{email}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all suppression groups for an email address](https://docs.sendgrid.com/api-reference/suppressions-suppressions/retrieve-all-suppression-groups-for-an-email-address)
---
#### Delete a suppression from a suppression group
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/asm/groups/{group_id}/suppressions/{email}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/groups/{group_id}/suppressions/{email}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/groups/group_id/suppressions/email?email={email}&group_id={group_id}&api_token={api_token}
```
**Description**: Delete a suppression from a suppression group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address that you want to remove from the suppression group. |
| `group_id` | string | Yes | The id of the suppression group that you are removing an email address from |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/asm/groups/{group_id}/suppressions/{email}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a suppression from a suppression group](https://docs.sendgrid.com/api-reference/suppressions-suppressions/delete-a-suppression-from-a-suppression-group)
---
### Category: Suppressions - Unsubscribe Groups
#### Create a new suppression group
**Method**: `POST` | **LowCodeAPI Path**: `/v3/asm/groups`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/groups?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/groups?api_token={api_token}
```
**Description**: Create a new suppression group
**Request Body**:
```json
{
"description": "<string>",
"id": "<number>",
"is_default": "<boolean>",
"name": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `description` | string | Yes | A brief description of the suppression group |
| `id` | number | Yes | The ID of the suppression group |
| `is_default` | boolean | Yes | Indicates if this is the default suppression group. |
| `name` | string | Yes | The name of the suppression group |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/asm/groups?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a new suppression group](https://docs.sendgrid.com/api-reference/suppressions-unsubscribe-groups/create-a-new-suppression-group)
---
#### Retrieve all suppression groups associated with the user
**Method**: `GET` | **LowCodeAPI Path**: `/v3/asm/groups`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/groups?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/groups?api_token={api_token}
```
**Description**: Retrieve all suppression groups associated with the user
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/asm/groups?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all suppression groups associated with the user](https://docs.sendgrid.com/api-reference/suppressions-unsubscribe-groups/retrieve-all-suppression-groups-associated-with-the-user)
---
#### Get information on a single suppression group
**Method**: `GET` | **LowCodeAPI Path**: `/v3/asm/groups/{group_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/groups/{group_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/groups/group_id?group_id={group_id}&api_token={api_token}
```
**Description**: Get information on a single suppression group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | The ID of the suppression group you would like to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/asm/groups/{group_id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get information on a single suppression group](https://docs.sendgrid.com/api-reference/suppressions-unsubscribe-groups/get-information-on-a-single-suppression-group)
---
#### Update a suppression group
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/asm/groups/{group_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/groups/{group_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/groups/group_id?group_id={group_id}&api_token={api_token}
```
**Description**: Update a suppression group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | The ID of the suppression group you would like to retrieve. |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `is_default` | boolean | No | Indicates if you would like this to be your default suppression group. |
| `name` | string | No | The name of your suppression group. Required when creating a group.
description |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/asm/groups/{group_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update a suppression group](https://docs.sendgrid.com/api-reference/suppressions-unsubscribe-groups/update-a-suppression-group)
---
#### Delete a Suppression Group
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/asm/groups/{group_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/groups/{group_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/asm/groups/group_id?group_id={group_id}&api_token={api_token}
```
**Description**: Delete a Suppression Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | The ID of the suppression group you would like to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/asm/groups/{group_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a Suppression Group](https://docs.sendgrid.com/api-reference/suppressions-unsubscribe-groups/delete-a-suppression-group)
---
### Category: Teammates
#### Invite teammate
**Method**: `POST` | **LowCodeAPI Path**: `/v3/teammates`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/teammates?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/teammates?api_token={api_token}
```
**Description**: Invite teammate
**Request Body**:
```json
{
"email": "<string>",
"is_admin": "<boolean>",
"scopes": "<array>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `email` | string | Yes | New teammate's email |
| `is_admin` | boolean | Yes | Set to true if teammate should be an admin user. |
| `scopes` | array | Yes | Set to specify list of scopes that teammate should have.Should be empty if teammate is an admin |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/teammates?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Invite teammate](https://docs.sendgrid.com/api-reference/teammates/invite-teammate)
---
#### Resend teammate invite
**Method**: `POST` | **LowCodeAPI Path**: `/v3/teammates/pending/{token}/resend`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/teammates/pending/{token}/resend?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/teammates/pending/token/resend?token={token}&api_token={api_token}
```
**Description**: Resend teammate invite
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token` | string | Yes | The token for the invite that you want to resend |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/teammates/pending/{token}/resend?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Resend teammate invite](https://docs.sendgrid.com/api-reference/teammates/resend-teammate-invite)
---
#### Retrieve all teammates
**Method**: `GET` | **LowCodeAPI Path**: `/v3/teammates`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/teammates?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/teammates?limit={limit}&offset={offset}&api_token={api_token}
```
**Description**: Retrieve all teammates
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Number of items to return |
| `offset` | number | No | Paging offset. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/teammates?limit=VALUE&offset=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all teammates](https://docs.sendgrid.com/api-reference/teammates/retrieve-all-teammates)
---
#### Retrieve access requests
**Method**: `GET` | **LowCodeAPI Path**: `/v3/scopes/requests`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/scopes/requests?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/scopes/requests?limit={limit}&offset={offset}&api_token={api_token}
```
**Description**: Retrieve access requests
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Optional field to limit the number of results returned |
| `offset` | number | No | Optional beginning point in the list to retrieve from. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/scopes/requests?limit=VALUE&offset=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve access requests](https://docs.sendgrid.com/api-reference/teammates/retrieve-access-requests)
---
#### Retrieve all pending teammates
**Method**: `GET` | **LowCodeAPI Path**: `/v3/teammates/pending`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/teammates/pending?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/teammates/pending?api_token={api_token}
```
**Description**: Retrieve all pending teammates
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/teammates/pending?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve all pending teammates](https://docs.sendgrid.com/api-reference/teammates/retrieve-all-pending-teammates)
---
#### Retrieve specific teammate
**Method**: `GET` | **LowCodeAPI Path**: `/v3/teammates/{username}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/teammates/{username}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/teammates/username?username={username}&api_token={api_token}
```
**Description**: Retrieve specific teammate
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `username` | string | Yes | The username of the teammate that you want to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/teammates/{username}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve specific teammate](https://docs.sendgrid.com/api-reference/teammates/retrieve-specific-teammate)
---
#### Approve access request
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/scopes/requests/{request_id}/approve`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/scopes/requests/{request_id}/approve?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/scopes/requests/request_id/approve?request_id={request_id}&api_token={api_token}
```
**Description**: Approve access request
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `request_id` | string | Yes | The ID of the request that you want to approve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/scopes/requests/{request_id}/approve?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Approve access request](https://docs.sendgrid.com/api-reference/teammates/approve-access-request)
---
#### Update teammate's permissions
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/teammates/{username}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/teammates/{username}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/teammates/username?username={username}&api_token={api_token}
```
**Description**: Update teammate's permissions
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `username` | string | Yes | The username of the teammate that you want to retrieve |
**Request Body**:
```json
{
"is_admin": "<boolean>",
"scopes": "<array>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `is_admin` | boolean | Yes | Set to True if this teammate should be promoted to an admin user. |
| `scopes` | array | Yes | Provide list of scopes that should be given to teammate |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/teammates/{username}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update teammate's permissions](https://docs.sendgrid.com/api-reference/teammates/update-teammates-permissions)
---
#### Deny access request
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/scopes/requests/{request_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/scopes/requests/{request_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/scopes/requests/request_id?request_id={request_id}&api_token={api_token}
```
**Description**: Deny access request
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `request_id` | string | Yes | The ID of the request that you want to deny |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/scopes/requests/{request_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Deny access request](https://docs.sendgrid.com/api-reference/teammates/deny-access-request#path)
---
#### Delete pending teammate
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/teammates/pending/{token}/resend`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/teammates/pending/{token}/resend?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/teammates/pending/token/resend?token={token}&api_token={api_token}
```
**Description**: Delete pending teammate
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token` | string | Yes | The token for the invite you want to delete |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/teammates/pending/{token}/resend?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete pending teammate](https://docs.sendgrid.com/api-reference/teammates/delete-pending-teammate)
---
#### Delete teammate
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/teammates/{username}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/teammates/{username}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/teammates/username?username={username}&api_token={api_token}
```
**Description**: Delete teammate
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `username` | string | Yes | The username of the teammate that you want to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/teammates/{username}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete teammate](https://docs.sendgrid.com/api-reference/teammates/delete-teammate)
---
### Category: Transactional Templates
#### Create a transactional template
**Method**: `POST` | **LowCodeAPI Path**: `/v3/templates`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates?api_token={api_token}
```
**Description**: Create a transactional template
**Request Body**:
```json
{
"name": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `generation` | string | No | Defines whether the template supports dynamic replacement |
| `name` | string | Yes | The name for the new transactional template |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/templates?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a transactional template](https://docs.sendgrid.com/api-reference/transactional-templates/create-a-transactional-template)
---
#### Duplicate a transactional template
**Method**: `POST` | **LowCodeAPI Path**: `/v3/templates/{template_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates/{template_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates/template_id?template_id={template_id}&api_token={api_token}
```
**Description**: Duplicate a transactional template
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | . |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/templates/{template_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Duplicate a transactional template](https://docs.sendgrid.com/api-reference/transactional-templates/duplicate-a-transactional-template)
---
#### Retrieve paged transactional templates
**Method**: `GET` | **LowCodeAPI Path**: `/v3/templates`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates?generations={generations}&page_size={page_size}&page_token={page_token}&api_token={api_token}
```
**Description**: Retrieve paged transactional templates
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `generations` | string | No | Comma-delimited list specifying which generations of templates to return |
| `page_size` | number | Yes | The number of templates to be returned in each page of results |
| `page_token` | string | No | A token corresponding to a specific page of results as provided by metadata |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/templates?generations=VALUE&page_size=VALUE&page_token=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve paged transactional templates](https://docs.sendgrid.com/api-reference/transactional-templates/retrieve-paged-transactional-templates)
---
#### Retrieve a single transactional template
**Method**: `GET` | **LowCodeAPI Path**: `/v3/templates/{template_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates/{template_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates/template_id?template_id={template_id}&api_token={api_token}
```
**Description**: Retrieve a single transactional template
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | Template Id |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/templates/{template_id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a single transactional template](https://docs.sendgrid.com/api-reference/transactional-templates/retrieve-a-single-transactional-template)
---
#### Edit a transactional template
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/templates/{template_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates/{template_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates/template_id?template_id={template_id}&api_token={api_token}
```
**Description**: Edit a transactional template
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | Template Id |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `name` | string | No | The name of the transactional template |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/templates/{template_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Edit a transactional template](https://docs.sendgrid.com/api-reference/transactional-templates/edit-a-transactional-template)
---
#### Delete a template
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/templates/{template_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates/{template_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates/template_id?template_id={template_id}&api_token={api_token}
```
**Description**: Delete a template
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | . |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/templates/{template_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a template](https://docs.sendgrid.com/api-reference/transactional-templates/delete-a-template)
---
### Category: Transactional Templates Versions
#### Create a new transactional template version
**Method**: `POST` | **LowCodeAPI Path**: `/v3/templates/{template_id}/versions`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates/{template_id}/versions?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates/template_id/versions?template_id={template_id}&api_token={api_token}
```
**Description**: Create a new transactional template version
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | Template Id |
**Request Body**:
```json
{
"name": "<string>",
"subject": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `active` | number | No | Set the version as the active version associated with the template |
| `editor` | string | No | The editor used in the UI |
| `generate_plain_content` | boolean | No | If true plain_content is always generated from html_content |
| `html_content` | string | No | The HTML content of the version |
| `name` | string | Yes | Name of the transactional template version |
| `plain_content` | string | No | Text/plain content of the transactional template version |
| `subject` | string | Yes | Subject of the new transactional template version |
| `test_data` | string | No | For dynamic templates only the mock json data that will be used for template preview and test sends. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/templates/{template_id}/versions?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a new transactional template version](https://docs.sendgrid.com/api-reference/transactional-templates-versions/create-a-new-transactional-template-version)
---
#### Activate a transactional template version
**Method**: `POST` | **LowCodeAPI Path**: `/v3/templates/{template_id}/versions/{version_id}/activate`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates/{template_id}/versions/{version_id}/activate?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates/template_id/versions/version_id/activate?template_id={template_id}&version_id={version_id}&api_token={api_token}
```
**Description**: Activate a transactional template version
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | The ID of the original template |
| `version_id` | string | Yes | The ID of the template version |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/templates/{template_id}/versions/{version_id}/activate?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Activate a transactional template version](https://docs.sendgrid.com/api-reference/transactional-templates-versions/activate-a-transactional-template-version)
---
#### Retrieve a specific transactional template version
**Method**: `GET` | **LowCodeAPI Path**: `/v3/templates/{template_id}/versions/{version_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates/{template_id}/versions/{version_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates/template_id/versions/version_id?template_id={template_id}&version_id={version_id}&api_token={api_token}
```
**Description**: Retrieve a specific transactional template version
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | The ID of the original template |
| `version_id` | string | Yes | The ID of the template version. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/templates/{template_id}/versions/{version_id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve a specific transactional template version](https://docs.sendgrid.com/api-reference/transactional-templates-versions/retrieve-a-specific-transactional-template-version)
---
#### Edit a transactional template version
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/templates/{template_id}/versions/{version_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates/{template_id}/versions/{version_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates/template_id/versions/version_id?template_id={template_id}&version_id={version_id}&api_token={api_token}
```
**Description**: Edit a transactional template version
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | The ID of the original template |
| `version_id` | string | Yes | The ID of the template version. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/templates/{template_id}/versions/{version_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Edit a transactional template version](https://docs.sendgrid.com/api-reference/transactional-templates-versions/edit-a-transactional-template-version)
---
#### Delete a transactional template version
**Method**: `DELETE` | **LowCodeAPI Path**: `/v3/templates/{template_id}/versions/{version_id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates/{template_id}/versions/{version_id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/templates/template_id/versions/version_id?template_id={template_id}&version_id={version_id}&api_token={api_token}
```
**Description**: Delete a transactional template version
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | The ID of the original template |
| `version_id` | string | No | The ID of the template version |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/sendgrid/v3/templates/{template_id}/versions/{version_id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a transactional template version](https://docs.sendgrid.com/api-reference/transactional-templates-versions/delete-a-transactional-template-version)
---
### Category: Users API
#### Get a user's profile
**Method**: `GET` | **LowCodeAPI Path**: `/v3/user/profile`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/profile?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/profile?api_token={api_token}
```
**Description**: Get a user's profile
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/user/profile?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get a user's profile](https://docs.sendgrid.com/api-reference/users-api/get-a-users-profile)
---
#### Update a user's profile
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/user/profile`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/profile?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/profile?api_token={api_token}
```
**Description**: Update a user's profile
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `address` | string | No | The street address for this user profile |
| `address2` | string | No | An optional second line for the street address of this user profile |
| `city` | string | No | The city for the user profile |
| `company` | string | No | That company that this user profile is associated with |
| `country` | string | No | Th country of this user profile |
| `first_name` | string | No | The first name of the user |
| `last_name` | string | No | The last name of the user.
phone |
| `state` | string | No | The state for this user |
| `website` | string | No | The website associated with this user |
| `zip` | string | No | The zip code for this user. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/user/profile?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update a user's profile](https://docs.sendgrid.com/api-reference/users-api/update-a-users-profile)
---
#### Get a user's account information
**Method**: `GET` | **LowCodeAPI Path**: `/v3/user/account`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/account?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/account?api_token={api_token}
```
**Description**: Get a user's account information
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/user/account?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get a user's account information](https://docs.sendgrid.com/api-reference/users-api/get-a-users-account-information)
---
#### Retrieve your account email address
**Method**: `GET` | **LowCodeAPI Path**: `/v3/user/email`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/email?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/email?api_token={api_token}
```
**Description**: Retrieve your account email address
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/user/email?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve your account email address](https://docs.sendgrid.com/api-reference/users-api/retrieve-your-account-email-address)
---
#### Update your account email address
**Method**: `PUT` | **LowCodeAPI Path**: `/v3/user/email`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/email?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/email?api_token={api_token}
```
**Description**: Update your account email address
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `email` | string | No | The new email address that you would like to use for your account |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/sendgrid/v3/user/email?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update your account email address](https://docs.sendgrid.com/api-reference/users-api/update-your-account-email-address)
---
#### Retrieve your username
**Method**: `GET` | **LowCodeAPI Path**: `/v3/user/username`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/username?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/username?api_token={api_token}
```
**Description**: Retrieve your username
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/user/username?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve your username](https://docs.sendgrid.com/api-reference/users-api/retrieve-your-username)
---
#### Update your username
**Method**: `PUT` | **LowCodeAPI Path**: `/v3/user/username`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/username?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/username?api_token={api_token}
```
**Description**: Update your username
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `username` | string | No | The new username you would like to use for your account |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/sendgrid/v3/user/username?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update your username](https://docs.sendgrid.com/api-reference/users-api/update-your-username)
---
#### Retrieve your credit balance
**Method**: `GET` | **LowCodeAPI Path**: `/v3/user/credits`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/credits?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/credits?api_token={api_token}
```
**Description**: Retrieve your credit balance
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/user/credits?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve your credit balance](https://docs.sendgrid.com/api-reference/users-api/retrieve-your-credit-balance)
---
#### Update your password
**Method**: `PUT` | **LowCodeAPI Path**: `/v3/user/password`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/password?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/password?api_token={api_token}
```
**Description**: Update your password
**Request Body**:
```json
{
"new_password": "<string>",
"old_password": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `new_password` | string | Yes | The new password you would like to use for your account |
| `old_password` | string | Yes | The old password for your account. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/sendgrid/v3/user/password?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update your password](https://docs.sendgrid.com/api-reference/users-api/update-your-password)
---
### Category: Webhooks
#### Retrieve Parse Webhook settings
**Method**: `GET` | **LowCodeAPI Path**: `/v3/user/webhooks/parse/settings`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/parse/settings?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/parse/settings?api_token={api_token}
```
**Description**: Retrieve Parse Webhook settings
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/parse/settings?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve Parse Webhook settings](https://docs.sendgrid.com/api-reference/webhooks/retrieve-parse-webhook-settings)
---
#### Get All Event Webhooks
**Method**: `GET` | **LowCodeAPI Path**: `/v3/user/webhooks/event/settings/all`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings/all?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings/all?api_token={api_token}
```
**Description**: Get All Event Webhooks
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings/all?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get All Event Webhooks](https://docs.sendgrid.com/api-reference/webhooks/get-all-event-webhooks)
---
#### Create an Event Webhook
**Method**: `POST` | **LowCodeAPI Path**: `/v3/user/webhooks/event/settings`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings?api_token={api_token}
```
**Description**: Create an Event Webhook
**Request Body**:
```json
{
"url": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `bounce` | boolean | No | Set this property to true to receive bounce events |
| `click` | boolean | No | Set this property to true to receive click events |
| `deferred` | boolean | No | Set this property to true to receive deferred events |
| `delivered` | boolean | No | Set this property to true to receive delivered events |
| `dropped` | boolean | No | Set this property to true to receive dropped events |
| `enabled` | boolean | No | Set this property to true to enable the Event Webhook or false to disable it |
| `friendly_name` | string | No | Optionally set this property to a friendly name for the Event Webhook |
| `group_resubscribe` | boolean | No | Set this property to true to receive group resubscribe events |
| `group_unsubscribe` | boolean | No | Set this property to true to receive group unsubscribe events |
| `oauth_client_id` | string | No | Set this property to the OAuth client ID that SendGrid will pass to your OAuth server or service provider to generate an OAuth access token. When passing data in this property you must also include the oauth_token_url property |
| `oauth_client_secret` | string | No | Set this property to the OAuth client secret that SendGrid will pass to your OAuth server or service provider to generate an OAuth access token |
| `oauth_token_url` | string | No | Set this property to the URL where SendGrid will send the OAuth client ID and client secret to generate an OAuth access token |
| `open` | boolean | No | Set this property to true to receive open events |
| `processed` | boolean | No | Set this property to true to receive processed events |
| `spam_report` | boolean | No | Set this property to true to receive spam report events |
| `unsubscribe` | boolean | No | Set this property to true to receive unsubscribe events |
| `url` | string | Yes | Set this property to the URL where you want the Event Webhook to send event data |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create an Event Webhook](https://docs.sendgrid.com/api-reference/webhooks/create-an-event-webhook)
---
#### Get an Event Webhook
**Method**: `GET` | **LowCodeAPI Path**: `/v3/user/webhooks/event/settings/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings/id?id={id}&api_token={api_token}
```
**Description**: Get an Event Webhook
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings/{id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get an Event Webhook](https://docs.sendgrid.com/api-reference/webhooks/get-an-event-webhook)
---
#### Update an Event Webhook
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/user/webhooks/event/settings/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings/id?api_token={api_token}
```
**Description**: Update an Event Webhook
**Request Body**:
```json
{
"url": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `bounce` | boolean | No | Set this property to true to receive bounce events |
| `click` | boolean | No | Set this property to true to receive click events |
| `deferred` | boolean | No | Set this property to true to receive deferred events |
| `delivered` | boolean | No | Set this property to true to receive delivered events |
| `dropped` | boolean | No | Set this property to true to receive dropped events |
| `enabled` | boolean | No | Set this property to true to enable the Event Webhook or false to disable it |
| `friendly_name` | string | No | Optionally set this property to a friendly name for the Event Webhook |
| `group_resubscribe` | boolean | No | Set this property to true to receive group resubscribe events |
| `group_unsubscribe` | boolean | No | Set this property to true to receive group unsubscribe events |
| `oauth_client_id` | string | No | Set this property to the OAuth client ID that SendGrid will pass to your OAuth server or service provider to generate an OAuth access token. When passing data in this property you must also include the oauth_token_url property |
| `oauth_client_secret` | string | No | Set this property to the OAuth client secret that SendGrid will pass to your OAuth server or service provider to generate an OAuth access token |
| `oauth_token_url` | string | No | Set this property to the URL where SendGrid will send the OAuth client ID and client secret to generate an OAuth access token |
| `open` | boolean | No | Set this property to true to receive open events |
| `processed` | boolean | No | Set this property to true to receive processed events |
| `spam_report` | boolean | No | Set this property to true to receive spam report events. |
| `unsubscribe` | boolean | No | Set this property to true to receive unsubscribe events |
| `url` | string | Yes | Set this property to the URL where you want the Event Webhook to send event data |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings/{id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update an Event Webhook](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook)
---
#### Delete an Event Webhook
**Method**: `POST` | **LowCodeAPI Path**: `/v3/user/webhooks/event/settings/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings/id?id={id}&api_token={api_token}
```
**Description**: Delete an Event Webhook
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings/{id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete an Event Webhook](https://docs.sendgrid.com/api-reference/webhooks/test-event-notification-settings)
---
#### Toggle Signature Verification for an Event Webhook
**Method**: `PATCH` | **LowCodeAPI Path**: `/v3/user/webhooks/event/settings/signed/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings/signed/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings/signed/id?id={id}&api_token={api_token}
```
**Description**: Toggle Signature Verification for an Event Webhook
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve. |
**Request Body**:
```json
{
"enabled": "<boolean>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `enabled` | boolean | Yes | Enable or disable the webhook by setting this property to true or false respectively. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PATCH "https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings/signed/{id}?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Toggle Signature Verification for an Event Webhook](https://docs.sendgrid.com/api-reference/webhooks/toggle-signature-verification-for-an-event-webhook)
---
#### Get Signed Event Webhook's Public Key
**Method**: `GET` | **LowCodeAPI Path**: `/v3/user/webhooks/event/settings/signed/{id}`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings/signed/{id}?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings/signed/id?id={id}&api_token={api_token}
```
**Description**: Get Signed Event Webhook's Public Key
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the Event Webhook you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/settings/signed/{id}?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Signed Event Webhook's Public Key](https://docs.sendgrid.com/api-reference/webhooks/get-signed-event-webhooks-public-key)
---
#### Test Event Notification Settings
**Method**: `POST` | **LowCodeAPI Path**: `/v3/user/webhooks/event/test`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/test?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/test?api_token={api_token}
```
**Description**: Test Event Notification Settings
**Request Body**:
```json
{
"url": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `id` | string | No | The ID of the Event Webhook you want to retrieve |
| `oauth_client_id` | string | No | The client ID Twilio SendGrid sends to your OAuth server or service provider to generate an OAuth access token |
| `oauth_client_secret` | string | No | The oauth_client_secret is needed only once to create an access token |
| `oauth_token_url` | string | No | The URL where Twilio SendGrid sends the Client ID and Client Secret to generate an access token. |
| `url` | string | Yes | The URL where you would like the test notification to be sent |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/event/test?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Test Event Notification Settings](https://docs.sendgrid.com/api-reference/webhooks/test-event-notification-settings)
---
#### Retrieves Inbound Parse Webhook statistics.
**Method**: `GET` | **LowCodeAPI Path**: `/v3/user/webhooks/parse/stats`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/parse/stats?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/parse/stats?aggregated_by={aggregated_by}&end_date={end_date}&limit={limit}&offset={offset}&start_date={start_date}&api_token={api_token}
```
**Description**: Retrieves Inbound Parse Webhook statistics.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aggregated_by` | string | No | How you would like the statistics to by grouped |
| `end_date` | string | No | The end date of the statistics you want to retrieve |
| `limit` | string | No | The number of statistics to return on each page |
| `offset` | string | No | The number of statistics to skip |
| `start_date` | string | Yes | The starting date of the statistics you want to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/user/webhooks/parse/stats?aggregated_by=VALUE&end_date=VALUE&limit=VALUE&offset=VALUE&start_date=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieves Inbound Parse Webhook statistics.](https://docs.sendgrid.com/api-reference/webhooks/retrieves-inbound-parse-webhook-statistics)
---
## Complete Endpoint Reference
For a complete list of all 351 endpoints, refer to the API Definition Endpoints section below.
## API Definition Endpoints
You can retrieve the complete OpenAPI specification for Sendgrid using these endpoints:
**New Format (OpenAPI spec with dynamic path parameters):**
```bash
curl -X GET "https://backend.lowcodeapi.com/sendgrid/openapi"
```
**Old Format (API definition with sanitized paths):**
```bash
curl -X GET "https://backend.lowcodeapi.com/sendgrid/definition"
```
## Response Format
All responses from LowCodeAPI are wrapped in a `data` key:
```json
{
"data": {
// Actual response from Sendgrid API
}
}
```
The `data` key contains the raw response from the Sendgrid API.
**Example Response Structure:**
```json
{
"data": {
"result": [
{
"id": "resource_id",
"name": "Resource Name"
}
]
}
}
```
## Usage Examples
### Example 1: Send an Email (New Format)
Send a transactional email using Sendgrid:
```bash
# Send a basic email
curl -X POST "https://api.lowcodeapi.com/sendgrid/v3/mail/send?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"from": {
"email": "[email protected]"
},
"personalizations": [
{
"to": [
{
"email": "[email protected]"
}
]
}
],
"subject": "Hello from LowCodeAPI",
"content": [
{
"type": "text/plain",
"value": "This is a test email sent via LowCodeAPI."
}
]
}'
```
### Example 2: List API Keys (New Format)
Retrieve all API keys in your Sendgrid account:
```bash
# Get all API keys
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/api_keys?api_token=YOUR_API_TOKEN" \
-H "Authorization: Bearer YOUR_API_TOKEN"
# Response will include API key IDs that can be used for other operations
# API_KEY_ID from response can be used to update or delete specific keys
```
### Example 3: Get Statistics (New Format with Query Parameters)
Get email statistics with date filtering:
```bash
# Get statistics for a specific date range
curl -X GET "https://api.lowcodeapi.com/sendgrid/v3/stats?start_date=2024-01-01&end_date=2024-01-31&api_token=YOUR_API_TOKEN"
```
## Error Handling
LowCodeAPI returns standard HTTP status codes. Common errors for Sendgrid:
| Status Code | Description |
|-------------|-------------|
| 200 | Success - Request completed successfully |
| 202 | Accepted - Request is being processed |
| 400 | Bad Request - Invalid parameters or request body |
| 401 | Unauthorized - Invalid or missing API token |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found - Endpoint or resource doesn't exist |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Server Error - Sendgrid API error |
All error responses include error details:
```json
{
"data": {
"errors": [
{
"message": "Error description",
"field": "field_name",
"help": "https://docs.sendgrid.com/..."
}
]
}
}
```