Salesforce

Overview

• Salesforce

  General

  For information on specific errors returned from the Salesforce API, see the Salesforce API docs. You can also check the status of the Salesforce API for possible service outages.

  If you receive a generic error (such as “Bad Request”) from Salesforce, look for the actual error message in the object that is returned by the API.

  Authentication

  If you have trouble connecting to your Salesforce account, reauthorize your account in Settings –> Accounts. Or, delete the account and add it again.

  To see your available Salesforce accounts, navigate to Settings –> Accounts.

  We are constantly aggregating more data about errors, so if this article doesn’t help solve your problem, check back soon.

Events

• Field Updated

  Start a Flow when an existing record is updated.

  Notes

  • Field Updated does not monitor the Owner_ID field on any record type because Salesforce API does not record ID changes in its system.
  • Field Updated can only monitor the most recent change made on a field.
  • Field Updated can only monitor fields that are history-enabled.

  You must be a Salesforce Admin to enable history:

  1. In your Salesforce instance, navigate to Setup > Build.
  2. Click Customize.
  3. Select the record type that you want to monitor, and then click Add a Custom Field.
  4. Click Set History Tracking.

  Options

  • Record Type (drop-down list): dynamically generated list of record types, including custom objects
  • Field (drop-down list): writable fields, including custom fields in Salesforce, generated from your Record Type selection

  Output

  • Record

    • A dynamically generated list of readable fields from your Salesforce Account

  • Field History

    • Old Value (text): value of the field before it was changed
    • New Value (text): current value of the field

  • Context

    • Execution ID (text): unique identifier of the execution that updated the record

• New Record

  Start a Flow when a new record is created in Salesforce. You can indicate which type of record will trigger the Flow and which record fields are required.

  Options

  • Record Type (drop-down): dynamically generated list of record types, including custom objects

  Output

  The record fields are dynamically generated from your Record Type selection.

  • Record
    • A dynamically generated list of fields from your Salesforce account
  • Context
    • Execution ID (text): unique identifier for the execution of the new record

• Outbound Message

  Start a Flow when a Salesforce Outbound Message is triggered.

  This connector requires additional setup in your Salesforce instance:

  1. In Salesforce, open the Setup page.
  2. In the Quick Find/Search field, enter Workflow Rules.
  3. On the Workflow Rules page, click New Rule.
  4. Select an object type, and then click Next.
  5. Enter a rule name, evaluation criteria, and rule criteria.
  6. Click Save & Next.
  7. Click Done.
  8. On the Workflow Rules page, find the rule that you created, and then click Edit.
  9. In the Add Workflow Action drop-down menu, select New Outbound Message.
  10. Enter a name, description, endpoint URL, and the fields you want to include in the new message. (Endpoint URL contains the URL provided on the Salesforce Outbound Message card in Azuqua. Set up a Flow beginning with the Outbound Message event card. Click the “</>” icon in the bottom right and copy the provided URL.
  11. Click Save.
  12. On the Workflow Rules page, find the rule you just created, and then click Activate.

  Options

  • Record Type (drop-down): dynamically generated list of record types, including custom objects

  Output

  Record fields are dependent on your Record Type selection.

  • Record
    • A dynamically generated list of fields from your Salesforce account
  • Context
    • Execution ID (text): unique identifier for the execution of the new record

• Record Deleted

  Start a Flow when a record of a specified type is deleted.

  Options

  • Record Type (drop-down list): dynamically generated list of record types, including custom objects

  Output

  • Record
    • Record ID (text): unique identifier for the deleted record in Salesforce
    • Time Deleted (date): timestamp when the record was deleted
  • Context
    • Execution ID (text): unique identifier for the deletion of record

• Record Updated

  Start a Flow when an existing Salesforce record is updated.

  Options

  • Record Type (drop-down): The type of record that you want to monitor for changes. This is a dynamically generated list that includes your org’s custom objects.

  Output

  • Record
    • Dynamic list of record fields from your Record Type selection. Choose the fields that you want to use in your Flow.
  • Context
    • Execution ID (text): unique identifier for the record update event

• Monitor

  Monitor Salesforce for new or updated records of a specified type.

  Note: Do not use the Test functionality on Salesforce monitors. Because records created in Salesforce are not immediately picked up by the API, monitors are set to a 15-minute delay. You can miss record changes if you test before the monitor runs.

  Options

  • Record type (dropdown): a dropdown of your available record types in Salesforce, including custom records

  Output Fields

  Output fields are dynamically generated from your record type selection. Custom fields are marked with _c. Standard fields are listed below.

  • ID (number): the unique identifier of the record that was created or updated in Salesforce
  • IsDeleted (boolean): true if the record has been deleted, false if it is still active
  • IsPrivate (boolean):  true if the record is private, false if it is public
  • Name (text): name of the record that was created or updated
  • CreatedDate (timestamp): timestamp when the record was created (UTC format, timezone of your Salesforce instance)

• Monitor Changed

  Monitor Salesforce for updated records of a specified type.

  Note: Do not use the Test functionality on Salesforce monitors. Because records created in Salesforce are not immediately picked up by the API, monitors are set to a 15-minute delay. You can miss record changes if you test before the monitor runs.

  Options

  • Record type (drop-down): a dropdown of your available record types in Salesforce, including custom records

  Output

  Output fields are dynamically generated from your record type selection. Custom fields are marked with _c. Standard fields are listed below.

  • ID (number): the unique identifier of the record that was updated in Salesforce
  • IsDeleted (boolean): true if the record has been deleted, false if it is still active
  • IsPrivate (boolean):  true if the record is private, false if it is public
  • Name (text): name of the record that was updated
  • CreatedDate (timestamp): timestamp when the record was created (UTC format, timezone of your Salesforce instance)

• Monitor New

  Monitor Salesforce for new records of a specified type.

  Note: Do not use the Test functionality on Salesforce monitors. Because records created in Salesforce are not immediately picked up by the API, monitors are set to a 15-minute delay. You can miss record changes if you test before the monitor runs.

  Options

  • Record type (drop-down): a dropdown of your available record types in Salesforce, including custom records

  Output

  Output fields are dynamically generated from your record type selection. Custom fields are marked with _c. Standard fields are listed below.

  • ID (number): the unique identifier of the record that was created in Salesforce
  • IsDeleted (boolean): true if the record has been deleted, false if it is still active
  • IsPrivate (boolean):  true if the record is private, false if it is public
  • Name (text): name of the record that was created
  • CreatedDate (timestamp): timestamp when the record was created (UTC format, timezone of your Salesforce instance)

• UpdatedField

  Updated Field

  Monitors Salesforce for when one field within one record is changed.

  Note: this monitor can’t monitor for the field “Owner_ID” on ANY record type. Salesforce’s API does not record when or if owner ID is changed within the system, and therefore doesn’t tell the monitor to fire.

  Options

  • Record type (dropdown): a dropdown of your available record types in Salesforce, including custom records
  • Field (dropdown): a dropdown of your available fields to monitor within the record you chose. NOTE: The field you choose must be history enabled within Salesforce. To check if a field is history enabled or to make it so, first go to ‘Setup’ within your Salesforce instance. Click ‘Customize’ under Build and select the record type you will be monitoring. Select ‘Add a custom field’. Click ‘Set History Tracking’. (You will need to be an administrator to make any changes). NOTE: Although it will appear in your options dropdown, this monitor will not trigger if you select the field “Owner_ID”.
  • Is this a lookup field? (yes/no): Lookup fields can be identified in Salesforce as the fields with the looking glass next to them. Lookup fields trigger this monitor twice, and so they are handled in a special way compared with any other type of field. NOTE: if you select “yes” on this option, it will not pick up all records if you try to bulk update this record type and field in Salesforce. It only picks up one record every second, so in a bulk update situation only one record will be passed through the Flow out of the entire set of records you update. Bulk updating records will work for non-lookup fields.

  Output Fields

  History

  • OldValue (text): The value of the field before it was changed

  Fields

  The output fields are dynamically generated and will reflect the fields that are available in your Salesforce instance for that record type. NOTE: Any field with _c at the end is a custom field. Here are some standard fields that you may see as outputs on your monitor:

  • Id (number): the unique identifier in Salesforce of the record on which the field was updated. NOTE: This field must be selected and showing on your card in order for your Flow to work.
  • IsDeleted_ (boolean):_ returns true if the record has been deleted and false if it is still active
  • IsPrivate_ (boolean):_ returns true if the record is private and false if it is public
  • Name_ (text):_ name of the record that was updated
  • CreatedDate_ (timestamp):_ the day and time at which the record was created given in UTC format within the timezone of your Salesforce instance.

Actions

• Activate User

  Activate a Salesforce user.

  Field type is text.

  Input

  • User
    • User ID: unique identifier of the Salesforce user

  Output

  • This action has no output fields

• Build Record Object

  Build a single Record Object for use with the Create Multiple Records action.

  Options

  • Record Type (drop-down list): dynamically generated list of record types, including custom objects

  Input

  • Record: dynamically generated list of input fields

  Output

  • Record Object (object): generated Salesforce object, based on the input fields

• Create Multiple Records

  Create multiple records in Salesforce.

  This action works well with the Build Record Object actions and the List > Construct function:

  1. Add a Build Record Object action to your Flow.
  2. Add a List > Construct function.
  3. Drag the output from your Build Record Object cards into the input fields of the List > Construct card.

  Input

  • Record Objects (list): list of objects that contain all the records to be created inside Salesforce

  Output

  • New Records
    • Record IDs (list): unique identifiers for the new records (identified by their JSON)

• Create Record

  Create a new record in Salesforce.

  Options

  • Record Type (drop-down list): dynamically generated list of record types from your Salesforce account

  Input

  Input fields are dynamically generated from your record type selection. Custom fields are marked with _c.

  Note: For multi-select picklists, enter custom fields as a semicolon-delimited list of text (for example, Labradoodle;Corgi;Bernese Mountain Dog). Try pairing this with a Read Picklist Values action.

  Output

  • Record ID (text): unique identifier for the new record in Salesforce

• Create User

  Create a new user in Salesforce.

  Unless otherwise indicated, field types are text.

  Input

  • User
    • First Name: first name of user
    • Last Name: last name of user
    • Username: user’s unique login, in the form of an email address
    • Email: email address of user
    • Profile Name: user’s base-level permissions in Salesforce
    • Role Name: user’s position in the organization
    • Alias: short name to identify the user on pages where the entire name does not fit (if no value is provided, alias is generated based on the Username, trimmed to eight characters)
    • Nickname: name used to identify user in a community
    • Title: user’s job title
    • Email Encoding (drop-down): character set and encoding for outbound email sent by user, defaulted to Unicode (UTF-8)
    • Locale: user’s country or geographic region, defaulted to en_US (locales supported by Salesforce can be found here)
    • Language (drop-down): user’s primary language
    • Mobile Phone: user’s cellular or mobile phone number
    • Phone: user’s phone number
    • Street: user’s street address
    • City: city portion of user’s address
    • State/Province: state or province portion of user’s address
    • Zip/Postal Code: zip code or postal code portion of user’s address
    • Employee Number: unique identification number for the user
    • Company Name: name of the user’s company
    • Division: division of the company (for example, PC Sales Group)
    • Department: department or group in the company (for example, Customer Support)
    • Manager ID: unique identifier of user’s manager
    • Permission Set Names (collection): array of permission set names you can grant to the user
    • Public Group Names (collection): array of public group names you can assign the user to
    • Feature License Names (collection): array of feature licenses you can grant to the user (feature licenses provide access to features not included in the user license)
    • Time Zone (drop-down): primary time zone in which the user works, defaulted to (GMT-07:00) Pacific Daylight Time (America/Los_Angeles)
    • Dynamically generated custom fields

  Output

  • User
    • User ID: unique identifier of the user

• Custom API Action

  Make a custom, authenticated HTTP call to the Salesforce API.

  Options

  • Request Type (drop-down): one of five supported HTTP request methods (sometimes called verbs) in custom API calls:
    • GET retrieves data from a web server based on your parameters. GET requests a representation of the specified resource. If successful, GET will receive a 200 OK response message with the requested content. Refer to additional documentation here.
    • POST sends data to a web server based on your parameters. POST requests include actions like uploading a file. Multiple POSTs may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POSTs. If a POST is successful, you will receive a 200 OK response message. Refer to additional documentation here.
    • PUT sends data to a location in the web server based on your parameters. PUT requests include actions like uploading a file. The difference between a PUT and POST is that PUT is idempotent, meaning that the result of a single successful PUT is the same as many identical PUT’s. If a PUT is successful, you will receive a 200 response message (usually 201 or 204). Refer to additional documentation here.
    • PATCH applies partial modifications to a resource on a web server based on your parameters. PATCH is not idempotent, meaning that multiple PATCHs could have unintended consequences. If a PUT is successful, you will receive a 200 response message (usually 204). Refer to additional documentation here.
    • DELETE deletes the specified resource from the web server based on your parameters (if the resource exists). If a DELETE is successful, you will receive a 200 OK response message. Refer to additional documentation here.

  Input Data

  • Relative URL (text): address on the web server you are attempting to interact with. Relative URL means that you don’t have to explicitly specify the protocol at the beginning of the URL (such as “http://“). This suggests to the web server that the interaction is occurring on the server (in this instance).

    Example: /user/me

  • Query (object or text): JSON object that determines the action taken at the URL

    Example: {"name":"something-urgent"}

  • Headers (object): JSON object that determines the content type of the request. This will usually be a replica of the example below.

    Example: {"Content-type":"application/json"}

  Output Data

  • Status Code (number): success or failure of your HTTP request. Here is a list of all status codes.
  • Headers (object): detailed context for the status code, unrelated to the output body. Response headers are dependent on your selected HTTP request option. Note that not all headers are response headers.
  • Body (object): data returned from your selected HTTP request (for example, the data from a GET request)

• Deactivate User

  Deactivate a Salesforce user.

  Field type is text.

  Input

  • User
    • User ID: unique identifier of the user

  Output

  • This action has no output fields

• Download Attachment

  Download an attachment from a Salesforce record.

  Input Fields

  • Attachment
    • Attachment ID (text): The Salesforce ID for the attachment you wish to download.

  Output Fields

  The download behavior for the attachment will be dependent on your File Upload and Download Security settings within Salesforce.

  • File
    • Size (number): The size of the file you downloaded.
    • File Content (file): The file that you downloaded.
    • Name (text): The name of the file you downloaded.
    • Extension (type): The file format (e.g. .html, .http, etc.).

• Download Document

  Download a Docuemnt

• Download Document using Content Document Id

  Download a Document using a Content Document Id.

  Input Fields

  • Content Document Id
    • Content Document Id (text): The Content Document Id of the Document you wish to download.

  Output Fields

  The download behavior for the attachment will be dependent on your File Upload and Download Security settings within Salesforce.

  • File
    • Size (number): The size of the file you downloaded in bytes.
    • File Content (file): The file that you downloaded.
    • Name (text): The name of the file you downloaded.
    • Extension (type): The file format (e.g. .html, .http, etc.).

• Execute Query

  Execute a SOQL query.

  Input

  • SOQL Query (text): a valid SOQL query

  Output

  • Records (list): list of of records, as specified by the SOQL query
  • Next Page URL (text): link to the next set of records if SOQL Query exceeds 2,000 records

  Note: The HTTP Request card can be used to make a follow-up request with the Next Page URL.  Previously, in Salesforce version 1.3.65, this was handled internally through the Execute Query card.  In versions later than 1.3.65, this functionality was altered to improve overall performance and reliability of flows.

• Find Record

  Find a single record that matches the provided fields.

  Options

  • Record Type (drop-down list): dynamically generated list of record types, including custom objects

  Input

  A list of dynamically generated fields from your Salesforce account, based on the selected record type

  Output

  • Record ID (text): unique identifier for the object that matches the specified fields in Salesforce

• Freeze User

  Freeze a Salesforce user.

  Field type is text.

  Input

  • User
    • User ID: unique identifier of the user

  Output

  • This action has no output fields

• Get All Feature Licenses

  Retrieve a list of all Salesforce feature license names and IDs. Feature licenses enable users to access features that are not included in their own licenses.

  For more information on Feature Licenses, visit help.salesforce.com.

  Input

  • This action has no input fields

  Output

  • Feature Licenses (collection): list of feature license names and IDs

• Get All Permission Sets

  Retrieve a list of permission set names and IDs.

  For more information on Permission Sets, vist help.salesforce.com.

  Input

  • This action has no input fields

  Output

  • Permission Sets (collection): list of permission set names and IDs

• Get All Profiles

  Retrieve a list of profile names and IDs.

  For more informaton on Profiles, visit help.salesforce.com.

  Input

  • This action has no input fields

  Output

  • Profiles (collection): list of profile names and IDs

• Get All Public Groups

  Retrieve a list of public group names and IDs.

  Input

  • This action has no input fields

  Output

  • Public Groups (collection): list of public group names and IDs

• Get All Roles

  Retrieve a list of role names and IDs.

  Input

  • This action has no input fields

  Output

  • Roles (collection): list of role names and IDs

• Get Multiselect Values - Custom Fields

  Get a list of available options for a custom multiselect type field

• Read Picklist Values

  Read the option values from a picklist-type field.

• Read Record

  Read dynamically generated fields from an existing record of the specified Record Type.

  Search Options

  • Record Type (drop-down): A dynamically generated list of Record types from your Salesforce account.

  Input

  • Read
    • Record ID (text): The ID for the record of the specified type within Salesforce.

  Output

  • Record
    • The output fields are dynamically generated from your Salesforce account. Includes custom fields. NOTE: Multi-select picklist custom fields will be returned as a semicolon-delimited list of text, e.g. “Labradoodle;Corgi;Bernese Mountain Dog”.

• Read Related Records

  Retrieve a list of related records.

  Options

  • Record Type (drop-down): type of related Salesforce record
  • Relationship Field (drop-down): how the record is related

  Input

  • Record ID (text): unique ID associated with the Salesforce record

  Output

  • Related Records
    • Records (list): list of related records

• Read User

  Retrieve the details of an existing Salesforce user.

  Unless otherwise indicated, field types are text.

  Input

  • Read By
    • User ID: unique identifier of the user

  Output

  • User
    • First Name: first name of user
    • Last Name: last name of user
    • Username: user’s unique login, in the form of an email address
    • Email: email address of user
    • Is Active? (boolean): indicator if the user is active
    • Is Frozen? (boolean): indicator if the user is frozen
    • Profile Name: user’s base-level permissions in Salesforce
    • Role Name: user’s position in the organization
    • Alias: short name to identify the user on pages where the entire name does not fit (if no value is provided, alias is generated based on the Username, trimmed to eight characters)
    • Nickname: name used to identify user in a community
    • Title: user’s job title
    • Email Encoding (drop-down): character set and encoding for outbound email sent by user, defaulted to Unicode (UTF-8)
    • Locale: user’s country or geographic region, defaulted to en_US (locales supported by Salesforce can be found here)
    • Language (drop-down): user’s primary language
    • Mobile Phone: user’s cellular or mobile phone number
    • Phone: user’s phone number
    • Street: user’s street address
    • City: city portion of user’s address
    • State/Province: state or province portion of user’s address
    • Zip/Postal Code: zip code or postal code portion of user’s address
    • Employee Number: unique identification number for the user
    • Company Name: name of the user’s company
    • Division: division of the company (for example, PC Sales Group)
    • Department: department or group in the company (for example, Customer Support)
    • Manager ID: unique identifier of user’s manager
    • Permission Set Names (collection): array of permission set names you can grant to the user
    • Public Group Names (collection): array of public group names you can assign the user to
    • Feature License Names (collection): array of feature licenses you can grant to the user (feature licenses provide access to features not included in the user license)
    • Time Zone (drop-down): primary time zone in which the user works, defaulted to (GMT-07:00) Pacific Daylight Time (America/Los_Angeles)
    • Dynamically generated custom fields

• Search Leads

  Search for a list of leads assigned to a user.

  Input

  • Search By
    • User ID (text): unique identifier of the user

  Output

  • Lead
    • IDs (collection): list of assigned lead IDs

• Search Records

  Search for Salesforce records.

  Options

  • Record Type (drop-down): type of Salesforce record

  Input

  • Fields (list): dynamically generated list of input fields based on the selected Record Type

  Output

  • Record IDs (list): list of all associated record IDs

• Search Users

  Search for Salesforce users based on Username or Email.

  Unless otherwise indicated, field types are text.

  Parameters

  • Search By
    • Username: username of the user
    • Email: email address of the user

  Input

  • Query
    • Value: exact value you want to search for (cannot be a partial search)

  Output

  • Result
    • Search By Username:
      • User ID: unique identifier of the user
      • First Name: first name of user
      • Last Name: last name of user
      • Username: user’s unique login, in the form of an email address
      • Email: email address of user
      • Is Active? (boolean): indicator if the user is active
      • Is Frozen? (boolean): indicator if the user is frozen
      • Alias: short name to identify the user on pages where the entire name does not fit (if no value is provided, alias is generated based on the Username, trimmed to eight characters)
      • Nickname: name used to identify user in a community
      • Title: user’s job title
      • Email Encoding (drop-down): character set and encoding for outbound email sent by user, defaulted to Unicode (UTF-8)
      • Locale: user’s country or geographic region, defaulted to en_US (locales supported by Salesforce can be found here)
      • Language (drop-down): user’s primary language
      • Mobile Phone: user’s cellular or mobile phone number
      • Phone: user’s phone number
      • City: city portion of user’s address
      • State/Province: state or province portion of user’s address
      • Zip/Postal Code: zip code or postal code portion of user’s address
      • Employee Number: unique identification number for the user
      • Company Name: name of the user’s company
      • Division: division of the company (for example, PC Sales Group)
      • Department: department or group in the company (for example, Customer Support)
      • Manager ID: unique identifier of user’s manager
    • Search By Email:
      • Users (collection): list of matching user objects

• Transfer Leads

  Transfer all leads from one user to another.

  Input

  • Transfer From
    • User ID (string): unique identifier of the user whose leads you want to transfer
  • Transfer To
    • User ID (string): unique identifier of the user who will receive the leads

  Output

  • This action has no output fields

• Unfreeze User

  Unfreeze a Salesforce user.

  Field type is text.

  Input

  • User
    • User ID: unique identifier of the user

  Output

  • This action has no output fields

• Update Custom Picklist Values

  Update the option values from a custom picklist-type field

• Update Global Picklist Values

  Update the option values from a global picklist-type field

• Update Record

  Update a single record identified by the record ID.

  Options

  • Record Type (dropdown list): A dynamically generated list of record types from your Salesforce account.

  Input Fields

  The input fields for this Action are dynamically generated from your Salesforce Account and dependent on the Record Type dropdown list in Options.

  • Update 
    • Record ID (text): the id of the record inside Salesforce. This is a required field.
  • Record
    • These input fields are dependent on the “Record Type” dropdown list, and are dynamically generated at design time based on the type of record you want to create. Custom fields are supported. NOTE: Multi-select picklist custom fields should be entered as a semicolon-delimited list of text, e.g. “Labradoodle;Corgi;Bernese Mountain Dog”. To read the available picklist options as part of your Flow, use the Read Picklist Values action.

  Output Fields

  No outputs available.

  More information about Update Record from Salesforce here

• Update User

  Update an existing user in Salesforce.

  Unless indicated, field types are text.

  Input

  • User
    • First Name: first name of user
    • Last Name: last name of user
    • Username: user’s unique login, in the form of an email address
    • Email: Email address of user. Updates to this field are not visible in the profile until the user confirms the changed address.
    • Profile Name: user’s base-level permissions in Salesforce
    • Role Name: user’s position in the organization
    • Alias: short name to identify the user on pages where the entire name does not fit (if no value is provided, alias is generated based on the Username, trimmed to eight characters)
    • Nickname: name used to identify user in a community
    • Title: user’s job title
    • Email Encoding (dropdown): character set and encoding for outbound email sent by user, defaulted to Unicode (UTF-8)
    • Locale: user’s country or geographic region, defaulted to en_US (locales supported by Salesforce can be found here)
    • Language (dropdown): user’s primary language
    • Mobile Phone: user’s cellular or mobile phone number
    • Phone: user’s phone number
    • Street: user’s street address
    • City: city portion of user’s address
    • State/Province: state or province portion of user’s address
    • Zip/Postal Code: zip code or postal code portion of user’s address
    • Employee Number: unique identification number for the user
    • Company Name: name of the user’s company
    • Division: division of the company (for example, PC Sales Group)
    • Department: department or group in the company (for example, Customer Support)
    • Manager ID: unique identifier of user’s manager
    • Permission Set Names (collection): array of permission set names you can grant to the user
    • Public Group Names (collection): array of public group names you can assign the user to
    • Feature License Names (collection): array of feature licenses you can grant to the user (feature licenses provide access to features not included in the user license)
    • Time Zone (dropdown): primary time zone in which the user works, defaulted to (GMT-07:00) Pacific Daylight Time (America/Los_Angeles)
    • Dynamically generated custom fields

  Output

  • User
    • User ID: unique identifier of the user

• Upload Attachment

  Upload a file and attach it to a record in Salesforce.

  Input

  • Attach to
    • Record ID (text): ID of the record
  • File
    • Name (text): attachment name
    • Description (text): description of the attachment
    • File Content (file): attachment to upload

  Output

  • Attachment
    • Attachment ID (text): object ID for the attachment in Salesforce

• Upload Document

  Uploads a document

• Create

  Create

  Creates a new record in Salesforce of the type you choose.

  Are you looking for Gainsight help? Click here.

  Options

  • Record type (dropdown): a dropdown of your available record types in Salesforce, including custom records

  Input Fields

  Input fields are dynamically generated and will reflect the fields that are available in your Salesforce instance for that record type. Any field with _c at the end is a custom field. NOTE: for any date field you are writing to in this action, it must be in standard UTC format. The Salesforce API will automatically convert it to the timezone of your instance.

  Here are some standard fields that you may see as inputs on your card:

  fields 

  • ParentId (number): the unique identifier of the parent record in Salesforce to which you want to associate this new record
  • Name (text): name of the record that you are creating
  • Type (picklist): the category of the record you are creating, represented in your Salesforce instance as a dropdown menu. NOTE: You can write any value to this field, but we recommend matching the exact spelling and capitalization to the available dropdown options to ensure consistency across your records
  • OwnerId (number): the unique identifier of the owner of the record you are creating. You can search for a particular owner’s ID by using the Salesforce Search action and selecting “User” as the record type

  Output Fields

  data 

  • id (number): the unique identifier in Salesforce of the record that was created

• Get Multiselect Values - Custom Fields

  Retrieve all available options for a custom multiselect type field. The input of a custom multiselect type field must be concatenated with a semicolon.

  Input

  • Custom Field
    • Label (text): name of the custom multiselect type field you want to query for available options

  Output

  • Multiselect Values (collection): list of all available options with label and value

• Read

  Reads a record in Salesforce by ID and returns all the data associated with that record.

  Options

  • Record type (dropdown): a dropdown of your available record types in Salesforce, including custom records

  Input Fields

  record

  • id (number): the unique identifer of the record you wish to read. NOTE: This is a required field and must be the ID from Salesforce for that record. We recommend using Search to dynamically find the ID of the record if it is not recorded elsewhere in your systems.

  Output Fields

  Output fields are dynamically generated and will reflect the fields that are available in your Salesforce instance for that record type. Any field with _c at the end is a custom field. NOTE: All date fields will be output in standard UTC format. data 

  • id (number): the unique identifier of the Salesforce record you are reading
  • ParentId (number): the unique identifier of the parent record in Salesforce to which that record is associated
  • Name_ (text):_ name of the record
  • Type_ (text):_ the category of the record you are reading, represented in your Salesforce instance as a dropdown menu. This field will return plain text
  • OwnerId (number): the unique identifier of the owner of the record

• Read Picklist Values

  Read the picklist values from a Salesforce record.

  Note: The connection and record type that you select determine the field options.

  Input

  • Record Type (drop-down): dynamically generated list of Record Types from your Salesforce account
  • Field (drop-down): dynamically generated list of API fields for your selected Record Type

  Output

  • Values (collection): dynamically generated list of picklist options for your Record Type and Field selections

• Search

  Searches records in Salesforce for term(s) of your choosing and outputs the unique ID of the first record that is found matching your search term(s). Because only one record ID is returned, we recommend searching by a unique term (for example, Email if you are searching for a contact) to ensure this action outputs the ID you are looking for. Are you looking for Gainsight help? Click here.

  Options

  • Record type (dropdown): a dropdown of your available record types in Salesforce, including custom records

  Input Fields

  Input fields are dynamically generated and will reflect the fields that are available in your Salesforce instance for that record type. You can search by a minimum of one or a combination of multiple inputs to find the record ID. Any field with _c at the end is a custom field. NOTE: If you are searching by a date field in this action, it must be in standard UTC format.

  Output Fields

  data 

  • id (number): the unique identifier in Salesforce of the first record that was found matching your search term(s)

• Update

  Update an existing record in Salesforce.

  Options

  • Record type (drop-down): dynamically generated list of available record types in Salesforce, including custom records

  Input

  Record 

  • ID (number): unique identifier of the record in Salesforce

  Fields

  Input fields are dynamically generated from your record type selection. Custom fields are marked with _c. Standard fields are listed below.

  Note: Dates must be in standard UTC format. The Salesforce API automatically converts timestamps to the timezone of your instance.

  • ParentID (number): unique identifier of the parent record in Salesforce
  • Name (text): name of the record
  • Type (picklist):_ category of the record, represented in your Salesforce instance as a drop-down menu (for consistency across records, match the spelling and capitalization to the available options)
  • OwnerId (number): Unique identifier of the record’s owner. You can search for an owner’s ID by using the Salesforce Search action and selecting “User” as the record type

• Update Custom Picklist Values

  Add or remove options that are available in a custom picklist field. Changes will affect only the Salesforce picklists that inherit from the custom value set.

  All field types are text.

  Options

  • Record Type: dynamically generated list of Record Types from your Salesforce account

  Input

  • Picklist

    • Label: API value of the picklist field
    • Name: display name of the picklist field

  • Options

    • Add Values: display names of the values that you want to add to the picklist
    • Remove Values: display names of the values that you want to remove from the picklist
      
      

• Update Global Picklist Values

  Add or remove the options that are available in a global picklist field. Changes will affect all Salesforce picklists that inherit from the global value set.

  All field types are text.

  Options

  • Record Type: dynamically generated list of Record Types from your Salesforce account

  Input

  • Picklist

    • Label: API value of the picklist field
    • Name: display name of the picklist field

  • Options

    • Add Values: display names of the values that you want to add to the picklist
    • Remove Values: display names of the values that you want to remove from the picklist