updateSettings

Click to copy

Update Settings

Add or update one or more settings configured for the workflow system. The adminAdvanced privilege is required.

Note: Email settings are optional for ArcGIS Online.

Settings Parameters:

ParameterDescriptionData Type
smtpDefaultSenderDisplayNameOptional . The display name for email notifications.String
smtpDefaultSenderEmailOptional. The email used to send notifications.String
smtpUsernameOptional. Username for the SMTP server .String
smtpPasswordOptional. Password for the SMTP server.String
smtpPortOptional. Port used by the SMTP server.String
smtpProtocolOptional. Protocol used by the SMTP server.String
smtpServerOptional. The server to be used for SMTP.String

Body parameter

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
{
  "settings": [
    {
      "propName": "string",
      "value": "string",
      "encrypted": true
    }
  ]
}

Query parameters

NameTypeRequired

token

string

Path parameters

NameTypeRequired

orgId

string

itemId

string

Examples

Request

Use dark colors for code blocksCopy
1
2
3
4
5
# You can also use wget
curl -X POST /{orgId}/{itemId}/settings \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Response

200 Response

Use dark colors for code blocksCopy
1
2
3
{
  "success": true
}
StatusMeaningDescriptionSchema

200

OK

success

Success

400

Bad Request

invalid object

WorkflowJsonExceptionDTO

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.