Apis::V4::CommunityChallenge API

create 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.eyJ1c2VyX2lkIjoxMjMsImV4cCI6MTcwNDQ3MzIzMCwiaWF0IjoxNzA0NDczMDUwfQ.-f8kLxw_AWlp-Y-Pqj1aEr4fGWBK4wD8u8x-BamdMK0
Host: example.org
Cookie:

Route

POST /apis/v4/community_challenges

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.eyJ1c2VyX2lkIjoxMjMsImV4cCI6MTcwNDY0NTg1MCwiaWF0IjoxNzA0NDczMDUwfQ.U_q4V5Kepd0ZZnhoj2VX9nJgGZWocfhXJlVtFpN4108
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"a335a0bd4586cd7c925dc0d4d3954518"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 9aac2a37-9612-494c-a896-2ce41e820920
X-Runtime: 0.109138
Content-Length: 1792

Status

Body

{
  "data": {
    "id": "5",
    "type": "community_challenge",
    "attributes": {
      "title": "Roge rules",
      "details_markdown": null,
      "end_date": "2024-01-12",
      "created_at": "2024-01-05T16:44:10Z",
      "updated_at": "2024-01-05T16:44:10Z",
      "completed_count": 0,
      "accepted_count": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "81",
          "type": "organization"
        }
      },
      "creator": {
        "data": {
          "id": "230",
          "type": "person"
        }
      },
      "accepted_community_challenges": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "81",
      "type": "organization",
      "attributes": {
        "name": "organization_name_78",
        "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": "1A4962",
        "community_url": "cYQbeF0zgTRS3xQvWVsG0A",
        "unread_comments_count": 0,
        "welcome_message": null
      },
      "relationships": {
        "community_challenges": {
          "data": [
            {
              "id": "1",
              "type": "community_challenge"
            },
            {
              "id": "3",
              "type": "community_challenge"
            },
            {
              "id": "4",
              "type": "community_challenge"
            },
            {
              "id": "5",
              "type": "community_challenge"
            }
          ]
        }
      }
    },
    {
      "id": "230",
      "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": "150",
              "type": "email_address"
            }
          ]
        },
        "pathway_progression_audits": {
          "data": []
        },
        "phone_numbers": {
          "data": []
        },
        "user": {
          "data": {
            "id": "123",
            "type": "user"
          }
        },
        "received_challenges": {
          "data": []
        },
        "person_notes": {
          "data": []
        },
        "reverse_contact_assignments": {
          "data": []
        },
        "interactions": {
          "data": []
        },
        "contact_assignments": {
          "data": []
        },
        "organizational_permissions": {
          "data": [
            {
              "id": "149",
              "type": "organizational_permission"
            },
            {
              "id": "150",
              "type": "organizational_permission"
            }
          ]
        }
      }
    }
  ]
}