Skip to main content
PUT
/
api
/
crm
/
emailaccounts
Update EmailAccount
curl --request PUT \
  --url https://spaces.nexudus.com/api/crm/emailaccounts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "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
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt

Use this file to discover all available pages before exploring further.

Updates an existing EmailAccount record. You must include the Id of the record to update along with all required fields.

​
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-Edit role.

​
Request Body

​
Required Fields

​
Id
integer
required
The Id of the EmailAccount record to update.
​
BusinessId
integer
required
Business Id.
​
DisplayName
string
required
Display Name.
​
EmailAddress
string
required
Email Address.
​
IncomingServer
string
required
Incoming Server.
​
IncomingServerType
integer
required
Incoming Server Type.
​
IncomingServerPort
integer
required
Incoming Server Port.
​
IncomingServerUsername
string
required
Incoming Server Username.
​
DeleteMessageSettings
integer
required
Delete Message Settings.
​
OutgoingServer
string
required
Outgoing Server.
​
OutgoingServerPort
integer
required
Outgoing Server Port.
​
OutgoingServerUsername
string
required
Outgoing Server Username.
​
LastMessageId
integer
required
Last Message Id.
​
ErrorCount
integer
required
Error Count.

​
Optional Fields

​
Active
boolean
Active.
​
SendNotificationOnNewMessages
boolean
Send Notification On New Messages.
​
NotificationEmailAddress
string
Notification Email Address.
​
IncomingServerSSL
boolean
Incoming Server SSL.
​
OutgoingServerSSL
boolean
Outgoing Server SSL.
​
ReplyToEmail
string
Reply To Email.
​
LastCheckTime
string
Last Check Time.
​
GoogleAccessToken
string
Google Access Token.
​
Office365AccessToken
string
Office365Access Token.

​
Code Examples

curl -X PUT \
  "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,
    "Id": 87654321
}'

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the update.
​
Value
object
Contains the Id of the updated record.
​
WasSuccessful
boolean
true if the emailaccount was updated successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "EmailAccount was successfully updated.",
  "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

​
Message
string
A summary of the validation error(s), in the format PropertyName: error message.
​
Value
any
null on validation failure.
​
Errors
object[]
Array of validation errors.
​
WasSuccessful
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
}