v1

latestOpenAPI 3.0.02026-08-062903562.2 MB

Update

updateUpdate

Update Update

put/updates/{update}

Path parameters

updateinteger required

Example:72631

Primary identifier of Update

Request body

bodystring

Main content of Update

status'draft' | 'published'

Indication whether Post is a draft or has been published

titlestring nullable

Title of Post

visibility'private' | 'public'

Visibility of Update (private Updates can only be seen by the Member associated with record)

Example request

{
  "body": "The main reason that I am raising funds for this organization is to...",
  "status": "draft",
  "visibility": "public"
}

Response

Success

bodystring

Main content of Post

comments_countinteger

Cached count of the number of Comments made in response to Post

created_atstring date-time

Date/time of initial record creation

likes_countinteger

Cached count of the number of Likes that Post has received

member_idinteger

Primary identifier of Member who created Post (i.e. the poster)

postable_idinteger

Primary identifier of Fundraising Entity for which the Post was made

postable_typestring

String describing type of Fundraising Entity for which the Post was made

poster_namestring nullable

Full name of Post's creator

shares_countinteger

Cached count of the number of times Post has been shared

status'draft' | 'published'

Indication whether Post is a draft or has been published

titlestring nullable

Title of Post

updated_atstring date-time

Date/time of last record update

views_countinteger

Cached count of the number of times Post has been viewed

asset_idinteger nullable

ID of associated Asset

asset_urlstring nullable

CDN URL of associated Asset

idinteger

Primary identifier of record

visibility'private' | 'public'

Visibility of Update (private updates can only be seen by the Member associated with record)

Example response

{
  "body": "Thank you everyone for the progress we've made so far! We have five days until...",
  "comments_count": 3,
  "created_at": "2021-04-23T08:23:21Z",
  "latest_comments": [
    {
      "body": "Example Comment",
      "commentable_id": 736,
      "commentable_type": "update",
      "commenter_name": "GoFundMe Pro Commenter",
      "author_display_name": "Pat Supporter",
      "created_at": "2021-04-23T08:23:21Z",
      "id": 47281,
      "likes_count": 5,
      "member_id": 2012,
      "updated_at": "2021-04-23T08:23:21Z"
    }
  ],
  "likes_count": 14,
  "member_id": 2012,
  "postable_id": 209745,
  "postable_type": "fundraising_team",
  "poster_name": "Buster McTest",
  "shares_count": 8,
  "status": "published",
  "updated_at": "2021-04-23T10:25:03Z",
  "views_count": 46,
  "asset_id": 4521,
  "asset_url": "https://cdn.example.com/assets/4521.jpg",
  "id": 72631,
  "visibility": "public"
}