API Reference

Updates Jamf Pro SMTP Server information

put
https://{region}.api.jamfcloud.com/pro/v2/smtp-server

Updates Jamf Pro SMTP Server information. If requiresAuthentication is set to true, a username and password must be provided

Required Permissions: smtp-server:update

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The OAuth state that was last used to authorize a Google Mail account. This is only required when the authentication type is Google Mail and new accounts are being added.

Body Params

SMTP Server to update

boolean
required
Defaults to false
string
enum
required

The authentication type to use for the SMTP server. Note that NONE and BASIC may not be available depending on the server configuration. Check allowedAuthenticationTypes for the list of currently supported values.

Allowed:
connectionSettings
object
senderSettings
object
required
basicAuthCredentials
object
graphApiCredentials
object
googleMailCredentials
object
Headers
uuid
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The tenant UUID identifier. Send it to address tenant scope. This API is also published at environment scope — send that scope's header instead. Send exactly one scope header per request.

uuid
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The environment UUID identifier. Send it to address environment scope. This API is also published at tenant scope — send that scope's header instead. Send exactly one scope header per request.

Responses

Updated 15 days ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 15 days ago

Did this page help you?