| A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | action_cards | |||||||||||||||||||||||||
2 | name | type | comment | |||||||||||||||||||||||
3 | id | STRING | A unique identifier for the action card. | |||||||||||||||||||||||
4 | created_on | TIMESTAMP | This timestamp indicates when this row was created in the Reach application database. | |||||||||||||||||||||||
5 | updated_on | TIMESTAMP | This timestamp indicates the most recent time the row was updated in the Reach application database. | |||||||||||||||||||||||
6 | campaign_id | INT64 | The ID of the campaign this action card belongs to. | |||||||||||||||||||||||
7 | created_by_user_id | STRING | The user who created the action card. | |||||||||||||||||||||||
8 | status | STRING | The status of a dashboard item. Possible values are `active`, `inactive`, and `archived`. Archived dashboard items are soft deleted. | |||||||||||||||||||||||
9 | label | STRING | The title of the action card. | |||||||||||||||||||||||
10 | link_to | STRING | The URL or in-app link destination for the action card. The `link_type` field will determine which sort of value is in this field. `external` cards will have URLs here beginning with `http://` or `https://`, and `in_app` cards will have internal links here beginning with a slash. All other link types should have no value here in the `link_to` field. | |||||||||||||||||||||||
11 | link_type | STRING | The type of link. Possible values are `in_app`, `external`, `none`, `share_network`, `share_social`, `share_content`, `content_upload`, `file_upload`, and `user_survey`. Please note that share_social cards have been deprecated in favor of the newer share_content cards. | |||||||||||||||||||||||
12 | description | STRING | The body text of the action card. NOTE: This text may include markdown formatting | |||||||||||||||||||||||
13 | icon_url | STRING | The URL for the icon displayed on the action card. | |||||||||||||||||||||||
14 | position | INT64 | The order in which the action card is displayed on the dashboard. These positions are only relevant when a card is pinned and determine the card's relative positions amongst other pinned cards. | |||||||||||||||||||||||
15 | points | INT64 | The number of points a user receives for completing the action card. Points are arbitrary and determined by the admin making or editing the card. Points are awarded at the moment a user takes action to earn the points and editing point values will not retroactively affect points already earned. | |||||||||||||||||||||||
16 | action_type | STRING | The type of dashboard action. Possible values are `post` and `task`. The difference is that `task` cards have a check box and can be marked as completed. | |||||||||||||||||||||||
17 | banner_url | STRING | The URL for the banner image displayed on the action card. | |||||||||||||||||||||||
18 | expires_on | TIMESTAMP | The timestamp indicating when the action card will no longer be visible to users. | |||||||||||||||||||||||
19 | publish_on | TIMESTAMP | The timestamp indicating when the action card will become visible to users. | |||||||||||||||||||||||
20 | pinned | BOOL | A boolean indicating whether the action card is pinned to the top of the user's dashboard. | |||||||||||||||||||||||
21 | cta_label | STRING | The text for the call-to-action button on the action card. | |||||||||||||||||||||||
22 | share_script | STRING | Admin user inputted text field for the script which a user will be asked to customize and send to their contacts via a Network Contact Action Card | |||||||||||||||||||||||
23 | share_script_subject | STRING | Admin user inputted text field for the subject line pre-filled in an email that a user will be asked to send to their contacts via a Network Contact Action Card | |||||||||||||||||||||||
24 | user_filters | STRING | A JSON object containing filters that determine which users will see the action card. | |||||||||||||||||||||||
25 | auto_push | BOOL | A boolean indicating whether a push notification should be sent to users when the action card is published. | |||||||||||||||||||||||
26 | source | STRING | Source of this dashboard item data. Possible values are `reach`, `api`, and `manual`. A value of `reach` means it was created by an admin user via the Admin Dashboard. `api` means it was created by API (though no external API endpoint yet exists to allow creation of action cards) and `manual` means it was created by the Reach support team as a custom support project. | |||||||||||||||||||||||
27 | show_filter_bar | BOOL | A boolean indicating whether to show a filter bar on the action card. This is relevant for Network Contact Action Cards and determines whether a user should be allowed to modify the filtering an admin may have pre-set for this Action Card. By hiding the filter bar, the admin's assigned filters are locked in place and invisible to the user. | |||||||||||||||||||||||
28 | force_square_crop | BOOL | Relevant to File Upload Action Cards and Content Upload Action Cards. A boolean indicating whether to force the user to crop their uploaded image to a square aspect ratio. | |||||||||||||||||||||||
29 | upload_file_type | ARRAY<STRING> | For File Upload and Content Upload Action Cards, this determines the types of files users are allowed to upload. Possible values are `pdf`, `image`, `gif`, `video`, `audio`, `application`, and `text`. | |||||||||||||||||||||||
30 | content_asset_id | STRING | For 'Share Content' action cards, this is the ID of the `content_asset` to be shared. | |||||||||||||||||||||||
31 | based_on_template_id | STRING | The ID of the object which the user chose as a template from Reach's `Default Content Libraries` feature when creating this object. | |||||||||||||||||||||||
32 | asset_label_ids | STRING | Determines which labels will be assigned to content uploaded via a Content Upload action card. | |||||||||||||||||||||||
33 | question_set_id | STRING | For User Survey Action Cards, indicates the ID of the Question Set that will be displayed on the Action Card. | |||||||||||||||||||||||
34 | ||||||||||||||||||||||||||
35 | ||||||||||||||||||||||||||
36 | ||||||||||||||||||||||||||
37 | ||||||||||||||||||||||||||
38 | ||||||||||||||||||||||||||
39 | ||||||||||||||||||||||||||
40 | ||||||||||||||||||||||||||
41 | ||||||||||||||||||||||||||
42 | ||||||||||||||||||||||||||
43 | ||||||||||||||||||||||||||
44 | ||||||||||||||||||||||||||
45 | ||||||||||||||||||||||||||
46 | ||||||||||||||||||||||||||
47 | ||||||||||||||||||||||||||
48 | ||||||||||||||||||||||||||
49 | ||||||||||||||||||||||||||
50 | ||||||||||||||||||||||||||
51 | ||||||||||||||||||||||||||
52 | ||||||||||||||||||||||||||
53 | ||||||||||||||||||||||||||
54 | ||||||||||||||||||||||||||
55 | ||||||||||||||||||||||||||
56 | ||||||||||||||||||||||||||
57 | ||||||||||||||||||||||||||
58 | ||||||||||||||||||||||||||
59 | ||||||||||||||||||||||||||
60 | ||||||||||||||||||||||||||
61 | ||||||||||||||||||||||||||
62 | ||||||||||||||||||||||||||
63 | ||||||||||||||||||||||||||
64 | ||||||||||||||||||||||||||
65 | ||||||||||||||||||||||||||
66 | ||||||||||||||||||||||||||
67 | ||||||||||||||||||||||||||
68 | ||||||||||||||||||||||||||
69 | ||||||||||||||||||||||||||
70 | ||||||||||||||||||||||||||
71 | ||||||||||||||||||||||||||
72 | ||||||||||||||||||||||||||
73 | ||||||||||||||||||||||||||
74 | ||||||||||||||||||||||||||
75 | ||||||||||||||||||||||||||
76 | ||||||||||||||||||||||||||
77 | ||||||||||||||||||||||||||
78 | ||||||||||||||||||||||||||
79 | ||||||||||||||||||||||||||
80 | ||||||||||||||||||||||||||
81 | ||||||||||||||||||||||||||
82 | ||||||||||||||||||||||||||
83 | ||||||||||||||||||||||||||
84 | ||||||||||||||||||||||||||
85 | ||||||||||||||||||||||||||
86 | ||||||||||||||||||||||||||
87 | ||||||||||||||||||||||||||
88 | ||||||||||||||||||||||||||
89 | ||||||||||||||||||||||||||
90 | ||||||||||||||||||||||||||
91 | ||||||||||||||||||||||||||
92 | ||||||||||||||||||||||||||
93 | ||||||||||||||||||||||||||
94 | ||||||||||||||||||||||||||
95 | ||||||||||||||||||||||||||
96 | ||||||||||||||||||||||||||
97 | ||||||||||||||||||||||||||
98 | ||||||||||||||||||||||||||
99 | ||||||||||||||||||||||||||
100 | ||||||||||||||||||||||||||