Environment properties

Use the following endpoints to manage Environments programmatically:

Rate limits

Environment property resources have the following rate limits:

Type	Resource	Limit
GET	List properties by prefix: /api/managed_users/:managed_user_id /properties	1,000 requests per minute
All	All other Environment properties endpoints	60 requests per minute

Quick reference

Type	Resource	Description
GET	/api/managed_users/:managed_user_id/properties	Returns a list of environment properties belonging to a customer that matches a prefix.
POST	/api/managed_users/:managed_user_id/properties	Upserts environment properties to a customer workspace.

List properties by prefix

Returns a list of environment properties belonging to a customer that matches a prefix. For example, if the prefix provided is salesforce_sync., any account property with a name beginning with 'salesforce_sync.' is returned.

GET /api/managed_users/:managed_user_id/properties

URL Parameters

Name	Type	Description
managed_user_id	string required	Embedded customer ID/external ID. External ID must be prefixed with an E (for example, EA2300) and the resulting ID should be URL encoded.
prefix	string required	Return properties with the given prefix. For example: salesforce_sync..

Sample request

curl  -X GET 'https://www.workato.com/api/managed_users/19029/properties?prefix=salesforce_sync.' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \

Response

{
    "result": {
        "salesforce_sync.object_name": "Account",
        "salesforce_sync.object_field": "Id"
    }
}

Upsert property

Upserts environment properties to a customer workspace. Matches by the names of the properties provided in the request.

POST /api/managed_users/:managed_user_id/properties

PROPERTY LIMITS

Environment properties have the following limits:

Description	Limit
Maximum number of environment properties per environment	1,000
Maximum length of an environment property name	100 characters
Maximum length of an environment property value	1,024 characters

Parameters

Name	Type	Description
managed_user_id	string required	Embedded customer ID/external ID. External ID must be prefixed with an E (for example, EA2300) and the resulting ID should be URL encoded.

Payload

Name	Type	Description
properties	Hash required	Contains the names and values of the properties to upsert.

Sample request

curl  -X POST https://www.workato.com/api/managed_users/19029/properties \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{ "properties": { "zendesk.object": "Ticket", "zendesk.key": "ticket_id" }}'

Response

{
  "success": true
}