Update an Email Integration Partially

Update some settings of an email integration. Only the properties sent change; every property left out keeps its stored value, and so do the stored passwords, client secrets and private keys unless a new value is sent. The answer is 200 with the integration read back, in the shape of Get an Email Integration; credentials are never returned. lastModifiedDate is set by the gateway at the time of the request. Concurrent updates are not detected - the last write wins, for the whole record. A patch sends back every setting as it read it, so it undoes a change (a password, or defaultOutgoing given to another integration) saved by someone else in between. Changing an OAuth 2.0 integration's protocol to a non-OAuth 2.0 one clears its OAuth 2.0 settings in SysAid, and OAuth 2.0 settings patched on an integration that is not OAuth 2.0 are not kept. Setting defaultOutgoing true makes this the only default outgoing account; setting it false on the default one leaves none marked, and SysAid then sends from the lowest-id integration with outgoing enabled. While SysAid blocks basic authentication for Microsoft (the disable-ms-basic-auth feature flag), an integration whose outgoing host or incoming server is on office365.com, outlook.com or exchange.microsoft.com without OAuth 2.0 is refused with 400, also when the patch does not touch the host. A text value that sanitizing makes longer than SysAid can store is refused with 400 rather than cut. An id SysAid does not hold is answered 404. Requires a SysAid Admin session; SysAid administrators only. A request without a valid session is answered 401, and a signed-in user who is not a SysAid administrator is answered 403. A SysAid failure is answered 500 or 502; when it happens after SysAid stored the change, read the integration before retrying.

Path Params
integer
required
1 to 2147483647

The unique identifier of the email integration in SysAid.

Body Params

The settings to change, at least one; the same properties, rules and sanitizing as Create an Email Integration, none of them required. Every property left out keeps its stored value. A password or client secret left out keeps the stored one; there is no way to clear one here. Properties not listed, such as id or lastModifiedDate, are ignored, and a body with none of the listed properties is rejected with 400.

string
length between 1 and 120

The display name of the email integration.

string
length ≤ 120

The purpose of the email integration.

string
length between 1 and 255

The email address of the integration, the From address of outgoing mail and the monitored address of incoming mail.

boolean

Whether this becomes the default outgoing (send-from) email account. When true, every other integration stops being the default.

boolean

Whether SysAid sends email through this integration.

string
enum

The outgoing mail protocol. Only smtp is supported.

Allowed:
string
length between 1 and 255
^[A-Za-z0-9_]([A-Za-z0-9_-]*[A-Za-z0-9_])?(\.[A-Za-z0-9_]([A-Za-z0-9_-]*[A-Za-z0-9_])?)*$

The host name or IPv4 address of the SMTP server, without a port (the port is outgoingPort). IPv6 addresses are not supported.

integer
1 to 65535

The port of the SMTP server.

integer
enum

The encryption of the SMTP connection: 0 none, 1 SSL, 2 TLS, 3 TLS 1.2.

Allowed:
string
length ≤ 255

The user name for the SMTP server. Sent to SysAid unchanged.

password
length between 1 and 160

The password for the SMTP server. Write-only; never returned or logged.

string
length ≤ 255

The character encoding of outgoing email.

string
enum

The content type of outgoing email bodies.

Allowed:
string
enum

The OAuth 2.0 provider of the outgoing direction. SysAid signs in with OAuth 2.0 only for an integration whose protocol is OAuth 2.0, which this operation does not set, so the OAuth 2.0 settings are stored but not used until the integration is switched to OAuth 2.0 in SysAid.

Allowed:
string
length ≤ 255

The Azure AD tenant ID of the outgoing direction, for the microsoft provider.

string
length ≤ 255

The OAuth 2.0 client (application) ID of the outgoing direction.

password
length between 1 and 160

The OAuth 2.0 client secret of the outgoing direction. Write-only; never returned or logged.

boolean

Whether SysAid checks the mailbox of this integration for incoming email.

string
enum

The incoming mail protocol.

Allowed:
string
length between 1 and 255
^[A-Za-z0-9_]([A-Za-z0-9_-]*[A-Za-z0-9_])?(\.[A-Za-z0-9_]([A-Za-z0-9_-]*[A-Za-z0-9_])?)*(:([1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))?$

The host name or IPv4 address of the incoming mail server, with an optional :port, for example imap.company.com:993. IPv6 addresses are not supported.

integer
enum

The encryption of the incoming connection: 0 none, 1 SSL, 2 TLS, 3 TLS 1.2.

Allowed:
string
length ≤ 255

The user name for the incoming mail server. Sent to SysAid unchanged.

password
length between 1 and 160

The password for the incoming mail server. Write-only; never returned or logged.

string
enum

The OAuth 2.0 provider of the incoming direction. SysAid keeps the incoming OAuth 2.0 settings only for an incoming protocol of OAuth 2.0, which this operation does not set, so with imap or pop3 SysAid does not store them.

Allowed:
string
length ≤ 255

The Azure AD tenant ID of the incoming direction, for the microsoft provider.

string
length ≤ 255

The OAuth 2.0 client (application) ID of the incoming direction.

password
length between 1 and 160

The OAuth 2.0 client secret of the incoming direction. Write-only; never returned or logged.

boolean

Whether the service record ID is searched for in the subject from its end towards its start.

boolean

Whether the service record ID is also searched for in the body of an incoming email.

integer
0 to 2147483647

The ID of the status set on an existing service record when a new email arrives for it; 0 leaves the status unchanged.

string
length ≤ 255

A comma-separated list of status IDs. Incoming emails for a service record in one of these statuses are ignored.

string
length ≤ 4000

A regular expression. Incoming emails whose subject matches it are ignored.

string
length ≤ 1000

A comma-separated list of sender addresses whose incoming emails are ignored.

string
length ≤ 1000

A comma-separated list of sender addresses; when set, only incoming emails from them are processed.

string
length ≤ 255

The address ignored incoming emails are forwarded to.

string
length ≤ 255

The address that receives a copy of every processed incoming email.

boolean

Whether duplicate incoming emails are deleted automatically.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json