Bevy API GDG
  1. Chapter
Bevy API GDG
  • Attendee
    • Add Attendees
      POST
    • Get Attendee Search
      GET
    • Update Attendee
      PUT
    • Send Event Email
      PUT
    • Resend Event Email
      POST
    • Get Event Attendees
      GET
    • Checkin Attendee
      PUT
    • Delete attendee registration
      DELETE
    • Get Attendee by ID
      GET
    • Delete all attendee registrations by event
      DELETE
  • Order
    • Add Order
      POST
    • Update Order
      PUT
    • Check Order by ID
      GET
  • Membership
    • Add Membership
  • Bevy Virtual
    • Get Main Stage Video
    • Get Session Video IDs
    • Get Session Video URLs
  • Chapter
    • Get Chapters Status
      GET
    • Get Chapter Regions
      GET
    • Create Chapter
      POST
    • List chapters
      GET
    • Get Chapter by ID
      GET
    • List Chapter Events
      GET
    • List Chapter Members
      GET
    • Add Chapter Member
      POST
    • List Chapter Team
      GET
    • Add Chapter Team Member
      POST
    • Update Chapter Team Member
      PUT
    • Partial Update Chapter Team Member
      PATCH
    • Delete Chapter Team Member
      DELETE
    • Add chapter's members in batch
      POST
    • Delete chapter's member
      DELETE
  • Cohosted Events
    • List collaborating chapters
    • Delete cohosted event
    • Add all chapters as cohosts
    • Chapters a user can add as a cohost
  • Event
    • Get Event Counts
    • Get Event by ID
    • List events
    • List event types
    • Get Event Type by ID
    • List Event Attendees
    • List event tags
  • Search
    • Search chapters
    • Search events
  • User
    • List users
    • Get User by ID or Email
    • Update User
    • Delete User
    • Deactivate User
    • List user's events
    • List user's chapters
    • List user's chapter teams
    • Create Prospective User
    • Opt out of emails
    • Get User Counts
  1. Chapter

Create Chapter

POST
/chapter/
Chapter
Create a new chapter.
There is no publicly available image upload API. Chapters can still be created but they'll have the default images.
You may visit the chapter settings to upload a different banner or thumbnail.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/chapter/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "Chapter 2024",
    "description": "<p>lorem ipsum</p>",
    "language": "en",
    "hide_country_info": true,
    "country": "EG",
    "state": "Cairo Governorate",
    "city": "Cairo",
    "timezone": "Africa/Cairo",
    "latitude": 30.0444196,
    "longitude": 31.2357116,
    "status": "2",
    "is_hidden": true,
    "is_production_chapter": false,
    "is_city": true,
    "region": 12,
    "parent_chapter": "8",
    "currency": "USD",
    "blog_category": "5",
    "twitter_handle": "bevy",
    "flickr_page": "https://flickr.com/",
    "facebook_page": "https://facebook.com/",
    "linkedin_page": "https://linkedin.com/",
    "instagram_handle": "bevy"
}'
Response Response Example
201 - Example 1
{
    "active": true,
    "allow_internal_list_management": true,
    "available_months_last_12": 0,
    "banner_crop_vertical": 0,
    "blog_category": 4,
    "chapter_location": "Franklin (AL)",
    "chapter_photos": [
        {
            "id": 1234,
            "order": 1,
            "picture": {
                "url": "https://res.cloudinary.com/startup-grind/image/upload/.../image.png",
                "path": "image.png",
                "thumbnail_width": 720,
                "thumbnail_height": 540,
                "thumbnail_format": "auto",
                "thumbnail_url": "https://res.cloudinary.com/startup-grind/image/upload/.../image.png"
            }
        }
    ],
    "city": "Franklin",
    "could_update_meetup": false,
    "country": "AL",
    "country_name": "Albania",
    "created": "2024-02-02T13:17:59.903551Z",
    "cropped_banner_url": "https://res.cloudinary.com/startup-grind/image/fetch/.../image.jpeg",
    "currency": "USD",
    "description": "lorem ipsum",
    "event_activity_percentage_last_12": 0,
    "facebook_page": "https://facebook.com/",
    "featured_video_url": "https://youtube.com/",
    "flickr_page": "https://flickr.com/",
    "health_indicator": [
        0,
        0,
        -1,
        -1,
        -1
    ],
    "id": 50,
    "import_wp_events": false,
    "imported_id": 1234,
    "instagram_handle": "bevy",
    "integrations": {
        "meetup": {
            "url": "https://www.meetup.com/Awesome-NYC/",
            "urlname": "awesome-nyc",
            "name": "Awesome NYC",
            "topics": [
                "Tech",
                "Business"
            ],
            "description": "Awesome NYC"
        }
    },
    "is_city": false,
    "is_hidden": false,
    "is_production_chapter": true,
    "hide_country_info": false,
    "latitude": 30.0444196,
    "linkedin_page": "https://linkedin.com/",
    "logo": {
        "url": "https://res.cloudinary.com/startup-grind/image/upload/.../image.png",
        "path": "image.png",
        "thumbnail_width": 720,
        "thumbnail_height": 540,
        "thumbnail_format": "auto",
        "thumbnail_url": "https://res.cloudinary.com/startup-grind/image/upload/.../image.png"
    },
    "longitude": 31.2357116,
    "mailchimp_api_key": "1234567890abcdefg",
    "mailchimp_list_id": "1234567890",
    "media_partners": [
        1,
        3
    ],
    "media_partners_inactive": [
        2
    ],
    "meetup_api_key": "1234567890abcdefg",
    "meetup_group": "Awesome NYC",
    "monthly_events_last_12": 0,
    "on_team": false,
    "payee_setup_process_url": "https://instance.bevy.com/chapter-2024/payee-setup",
    "chapter_team": [
        {
            "id": 1234,
            "user": {
                "authentication_providers": [
                    {
                        "provider": "google-oauth2",
                        "provider_user_id": 1234
                    }
                ],
                "avatar": {
                    "url": "https://res.cloudinary.com/startup-grind/image/upload/.../image.png",
                    "path": "image.png",
                    "thumbnail_width": 720,
                    "thumbnail_height": 540,
                    "thumbnail_format": "auto",
                    "thumbnail_url": "https://res.cloudinary.com/startup-grind/image/upload/.../image.png"
                },
                "company": "Bevy",
                "cropped_avatar_url": "https://res.cloudinary.com/startup-grind/image/fetch/.../image.jpeg",
                "extra_data": {},
                "title": "Mr.",
                "role": {
                    "id": 1234,
                    "name": "Prospective",
                    "description": "Prospective Member",
                    "user_active_status": true
                },
                "email": "user@mail.com",
                "first_name": "John",
                "id": 1234,
                "last_name": "Doe",
                "username": "string"
            },
            "role": {
                "id": 1234,
                "name": "Lead Organizer Role",
                "description": "Full chapter permissions",
                "permissions": [
                    "string"
                ],
                "visible": true
            },
            "title": "Lead Organizer"
        }
    ],
    "payment_lead": 10,
    "picture": {
        "url": "https://res.cloudinary.com/startup-grind/image/upload/.../image.png",
        "path": "image.png",
        "thumbnail_width": 720,
        "thumbnail_height": 540,
        "thumbnail_format": "auto",
        "thumbnail_url": "https://res.cloudinary.com/startup-grind/image/upload/.../image.png"
    },
    "region": "USA",
    "rsvp_events_only": false,
    "slug": "chapter-2024",
    "sponsors": [
        1,
        2
    ],
    "sponsors_inactive": [
        3
    ],
    "state": "New York",
    "status": 2,
    "ticket_revenue_share_percentage": 0,
    "timezone": "Pacific/Niue",
    "timezone_utc_offset": "-1100",
    "title": "Chapter 2024",
    "total_tickets_sold_lifetime": 0,
    "twitter_handle": "bevy",
    "relative_url": "/chapter-2024/",
    "url": "https://instance.bevy.com/chapter-2024/",
    "use_external_ticketing": false,
    "use_new_newsletters": false,
    "website": "https://chapter-2024.com/",
    "language": "en",
    "chapter_lists": {},
    "external_extra_data": {},
    "members_count": 100,
    "parent_chapter": 8
}

Request

Body Params application/json
title
string 
required
Example:
Chapter 2024
description
string 
required
Example:
<p>lorem ipsum</p>
language
string 
required
Example:
en
hide_country_info
boolean 
optional
Example:
true
country
string 
required
Example:
EG
state
string 
optional
Example:
Cairo Governorate
city
string 
required
Example:
Cairo
timezone
string 
required
Example:
Africa/Cairo
latitude
number 
optional
Example:
30.0444196
longitude
number 
optional
Example:
31.2357116
status
string 
required
Example:
2
is_hidden
boolean 
optional
Example:
true
is_production_chapter
boolean 
required
Example:
false
is_city
boolean 
required
Example:
true
region
number 
required
Example:
12
parent_chapter
string 
required
Example:
8
currency
string 
required
Example:
USD
blog_category
string 
optional
Example:
5
twitter_handle
string 
optional
Example:
bevy
flickr_page
string 
optional
Example:
https://flickr.com/
facebook_page
string 
optional
Example:
https://facebook.com/
linkedin_page
string 
optional
Example:
https://linkedin.com/
instagram_handle
string 
optional
Example:
bevy
Examples

Responses

🟢201Created
application/json
Chapter created.
Body
active
boolean 
optional
Whether this groups is active or not.
Example:
true
allow_internal_list_management
boolean 
optional
Example:
true
available_months_last_12
number 
optional
Example:
0
banner_crop_vertical
number 
optional
The vertical crop of the group's banner. The value should be in the range of 0 and 100.
Example:
0
blog_category
number  | null 
optional
The id of the blog category to associate with this group.
Example:
4
chapter_location
string 
optional
Example:
Franklin (AL)
chapter_photos
array[object (ChapterPhoto) {3}] 
optional
id
number 
required
Example:
1234
order
number 
required
Example:
1
picture
object (Image) 
required
city
string 
optional
Example:
Franklin
could_update_meetup
boolean 
optional
Example:
false
country
string 
optional
The group's country in ISO 3166-2 two-letter format.
Example:
AL
country_name
string 
optional
Example:
Albania
created
string 
optional
Example:
2024-02-02T13:17:59.903551Z
cropped_banner_url
string 
optional
Example:
https://res.cloudinary.com/startup-grind/image/fetch/.../image.jpeg
currency
string 
optional
The string id of the currency for this group.
Example:
USD
description
string  | null 
optional
A brief description of the group.
Example:
lorem ipsum
event_activity_percentage_last_12
number 
optional
Example:
0
facebook_page
string  | null 
optional
Example:
https://facebook.com/
featured_video_url
string  | null 
optional
Example:
https://youtube.com/
flickr_page
string  | null 
optional
Example:
https://flickr.com/
health_indicator
array[number]
optional
Example:
[0,0,-1,-1,-1]
id
number 
optional
Example:
50
import_wp_events
boolean 
optional
Example:
false
imported_id
number  | null 
optional
Example:
1234
instagram_handle
string  | null 
optional
Example:
bevy
integrations
object 
optional
meetup
object  | null 
required
is_city
boolean 
optional
Example:
false
is_hidden
boolean 
optional
Whether this group should be hidden to those without the link or not.
Example:
false
is_production_chapter
boolean 
optional
Example:
true
hide_country_info
boolean 
optional
Whether to hide the country info or not.
Example:
false
latitude
number  | null 
optional
The latitude of the group's location.
Example:
30.0444196
linkedin_page
string  | null 
optional
Example:
https://linkedin.com/
logo
object 
optional
The group's logo. The value must come from the path value returned from an image uploaded to the image API.
url
string 
optional
Example:
https://res.cloudinary.com/startup-grind/image/upload/.../image.png
path
string 
optional
Example:
image.png
thumbnail_width
number 
optional
Example:
720
thumbnail_height
number 
optional
Example:
540
thumbnail_format
string 
optional
Example:
auto
thumbnail_url
string 
optional
Example:
https://res.cloudinary.com/startup-grind/image/upload/.../image.png
longitude
number  | null 
optional
The longitude of the group's location.
Example:
31.2357116
mailchimp_api_key
string  | null 
optional
Example:
1234567890abcdefg
mailchimp_list_id
string  | null 
optional
Example:
1234567890
media_partners
array[integer]
optional
The groups active associated partner ids.
Example:
[1,3]
media_partners_inactive
array[integer]
optional
The groups inactive associated partner ids.
Example:
[2]
meetup_api_key
string  | null 
optional
Example:
1234567890abcdefg
meetup_group
string  | null 
optional
Example:
Awesome NYC
monthly_events_last_12
number 
optional
Example:
0
on_team
boolean 
optional
Example:
false
payee_setup_process_url
string 
optional
Example:
https://instance.bevy.com/chapter-2024/payee-setup
chapter_team
array[object (ChapterTeamMember) {4}] 
optional
id
integer 
optional
Example:
1234
user
object (User) 
optional
role
object (ChapterTeamRole) 
optional
title
string 
optional
Example:
Lead Organizer
payment_lead
integer  | null 
optional
The user id of the group's payment lead.
Example:
10
picture
object (Image) 
optional
region
string 
optional
The id of this group's region. A list of regions can be found in the region API.
Example:
USA
rsvp_events_only
boolean 
optional
Example:
false
slug
string 
optional
Example:
chapter-2024
sponsors
array[integer]
optional
Example:
[1,2]
sponsors_inactive
array[integer]
optional
Example:
[3]
state
string 
optional
Example:
New York
status
number 
optional
The id of this group's status. A list of ids can be found in the group status API.
Example:
2
ticket_revenue_share_percentage
number 
optional
The ticket revenue share percentage between the chapter and HQ on a scale from 0.0 to 1.0.
Example:
0
timezone
string 
optional
The group's timezone. Example: America/Chicago
Example:
Pacific/Niue
timezone_utc_offset
string 
optional
Example:
-1100
title
string 
optional
Example:
Chapter 2024
total_tickets_sold_lifetime
number 
optional
Example:
0
twitter_handle
string  | null 
optional
The group's Twitter handle. The @ symbol is not required.
Example:
bevy
relative_url
string 
optional
Example:
/chapter-2024/
url
string 
optional
Example:
https://instance.bevy.com/chapter-2024/
use_external_ticketing
boolean 
optional
Example:
false
use_new_newsletters
boolean 
optional
Example:
false
website
string 
optional
Example:
https://chapter-2024.com/
language
string 
optional
The language id for this group in a lowercase ISO 639 format.
Example:
en
chapter_lists
object 
optional
external_extra_data
object 
optional
members_count
number 
optional
Example:
100
parent_chapter
number  | null 
optional
Example:
8
🟠400Bad Request
🟠403Forbidden
Previous
Get Chapter Regions
Next
List chapters
Built with