Embedded APIResourcesManage customers

Update customer

This endpoint updates the information for an existing Embedded customer's account. You can use this API endpoint to update your test and production environments and specific parameters like `external_id`, `error_notification_emails` by passing the `environments` key in the request payload. - For customers in task-based plans, use this endpoint to update the task limit override and make a one-time adjustment. - For partners using Embedded, use this endpoint to update the custom origin URL of a specific customer. **PROPERTIES:** Properties update only if the payload includes the property. You can clear a property’s value by setting it to `null` in the payload.

Path parameters

managed_user_idstringRequired

Embedded customer ID (external ID). The External ID must be URL encoded and prefixed with an E. For example, EA2300.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringOptional
Updated name of the customer workspace. Displays in customer profiles, collaborator views, and audit logs.
notification_emailstringOptional
Email for error and administrative notifications.
admin_notification_emailsstringOptional
Emails for administrative notifications. This property overrides what you input in notification email property.
error_notification_emailsstringOptional

Emails for error notifications, overriding the value in the notification_email property. This property applies specifically to the dev environment and differs from environments error_notification_emails.

in_trialbooleanOptional

Downgrade or upgrade the user to/from a free plan and subscription plan.

task_limit_adjustmentintegerOptional

Task limit adjustment for current accounting period. Only valid for task-based plans. This adjustment doesn’t apply to subsequent periods. Make a negative adjustment by adding ”-” (for example: “-5000”).

custom_task_limitintegerOptional

Overrides the current plan limit. Limit override must result in a value greater than the current task usage.

current_billing_period_startstringOptional

Set the current billing start date. The date should be provided in ISO 8601 format, for example, 2021-12-31.

env_settingslist of stringsOptional
Environment external identifiers.
external_idstringOptional

External identifier for the Embedded customer. This field applies specifically to the dev environment and differs from environments[external_id].

origin_urlstringOptional

Applies to Embedded account customers. Provide a value if the embedded iframe is hosted on a custom domain or non-default origin page. For example, customer specific custom domains. Defaults to the origin configured at the account level.

frame_ancestorsstringOptional

Provide one or more comma-separated frame ancestors. These URLs are used in the Content-Security-Policy HTTP header to allow rendering of Workato IFrames.

plan_idstringOptional
Plan ID. Default plan is used when value is not provided.
timeout_idstringOptional
Timeout in seconds. The following values are accepted: <br/> - `900` (15 minutes) <br/> - `1800` (30 minutes) <br/> - `2700` (45 minutes) <br/> - `14400` (4 hours) <br/> - `28800` (8 hours) <br/> - `43200` (12 hours) <br/> - `86400` (1 day) <br/> - `172800` (2 days) <br/> - `259200` (3 days) <br/> - `604800` (7 days) <br/> - `1209600` (14 days)
time_zoneenumOptional
The name of the timezone of the user. Defaults to PST if not specified.
whitelisted_appslist of stringsOptional
List of approved applications.
full_embeddingbooleanOptional

When set to true end users are sent to the customer account’s origin_url. Set to false to turn off the fully embedded redirect process at the customer account level. If you do not specify this value it defaults to null and inherits this value (true or false) from the Embedded partner’s admin settings.

Response

Success response
idinteger or null
Unique identifier of the organization
external_idstring or null
External identifier of the organization
namestring or null
Name of the organization
environmentslist of objects or null
List of environments associated with the organization
notification_emailstring or null
Email addresses for notifications
full_embeddingboolean or null
Indicates if full embedding is enabled
admin_notification_emailsstring or null
Emails for admin notifications
error_notification_emailsstring or null
Emails for error notifications
plan_idstring or null
Plan ID associated with the organization
origin_urlstring or null
Origin URL of the organization
trialboolean or null
Indicates if the organization is on trial
in_trialboolean or null
Indicates if the organization is currently in a trial
whitelisted_appslist of strings or null
List of whitelisted applications
frame_ancestorsstring or null
Frame ancestors configuration
created_atstring or null
Timestamp of creation
updated_atstring or null
Timestamp of last update
time_zonestring or null
Time zone of the organization
team_namestring or null
Team name associated with the organization
auth_settingsobject or null
current_billing_period_startstring or null
Billing period start date
current_billing_period_endstring or null
Billing period end date
task_countinteger or null
Number of tasks associated with the organization
active_connection_limitinteger or null
Limit of active connections
active_connection_countinteger or null
Current active connections
active_recipe_countinteger or null
Number of active recipes
billing_start_datestring or null
Start date of billing

Errors