Skip to main content
PUT
Error

Authorizations

x-cdata-authtoken
string
header
required

Body

application/json

The profile entity to update.

AllowAuthTokenInURL
boolean

When set to True, enables authentication tokens to be passed as URL query parameters instead of requiring header-based authentication.

AutoTaskType
string

The type of automated maintenance task to run.

AutoTaskInterval
string

Defines how frequently (in days) the automated task executes.

CleanupReceiveFolder
boolean

Include files in Receive folders in cleanup operations.

CleanupSendFolder
boolean

Include files in Send folders in cleanup operations.

CleanupSentFolder
boolean

Include files in Sent folders in cleanup operations.

CleanupTransactions
boolean

Include transactions in cleanup operations.

corsallowcredentials
boolean

Allows cross-origin requests to include credentials such as cookies or authentication headers.

corsallowheaders
string

Comma-separated list of HTTP headers that are permitted in cross-origin requests.

corsmaxage
string

Specifies how long (in seconds) browsers can cache Cross-Origin Resource Sharing (CORS) preflight request results before requiring a new preflight check.

corsallowalldomains
boolean

Enables all domains to make cross-origin requests to the API without restriction (use with caution as this removes CORS security protections).

enablecors
boolean

Enables CORS to allow web applications from different domains to access the API.

MaxFilesPerPort
string

The maximum number of files sent by each thread assigned to the connector.

MaxWorkersPerPort
string

The number of worker threads allocated to the connector for parallel processing.

NotifyEmail
string

Send an email to the specified email addresses when an error is encountered.

NotifyEmailFrom
string

The email address used as the sender of notification emails.

NotifyEmailTo
string

A comma-separated list of notification email recipients.

NotifyEmailSubject
string

The notification email subject.

NotifyWindowsEvent
boolean

Whether to write error messages to the Windows Application Event Log.

NotifyStopStart
boolean

Whether to log when the application starts and stops in the event log.

ProcessParallel
boolean

Enables concurrent processing of multiple files instead of sequential processing.

SMTPServer
string

The host name or IP address of your SMTP server.

SMTPUser
string

The username to authenticate to your SMTP server.

SMTPPassword
string

The password to authenticate to your SMTP server.

SMTPPort
string

The port of your SMTP server.

SMTPSSLMode
string

The SSL mode of your SMTP server.

SendStatusReport
boolean

Whether to send a status report to the NotifyEmailTo email address(es).

SendReportInterval
string

The interval at which status report are sent to the email address.

TrustedIp
string

Commas-separated list of IP addresses or ranges that are trusted. Access to Arc is allowed from these addresses and ranges.

BlockedIp
string

Commas-separated list of IP addresses or ranges that are blocked. Access to Arc is prohibited from these addresses and ranges.

uitimeformat
string

The time format display preference.

Workerpool
string

The size of the thread pool available for processing tasks across all connectors.

Other
string

The list of properties above is not comprehensive. You can use the API to set any profile property not listed above, using the same name/value format. All available profile default properties are returned in a GET request. Profile-specific settings, such as AS2 or SFTP, are prefixed like this: as2:loglevel or sftp:loglevel. You do not need to include an Other property when using additional settings that are not listed here.

Response