Apis::V4::CommunityChallenge API

update a community challenge

Parameters

Name	Description
access_token	JSON Web Token retrieved from the Sessions endpoint (you can also passthis into the Authorization header)
data	The payload data that will be serialized to create the community challenge
fields	A comma separated list of fields to return in the response for the given type. A resource object's attributes and its relationships are collectively called its 'fields'. Clients may restrict the set of fields in order to improve performance. Multiple types can be specified. If no fields param is specified then by default all fields are returned. Example

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxMjQsImV4cCI6MTcwNDQ3MzIzMCwiaWF0IjoxNzA0NDczMDUwfQ.-o6UYsS9CjeFPUUgLa9sh_FViGAIkkM8GUtW9Tmip4U
Host: example.org
Cookie:

Route

PUT /apis/v4/community_challenges/6

Body

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
X-MH-Session: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxMjQsImV4cCI6MTcwNDY0NTg1MCwiaWF0IjoxNzA0NDczMDUwfQ.VmkPlubWkD--zRTVN5U5Soni94zt9T86_s62Htt4YN4
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"ba4216506432517ea443b65c00075b12"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 33995760-edae-4c8d-afcb-ae498aa46b2c
X-Runtime: 0.086029
Content-Length: 1761

Status

Body

{
  "data": {
    "id": "6",
    "type": "community_challenge",
    "attributes": {
      "title": "new challenge title",
      "details_markdown": null,
      "end_date": "2018-10-29",
      "created_at": "2018-10-09T23:00:00Z",
      "updated_at": "2024-01-05T16:44:10Z",
      "completed_count": 0,
      "accepted_count": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "83",
          "type": "organization"
        }
      },
      "creator": {
        "data": {
          "id": "231",
          "type": "person"
        }
      },
      "accepted_community_challenges": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "83",
      "type": "organization",
      "attributes": {
        "name": "organization_name_80",
        "terminology": "Organization",
        "ancestry": null,
        "show_sub_orgs": true,
        "created_at": "2024-01-05T16:44:10Z",
        "updated_at": "2024-01-05T16:44:10Z",
        "community": true,
        "community_photo_url": null,
        "community_code": "B696F4",
        "community_url": "iKsSLTIo5EPh8o5jLR4N7Q",
        "unread_comments_count": 0,
        "welcome_message": null
      },
      "relationships": {
        "community_challenges": {
          "data": [
            {
              "id": "6",
              "type": "community_challenge"
            },
            {
              "id": "8",
              "type": "community_challenge"
            },
            {
              "id": "9",
              "type": "community_challenge"
            }
          ]
        }
      }
    },
    {
      "id": "231",
      "type": "person",
      "attributes": {
        "created_at": "2024-01-05T16:44:10Z",
        "fb_uid": 0,
        "first_name": "John",
        "full_name": "John Doe",
        "gender": "Male",
        "last_name": "Doe",
        "picture": "https://graph.facebook.com/v2.12/0/picture",
        "updated_at": "2024-01-05T16:44:10Z",
        "relationship_type": null
      },
      "relationships": {
        "email_addresses": {
          "data": [
            {
              "id": "151",
              "type": "email_address"
            }
          ]
        },
        "pathway_progression_audits": {
          "data": []
        },
        "phone_numbers": {
          "data": []
        },
        "user": {
          "data": {
            "id": "124",
            "type": "user"
          }
        },
        "received_challenges": {
          "data": []
        },
        "person_notes": {
          "data": []
        },
        "reverse_contact_assignments": {
          "data": []
        },
        "interactions": {
          "data": []
        },
        "contact_assignments": {
          "data": []
        },
        "organizational_permissions": {
          "data": [
            {
              "id": "151",
              "type": "organizational_permission"
            },
            {
              "id": "152",
              "type": "organizational_permission"
            }
          ]
        }
      }
    }
  ]
}