updateSettings

POST
1
/{orgId}/{itemId}/settings

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

Query parameters

NameTypeRequired

token

string

Body parameters

Supported content types: application/json

NameTypeRequiredDescription

An object defining the settings

body

An object defining the settings

Path parameters

NameTypeRequired

orgId

string

itemId

string

Examples

Request

1
2
3
4
5
6
# 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}' \
  --data '{"settings":[{"propName":"string","value":"string","encrypted":true}]}'

Response

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.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close