Salesforce (old)

Overview

• Salesforce

  General

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

  Note: you might receive generic errors such as “Bad Request” from certain connectors, like Salesforce. Often, the actual error message is contained within the object that is returned by the API.

  Authentication

  Having difficulties connecting to your Salesforce account? Try reauthorizing your account in Settings –> Accounts, or deleting the account and adding it again.

  You can find a list of all your available accounts under Settings –> Accounts.

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

Actions

• Activate User

  This action allows you to activate a Salesforce user.

  Inputs:

  • User
    • User ID (string): The unique user ID.

  Outputs:

  • This action has no output fields

• Activate User

  This action allows you to unfreeze a Salesforce user.

  Inputs:

  • User
    • User ID (string): The unique user ID.

  Outputs:

  • This action has no output fields

• Create User

  This action allows you to create a new user in Salesforce.

  Inputs:

  • User
    • First Name (string): First name of user.
    • Last Name (string): Last name of user.
    • Username (string): An administrative required field that defines the user’s login. Username needs to be in the format of email, and needs to be unique.
    • Email (string): Email address of user. Email is a required field.
    • Profile Name (string): Profile is a required administrative field that specifies the user’s base-level permissions to perform different functions within the application.
    • Role Name (string): An administrative field that specifies the position of the user within an organization.
    • Alias (string): Short name to identify the user on list pages, reports, and other pages where the entire name does not fit. If no value is provided for Alias field, we will generate one for you based on Username: strip out the domain portion and trim it to 8 characters.
    • Nickname (string): The name used to identify this user in a community.
    • Title (string): Job title of user.
    • Email Encoding (dropdown): Character set and encoding for outbound email sent by user from within Salesforce, defaulted to Unicode (UTF-8).
    • Locale (string): Country or geographic region in which user is located, defaulted to en_US. Supported Locales by Salesforce here.
    • Language (dropdown): The primary language for the user.
    • Mobile Phone (string): Cellular or mobile phone number.
    • Phone (string): Phone number of user.
    • Street (string): Street address for user.
    • City (string): City portion of user’s address.
    • State/Province (string): State or province portion of user’s address.
    • Zip/Postal Code (string): Zip code or postal code portion of user’s address.
    • Employee Number (string): Identifying number for the user.
    • Company Name (string): Company name where user works.
    • Division (string): Company division to which user belongs for example, PC Sales Group.
    • Department (string): Group that user works for, for example, Customer Support.
    • Manager ID (string): The user’s manager ID.
    • Permission Set Names (collection): An array of permission set names you want to grant to the user.
    • Public Group Names (collection): An array of public group names you want to assign the user to.
    • Feature License Names (collection): An array of feature license names you want to grant to the user.
    • Time Zone (dropdown): Primary time zone in which user works, defaulted to (GMT-07:00) Pacific Daylight Time (America/Los_Angeles).
    • Dynamically generated custom fields.

  Outputs:

  • User
    • User ID (string): The unique user ID.

• Custom API Action

  This action allows you to make a custom, authenticated HTTP call to the Salesforce API.

  Options

  • Request Type (dropdown): your available HTTP request methods. There are 5 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, and if successful will receive a 200 OK response message with the requested content. Additional documentation here.

    • POST: sends data to a web server based on your parameters. POST requests include actions like uploading a file. Multiple POST’s may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POST’s. If a POST is successful, you will receive a 200 OK response message. 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). Additional documentation here.

    • PATCH: applies partial modifications to a resource on a web server based on your parameters. PATCH is not idempotent, meaning that the result of multiple PATCH’s could have unintended consequences. If a PUT is successful, you will receive a 200 response message (usually 204). 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. Additional documentation here.

  Input Data

  • Relative URL (text): the 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). With this Custom API Action the user needs to specify the API version being accessed and add following ‘/’ characters when required.

    Example: /services/data/v45.0/sobjects/User

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

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

  • Headers (object): JSON 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): the success or failure of your HTTP request. Here is a list of all status codes.

  • Headers (object): a more detailed context for the response/status code that doesn’t relate to the output body. Not all headers that appear in a response header are response headers, meaning that some are unlikely to be useful to you. The response headers are dependent on the HTTP request you choose in options.

  • Body (object): depending on the HTTP request you chose in Options, you may receive some data back. That data, such as the data from a GET request, will be contained in this Body object.

• Deactivate User

  This action allows you to deactivate a Salesforce user.

  Inputs:

  • User
    • User ID (string): The unique user ID.

  Outputs:

  • This action has no output fields

• Download Attachment

  Download Attachment

  Use this action when you want to download an attachment out of Salesforce so that you can then copy that attachment to another location. 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

  • Attachment
    • ID (number): the unique identifier 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

  • File
    • Size (text): the size of the file in bytes
    • File Content (text): The content of the file.

• Freeze User

  This action allows you to freeze a Salesforce user.

  Inputs:

  • User
    • User ID (string): The unique user ID.

  Outputs:

  • This action has no output fields

• Get All Feature Licenses

  This helper card allows you to get a list of all the feature license names and ids.

  Inputs:

  • This action has no input fields

  Outputs:

  • Feature Licenses (collection): A list of all the feature license names and ids.

• Get All Permission Sets

  This helper card allows you to get a list of all the permission set names and ids.

  Inputs:

  • This action has no input fields

  Outputs:

  • Permission Sets (collection): A list of all the permission set names and ids.

• Get All Profiles

  This helper card allows you to get a list of all the profile names and ids.

  Inputs:

  • This action has no input fields

  Outputs:

  • Profiles (collection): A list of all the profile names and ids.

• Get All Public Groups

  This helper card allows you to get a list of all the public group names and ids.

  Inputs:

  • This action has no input fields

  Outputs:

  • Public Groups (collection): A list of all the public group names and ids.

• Get All Roles

  This helper card allows you to get a list of all the role names and ids.

  Inputs:

  • This action has no input fields

  Outputs:

  • Roles (collection): A list of all the role names and ids.

• Get Multiselect Values - Custom Fields

  This helper card allows you to get all the available options for a custom multiselect type field. Note that you need to concatenate the selected options with a semicolon as the input to a custom multiselect type field.

  Inputs:

  • Custom Field
    • Label (string): The label or name of the custom multiselect type field you want to query for all the available options.

  Outputs:

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

• Get Record Attachments

  Get Record Attachments

  Gets all of the attachments of a record in Salesforce by ID and returns all the attachments and data associated with that record. 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

  • Record
    • Record ID (number): the unique identifier 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 will be associated with the attachment for each record.

  • Attachments (list): A list of ‘Attachment’ objects
    • ID (text): a unique id for the individual attachment
    • Name (text): The name of the attachment
    • Parent ID (text): unique id of the parent record that the attachment lives on. Example (opportunity, contact, account, etc.)
    • Private? (true/false): whether the attachment is private or not
    • Size (text): the size of the file in bytes
    • Content Type (text): the file type of the attachment

• Read User

  This action allows you to get the details of an existing Salesforce user.

  Inputs:

  • Read By

    • User ID (string): The unique user ID.

      Outputs:

  • User

    • First Name (string): First name of user.
    • Last Name (string): Last name of user.
    • Username (string): An administrative field that defines the user’s login.
    • Email (string): Email address of user.
    • Is Active? (boolean): Whether the user is active or not.
    • Is Frozen? (boolean): Whether the user is frozen or not.
    • Email (string): Email address of user.
    • Profile Name (string): An administrative field that specifies the user’s base-level permissions to perform different functions within the application.
    • Role Name (string): An administrative field that specifies the position of the user within an organization.
    • Alias (string): Short name to identify the user on list pages, reports, and other pages where the entire name does not fit.
    • Nickname (string): The name used to identify this user in a community.
    • Title (string): Job title of user.
    • Email Encoding (dropdown): Character set and encoding for outbound email sent by user from within Salesforce.
    • Locale (string): Country or geographic region in which user is located.
    • Language (dropdown): The primary language for the user.
    • Mobile Phone (string): Cellular or mobile phone number.
    • Phone (string): Phone number of user.
    • Street (string): Street address for user.
    • City (string): City portion of user’s address.
    • State/Province (string): State or province portion of user’s address.
    • Zip/Postal Code (string): Zip code or postal code portion of user’s address.
    • Employee Number (string): Identifying number for the user.
    • Company Name (string): Company name where user works.
    • Division (string): Company division to which user belongs.
    • Department (string): Group that user works for.
    • Manager ID (string): The user’s manager ID.
    • Permission Set Names (collection): An array of permission sets you want to grant to the user.
    • Public Group Names (collection): An array of public groups you want to assign the user to.
    • Feature License Names (collection): An array of feature licenses you want to grant to the user.
    • Time Zone (dropdown): Primary time zone in which user works.
    • Dynamically generated custom fields.

• Search Leads

  This action allows you to search for a list of leads assigned to a user.

  Inputs:

  • Search By
    • User ID (string): The unique user ID.

  Outputs:

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

• Search Users

  This action allows you to search for Salesforce users based on Username or Email.

  Parameters:

  • Search By
    • Username (string): The username of the user.
    • Email (string): The email address of the user.

  Inputs:

  • Query
    • Value (string): The value you want to search for, note it has to be exact search, not partial search.

  Outputs:

  • Result
    • If Search By Username selected:
      • User ID (string): The unique user ID.
      • First Name (string): First name of user.
      • Last Name (string): Last name of user.
      • Username (string): An administrative field that defines the user’s login.
      • Email (string): Email address of user.
      • Is Active? (boolean): Whether the user is active or not.
      • Is Frozen? (boolean): Whether the user is frozen or not.
      • Email (string): Email address of user.
      • Alias (string): Short name to identify the user on list pages, reports, and other pages where the entire name does not fit.
      • Nickname (string): The name used to identify this user in a community.
      • Title (string): Job title of user.
      • Email Encoding (dropdown): Character set and encoding for outbound email sent by user from within Salesforce.
      • Locale (string): Country or geographic region in which user is located.
      • Language (dropdown): The primary language for the user.
      • Mobile Phone (string): Cellular or mobile phone number.
      • Phone (string): Phone number of user.
      • Street (string): Street address for user.
      • City (string): City portion of user’s address.
      • State/Province (string): State or province portion of user’s address.
      • Zip/Postal Code (string): Zip code or postal code portion of user’s address.
      • Employee Number (string): Identifying number for the user.
      • Company Name (string): Company name where user works.
      • Division (string): Company division to which user belongs.
      • Department (string): Group that user works for.
      • Manager ID (string): The user’s manager ID.
    • If Search By Email selected:
      • Users (collection): A list of matching user objects.

• Transfer Leads

  This action allows you to transfer all leads belonging to one user to another user.

  Inputs:

  • Transfer From

    • User ID (string): The unique user ID you want to transfer the leads from.

  • Transfer To

    • User ID (string): The unique user ID you want to transfer the leads to.

  Outputs:

  • This action has no output fields

• Update User

  This action allows you to update an existing user in Salesforce.

  Inputs:

  • Update By
    • User ID (string): The unique user ID.
  • Fields
    • First Name (string): First name of the user.
    • Last Name (string): Last name of the user.
    • Username (string): An administrative field that defines the user’s login. Username needs to be in the format of email, and needs to be unique.
    • Email (string): Email address of the user.
    • Profile Name (string): An administrative field that specifies the user’s base-level permissions to perform different functions within the application.
    • Role Name (string): An administrative field that specifies the position of the user within an organization.
    • Alias (string): Short name to identify the user on list pages, reports, and other pages where the entire name does not fit.
    • Nickname (string): The name used to identify this user in a community.
    • Title (string): Job title of the user.
    • Email Encoding (dropdown): Character set and encoding for outbound email sent by user from within Salesforce.
    • Locale (string): Country or geographic region in which user is located. Supported Locales by Salesforce here.
    • Language (dropdown): The primary language for the user.
    • Mobile Phone (string): Cellular or mobile phone number.
    • Phone (string): Phone number of the user.
    • Street (string): Street address for the user.
    • City (string): City portion of the user’s address.
    • State/Province (string): State or province portion of the user’s address.
    • Zip/Postal Code (string): Zip code or postal code portion of the user’s address.
    • Employee Number (string): Identifying number for the user.
    • Company Name (string): Company name where the user works.
    • Division (string): Company division to which user belongs for example, PC Sales Group.
    • Department (string): Group that user works for, for example, Customer Support.
    • Manager ID (string): The user’s manager ID.
    • Time Zone (dropdown): Primary time zone in which user works.
    • Dynamically generated custom fields.

  Outputs:

  • This action has no output fields