Dynamic Content Object
Dynamic content personalizes parts of your website based on what you know about a viewer. Learn more about dynamic content in Salesforce Help.
Include the authentication header with every request. For information on how to authenticate, see Authentication.
| Resource Name | Operation | Description |
|---|---|---|
| Dynamic Content Query | GET | Request information for dynamic content that matches the specified criteria. |
| Dynamic Content Read | GET | Request information for a single dynamic content record. |
Request information for the dynamic content records that match the specified criteria. You can specify the dynamic content records and fields to request. A maximum of 200 records are returned. To return all dynamic content records, specify the output as mobile.
URI
Parameters to Select Dynamic Content Records
Use these parameters to specify the dynamic content records to return. Parameters can be used in any combination and in any order unless otherwise specified.
Notes:
- Parameters must be URL-encoded.
- Dates and times must use GNU Date Input Syntax (for example, yyyy-mm-dd:hh:ss
). - For a full listing of dynamic content fields see Object Field References.
| Parameter | Type | Possible Values | Description |
|---|---|---|---|
created_after | string | today, yesterday, last_7_days, this_month, last_month,<custom_time> | Request dynamic content records created after the specified time. Example: To request forms created in 2020, use /api/dynamicContent/version/3/do/query?created_after=2019-12-31 24:59:59. |
created_before | string | today, yesterday, last_7_days, this_month, last_month, <custom_time> | Request dynamic content records created before the specified time. Doesn’t include dynamic content records created at the specified time. Example: To request dynamic content records created before today (but not created today), use /api/dynamicContent/version/3/do/query?created_before=today. |
id_greater_than | integer | Any positive integer | Request dynamic content records that have an ID greater than the specified number. |
id_less_than | integer | Any positive integer | Request dynamic content records that have an ID less than the specified number. |
updated_after | string | today, yesterday, last_7_days, this_month, last_month, <custom_time> | Request dynamic content records that were last updated after the specified time. |
updated_before | string | today, yesterday, last_7_days, this_month, last_month, <custom_time> | Request dynamic content records that were last updated before the specified time. |
Parameters to Specify Which Results Are Returned
Use these parameters to specify the dynamic content fields to return, and how the dynamic content records are sorted.
| Parameter | Type | Possible Values | Description |
|---|---|---|---|
limit | integer | Any integer from 1 through 200. | The number of dynamic content records to return. Default value is 200. |
offset | integer | Any positive integer | The number of dynamic content records to omit from the response (the number to "skip over"). Example: Retrieve a list of dynamic content records, omitting the 50 most recently updated records. Sort the query by the updated_at field and use offset=50: /api/dynamicContent/version/3/do/query?sort_by=updated_at&offset=50 |
sort_by | string | created_at, id, updated_at | The field by which the results are sorted. See Sort Order. |
sort_order | string | ascending, descending | The version/3. The default value depends on which sort_by parameter you specify. See Sort Order. |
Sort Order
Use sort_by to specify which field Account Engagement uses to sort the results. Different fields have different default sort orders.
| Value | Default Sort Order | Description |
|---|---|---|
created_at | descending | Sort the results by the dynamic content records' created_at timestamps. |
id | ascending | Sort the results by the dynamic content records' id fields. |
updated_at | descending | Sort the results by the dynamic content records' updated_at timestamps. |
Request information for a single dynamic content record.
URI
Replace <ID> with the Account Engagement ID of the dynamic content record.
Example
Request information about the dynamic content record with ID 1234.
The XML response for a query request contains information for multiple dynamic content records. The XML response for a read request contains information for a single dynamic content record.
XML Response for a Dynamic Content Query
| Tag | Description |
|---|---|
<result> | Parent tag. Contains the dynamic content records that match the parameters specified in your query. |
<total_results> | Contains the number of dynamic content records selected by the query. Note The query request returns a maximum of 200 dynamic content records. If your query matches more than 200 records, you can make several requests to retrieve all matching records. |
<dynamicContent> | The information about a single dynamic content record. See Dynamic Content in Object Field References for a complete description of fields. |
XML Response for a Dynamic Content Read
| Tag | Description |
|---|---|
<dynamicContent> | The information about a single dynamic content record. See Dynamic Content in Object Field References for a description of fields. |