Workato docs Return to Workato
Edit this page
GitHub (opens new window)
  • Introduction
  • Getting started
  • Product Updates (opens new window)
  • Building recipes

  • Running recipes

  • Troubleshooting

  • Data types and formulas

  • Tools
  • Files and attachments

  • Batch processing

  • Teams and collaboration
  • People Task by Workato
  • Recipe lifecycle management
  • On-prem connectivity
  • Key features
  • Workbot for Slack
  • Workbot for MS Teams
  • Workbot for Workplace
  • API Platform
  • Connectors

  • Universal connectors
  • Community connectors
  • Connector SDK
  • Custom OAuth profiles
  • Workato API
  • Security
  • Training & Certification
  • Contact us

# Account properties

Use the endpoints below to manage account properties programmatically.

All API endpoints listed here requires oem_vendor privilege. Talk to your Workato representative to enable this privilege in your account.

# Quick reference

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

# List properties by prefix

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

GET /api/managed_users/:managed_user_id/properties

# URL Parameters

Name Type Description
managed_user_id string
required
OEM customer Account ID/External ID.
External id should be prefixed with a E(eg: EA2300) and the resulting id should be URL encoded.
prefix string
required
Return properties with the given prefix. E.g: salesforce_sync..

# Sample request

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

# Response

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

# Upsert property

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

POST /api/managed_users/:managed_user_id/properties

# Parameters

Name Type Description
managed_user_id string
required
OEM customer Account ID/External ID.
External id should be prefixed with a E(eg: 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 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \
      -d '{ "properties": { "zendesk.object": "Ticket", "zendesk.key": "ticket_id" }}'

# Response

{
  "success": true
}

← Roles IP whitelists →

Didn’t find what you are looking for?
Search our resource library View getting started guides, tutorials, training videos, webinars and FAQ Ask our community View questions and answers from other users and Workato experts. File a support ticket File a support ticket for critical issues that require a higher level of support.
Privacy Terms (844) 469-6752 Workato 2021