Email

Email operations

get

List emails, subject to attribute search criteria.

Authorizations

BasicOAuth

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Query parameters

$limitnumberOptional

The number of records to be returned.

Default: 100

$skipnumberOptional

The number of records to be skipped for pagination.

Default: 0

$orderstringOptional

The order of the records. The result can be sorted by multiple attributes separated by a comma (,). Examples; name name asc name desc name,createdAt desc

$withstringOptional

Load related entities as objects.

attrib_namestringOptional

Filter records by attributes. The result can be filtered by any attribute of the entity. All request parameters not starting with $ are automatically used as a filter condition.

• Extended filtering options are also available. See the table below.
• Filter parameters that do not belong to the entity are silently ignored.
• ISO-8601 formats are accepted for the date fields. The timezone will be set to UTC if not provided.
• The separator for in and notin modifiers is the pipe character (|). Pipe characters can be escaped with a backslash in front of it.
• Concat Like is to search for a string in two or more fields. It is only supported for JSON fields.

Description	GET Request Example
Exact Match	name=john
Not Equals (Exact Match)	name:ne=john
Is Null	name=null
Is Not Null	name:ne=null
Greater Than	age:gt=5, birth:gt=1977-10-22T22:04:00
Greater Than or Equal To	age:gte=5, birth:gte=1977-10-22T22:04:00
Less Than	age:lt=3, birth:lt=2000-01-01T00:00:00
Less Than or Equal To	age:lte=3, birth:lte=2000-01-01T00:00:00
Between	age:bt=3,5, birth:bt=1977-10-22T22:04:00,2000-01-01T00:00:00
In	status:in=value 1|value 2|value 3
Not In	status:notin=value 1|value 2|value 3
Like	name:like=%john%
Not Like	name:notlike=%john%
Concat Like(Only for JSON fields)	firstName,lastName:concatlike=full name

Responses

200

OK

application/json

get

/email

HTTPcURLJavaScriptPython

GET /email HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

OK

[
  {
    "emailAddress": "text",
    "description": "text",
    "metadata": {},
    "elementType": "text",
    "elementId": "text",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2026-02-14",
    "updated_at": "2026-02-14"
  }
]

post

Create a new email

Authorizations

BasicOAuth

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

body

emailAddressstringRequired

descriptionstringOptional

elementIdstringRequired

elementTypestringRequired

Body

application/json

emailAddressstringRequired

descriptionstringOptional

metadataobjectOptional

Arbitrary structured information

elementTypestringRequired

The name of the entity

elementIdstringRequired

The ID of the entity

organizationstring · uuidRequired

Responses

201

Created

No content

post

/email

HTTPcURLJavaScriptPython

POST /email HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 152

{
  "emailAddress": "text",
  "description": "text",
  "metadata": {},
  "elementType": "text",
  "elementId": "text",
  "organization": "123e4567-e89b-12d3-a456-426614174000"
}

201

Created

No content

get

Read a email by ID

Authorizations

BasicOAuth

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Path parameters

idstringRequired

Unique ID of the email to get

Responses

200

OK

application/json

404

A email with the specified ID was not found.

get

/email/{id}

HTTPcURLJavaScriptPython

GET /email/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "emailAddress": "text",
  "description": "text",
  "metadata": {},
  "elementType": "text",
  "elementId": "text",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-02-14",
  "updated_at": "2026-02-14"
}

patch

Update an existing email

Authorizations

BasicOAuth

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Path parameters

idstringRequired

Unique ID of the email to get

Header parameters

if-unmodified-sincestringOptional

last update time to make sure request data is not outdated and does not overwrite any data

Responses

200

OK

application/json

404

A email with the specified ID was not found.

patch

/email/{id}

HTTPcURLJavaScriptPython

PATCH /email/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "emailAddress": "text",
  "description": "text",
  "metadata": {},
  "elementType": "text",
  "elementId": "text",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-02-14",
  "updated_at": "2026-02-14"
}