Create EmailAccount

POST

api

crm

emailaccounts

Create EmailAccount

curl --request POST \
  --url https://spaces.nexudus.com/api/crm/emailaccounts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "DisplayName": "<string>",
  "EmailAddress": "<string>",
  "IncomingServer": "<string>",
  "IncomingServerType": 123,
  "IncomingServerPort": 123,
  "IncomingServerUsername": "<string>",
  "DeleteMessageSettings": 123,
  "OutgoingServer": "<string>",
  "OutgoingServerPort": 123,
  "OutgoingServerUsername": "<string>",
  "LastMessageId": 123,
  "ErrorCount": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/crm/emailaccounts"

payload = {
    "BusinessId": 123,
    "DisplayName": "<string>",
    "EmailAddress": "<string>",
    "IncomingServer": "<string>",
    "IncomingServerType": 123,
    "IncomingServerPort": 123,
    "IncomingServerUsername": "<string>",
    "DeleteMessageSettings": 123,
    "OutgoingServer": "<string>",
    "OutgoingServerPort": 123,
    "OutgoingServerUsername": "<string>",
    "LastMessageId": 123,
    "ErrorCount": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    DisplayName: '<string>',
    EmailAddress: '<string>',
    IncomingServer: '<string>',
    IncomingServerType: 123,
    IncomingServerPort: 123,
    IncomingServerUsername: '<string>',
    DeleteMessageSettings: 123,
    OutgoingServer: '<string>',
    OutgoingServerPort: 123,
    OutgoingServerUsername: '<string>',
    LastMessageId: 123,
    ErrorCount: 123
  })
};

fetch('https://spaces.nexudus.com/api/crm/emailaccounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

An EmailAccount configures an incoming email connection (IMAP) used to receive messages for the help desk or other automated workflows. Each account specifies server connection details, credentials, and message handling policies.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the EmailAccount-Create role.

Enums

eEmailServerType — IncomingServerType values

Value	Name
1	Imap

eMessageDeletionPolicy — DeleteMessageSettings values

Value	Name
1	DontDelete
2	DeleteOnReceive
3	DeleteWhenDeleting

Request Body

Required Fields

integer

required

ID of the business linked to this record.

string

required

The display name value for this email account.

string

required

The email address value for this email account.

string

required

The incoming server value for this email account.

integer

required

The incoming server type value for this email account.

integer

required

The incoming server port value for this email account.

string

required

The incoming server username value for this email account.

integer

required

The delete message settings value for this email account.

string

required

The outgoing server value for this email account.

integer

required

The outgoing server port value for this email account.

string

required

The outgoing server username value for this email account.

integer

required

ID of the last message associated with this record.

integer

required

The error count value for this email account.

Optional Fields

boolean

Whether this email account is currently active.

boolean

Whether send notification on new messages is enabled.

string

The notification email address value for this email account.

boolean

Whether incoming server ssl is enabled.

boolean

Whether outgoing server ssl is enabled.

string

The reply to email value for this email account.

string

Date/time value for last check time.

string

The google access token value for this email account.

string

The office365 access token value for this email account.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/crm/emailaccounts" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "DisplayName": "",
    "EmailAddress": "",
    "IncomingServer": "",
    "IncomingServerType": 0,
    "IncomingServerPort": 0,
    "IncomingServerUsername": "",
    "DeleteMessageSettings": 0,
    "OutgoingServer": "",
    "OutgoingServerPort": 0,
    "OutgoingServerUsername": "",
    "LastMessageId": 0,
    "ErrorCount": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/emailaccounts',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      DisplayName: '',
      EmailAddress: '',
      IncomingServer: '',
      IncomingServerType: 0,
      IncomingServerPort: 0,
      IncomingServerUsername: '',
      DeleteMessageSettings: 0,
      OutgoingServer: '',
      OutgoingServerPort: 0,
      OutgoingServerUsername: '',
      LastMessageId: 0,
      ErrorCount: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/crm/emailaccounts',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'DisplayName': '',
        'EmailAddress': '',
        'IncomingServer': '',
        'IncomingServerType': 0,
        'IncomingServerPort': 0,
        'IncomingServerUsername': '',
        'DeleteMessageSettings': 0,
        'OutgoingServer': '',
        'OutgoingServerPort': 0,
        'OutgoingServerUsername': '',
        'LastMessageId': 0,
        'ErrorCount': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the emailaccount was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "EmailAccount was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "DisplayName: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "DisplayName"
    }
  ],
  "WasSuccessful": false
}

Update EmailAccountUpdate an existing EmailAccount record.

Create EmailAccount

curl --request POST \
  --url https://spaces.nexudus.com/api/crm/emailaccounts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "DisplayName": "<string>",
  "EmailAddress": "<string>",
  "IncomingServer": "<string>",
  "IncomingServerType": 123,
  "IncomingServerPort": 123,
  "IncomingServerUsername": "<string>",
  "DeleteMessageSettings": 123,
  "OutgoingServer": "<string>",
  "OutgoingServerPort": 123,
  "OutgoingServerUsername": "<string>",
  "LastMessageId": 123,
  "ErrorCount": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/crm/emailaccounts"

payload = {
    "BusinessId": 123,
    "DisplayName": "<string>",
    "EmailAddress": "<string>",
    "IncomingServer": "<string>",
    "IncomingServerType": 123,
    "IncomingServerPort": 123,
    "IncomingServerUsername": "<string>",
    "DeleteMessageSettings": 123,
    "OutgoingServer": "<string>",
    "OutgoingServerPort": 123,
    "OutgoingServerUsername": "<string>",
    "LastMessageId": 123,
    "ErrorCount": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    DisplayName: '<string>',
    EmailAddress: '<string>',
    IncomingServer: '<string>',
    IncomingServerType: 123,
    IncomingServerPort: 123,
    IncomingServerUsername: '<string>',
    DeleteMessageSettings: 123,
    OutgoingServer: '<string>',
    OutgoingServerPort: 123,
    OutgoingServerUsername: '<string>',
    LastMessageId: 123,
    ErrorCount: 123
  })
};

fetch('https://spaces.nexudus.com/api/crm/emailaccounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400