865: Update API docs (#192)

Author: ehimen-io

source/includes/authenticated_api/_events.md.erb

@@ -74,7 +74,8 @@ The authenticated REST API endpoints for events only deal with events created in
       "twitter_share_message": "Attending this event to deliver our petition",
       "twitter_share_title": "Deliver the Petition to the Wizard",
       "web_share_api_share_message": "Check out this event in the Emerald City",
-      "whatsapp_share_message": "I'm attending this event to deliver the petition. Join me!"
+      "whatsapp_share_message": "I'm attending this event to deliver the petition. Join me!",
+      "share_by_email_body": "I'm attending this event and thought you might be interested. Will you join me?"
     },
     ...
   ],
@@ -160,7 +161,8 @@ The response includes all the same data as the single-event endpoint for each ev
     "twitter_share_message": "Attending this event to deliver our petition",
     "twitter_share_title": "Deliver the Petition to the Wizard",
     "web_share_api_share_message": "Check out this event in the Emerald City",
-    "whatsapp_share_message": "I'm attending this event to deliver the petition. Join me!"
+    "whatsapp_share_message": "I'm attending this event to deliver the petition. Join me!",
+    "share_by_email_body": "I'm attending this event and thought you might be interested. Will you join me?"
   }
 }
 ```
@@ -290,7 +292,8 @@ the event `slug` is `chapter-meeting-1`.
     "twitter_share_message": null,
     "twitter_share_title": null,
     "web_share_api_share_message": null,
-    "whatsapp_share_message": null
+    "whatsapp_share_message": null,
+    "share_by_email_body": null
   }
 }
 ```
@@ -346,6 +349,7 @@ max_attendees_count | Integer | Limit on how many people, besides the host, may
 meta_description | String | Custom meta description for the event page (used for SEO and social media previews)
 meta_title | String | Custom meta title for the event page (used for SEO and social media previews)
 redirect_to | String | If set, visitors to the event page will be redirected to this URL
+share_by_email_body | String | Custom message pre-filled in the email body when supporters click the "Share by Email" button. Supports Liquid templating. Set to `null` to use the organisation's default.
 sharing_disabled | Boolean | Turns off the social sharing prompts for the event
 title | String | Event title
 twitter_share_description | String | Custom description used when sharing the event on Twitter/X

source/includes/authenticated_api/_petitions.md.erb

@@ -164,7 +164,8 @@ Petition are pieces of content that can be signed by members.
     "twitter_share_message": "Sign this petition to end tea taxes",
     "twitter_share_title": "No Taxes on Tea",
     "web_share_api_share_message": "Check out this petition about tea taxes",
-    "whatsapp_share_message": "I just signed a petition about tea taxes. Join me!"
+    "whatsapp_share_message": "I just signed a petition about tea taxes. Join me!",
+    "share_by_email_body": "I just signed this petition and thought you might be interested. Will you join me?"
   }
 }
 ```
@@ -345,7 +346,8 @@ Get a paginated list of all petitions, including ones that are unlaunched or oth
     "twitter_share_message": null,
     "twitter_share_title": null,
     "web_share_api_share_message": null,
-    "whatsapp_share_message": null
+    "whatsapp_share_message": null,
+    "share_by_email_body": null
   }
 }
 ```
@@ -439,6 +441,7 @@ meta_title | String | Custom meta title for the petition page (used for SEO and
 partnerships | Array | List of partnerships this petition should be associated with, formatted like `[{"slug": "foo"}, {"slug": "bar"}]`. If the petition was associated with any partnerships that are not included in the list, it will be removed from those partnerships.
 petition_creator_name_override | String | Name to display for the petition creator on the petition page. Set to `null` to use the name from the petition creator's user account.
 redirect_to | String | If set, visitors to the petition page will be redirected to this URL
+share_by_email_body | String | Custom message pre-filled in the email body when supporters click the "Share by Email" button. Supports Liquid templating. Set to `null` to use the organisation's default.
 show_progress_bar | Boolean | Whether to show the signature progress bar on the petition page
 signature_count_add_amount | Integer | If set, the displayed signature total on the petition page will be this much higher than the actual number of signatures recorded by the platform. This is usually used to reflect signatures that were gathered elsewhere and cannot be added to the platform, or signers whose data has been anonymized. A negative number can be specified to subtract from the total.
 title | String | Petition title