Fields

Fields retrieved for all group method calls

When retrieving groups, the following fields will be returned by default.

Optional fields for group method calls

When retrieving, creating or editing groups, there are optional fields you can use. If creating or editing a group, none of these fields are required.

Advanced: Categories

Use the categories field to add Categories to a group.

{
    "id": "xxxx",
    "fields": {
        "categories": [
            "Small Groups",
            "Ministries"
        ]
    }
}

id=xxxx&fields%5Bcategories%5D%5B0%5D=Small+Groups&fields%5Bcategories%5D%5B1%5D=Ministries

If you would like to replace a group's Categories, simply use the categories_replace field instead. This will remove the group's current Categories and replace with the ones you specify.

{
    "id": "xxxx",
    "fields": {
        "categories_replace": [
            "Small Groups",
            "Ministries"
        ]
    }
}

id=xxxx&fields%5Bcategories_replace%5D%5B0%5D=Small+Groups&fields%5Bcategories_replace%5D%5B1%5D=Ministries

To remove specific Categories from a group, use the categories_remove field.

{
    "id": "xxxx",
    "fields": {
        "categories_remove": [
            "Small Groups",
            "Ministries"
        ]
    }
}

id=xxxx&fields%5Bcategories_remove%5D%5B0%5D=Small+Groups&fields%5Bcategories_remove%5D%5B1%5D=Ministries

Advanced: Departments

Use the departments field to add Departments to a group.

Departments have two levels: Department & Sub-departments. To add a department, you must separate each level with ||.

E.g: Worship Team||Band (or Worship+Team%7C%7CBand when url-encoded)

{
    "id": "xxxx",
    "fields": {
        "departments": [
            "Worship Team||Band",
            "Worship Team||Vocals"
        ]
    }
}

id=xxxx&fields%5Bdepartments%5D%5B0%5D=Worship+Team%7C%7CBand&fields%5Bdepartments%5D%5B1%5D=Worship+Team%7C%7CVocals

If you would like to replace a group's Departments, simply use the departments_replace field instead. This will remove the group's current Departments and replace with the ones you specify.

{
    "id": "xxxx",
    "fields": {
        "departments_replace": [
            "Worship Team||Band",
            "Worship Team||Vocals"
        ]
    }
}

id=xxxx&fields%5Bdepartments_replace%5D%5B0%5D=Worship+Team%7C%7CBand&fields%5Bdepartments_replace%5D%5B1%5D=Worship+Team%7C%7CVocals

To remove specific Departments from a group, use the departments_remove field.

{
    "id": "xxxx",
    "fields": {
        "departments_remove": [
            "Worship Team||Band",
            "Worship Team||Vocals"
        ]
    }
}

id=xxxx&fields%5Bdepartments_remove%5D%5B0%5D=Worship+Team%7C%7CBand&fields%5Bdepartments_remove%5D%5B1%5D=Worship+Team%7C%7CVocals

Advanced: Demographics

Use the demographics field to add Demographics to a group.

{
    "id": "xxxx",
    "fields": {
        "demographics": [
            "Adults",
            "Seniors"
        ]
    }
}

id=xxxx&fields%5Bdemographics%5D%5B0%5D=Adults&fields%5Bdemographics%5D%5B1%5D=Seniors

If you would like to replace a group's Demographics, simply use the demographics_replace field instead. This will remove the group's current Demographics and replace with the ones you specify.

{
    "id": "xxxx",
    "fields": {
        "demographics_replace": [
            "Adults",
            "Seniors"
        ]
    }
}

id=xxxx&fields%5Bdemographics_replace%5D%5B0%5D=Adults&fields%5Bdemographics_replace%5D%5B1%5D=Seniors

To remove specific Demographics from a group, use the demographics_remove field.

{
    "id": "xxxx",
    "fields": {
        "demographics_remove": [
            "Adults",
            "Seniors"
        ]
    }
}

id=xxxx&fields%5Bdemographics_remove%5D%5B0%5D=Adults&fields%5Bdemographics_remove%5D%5B1%5D=Seniors

Advanced: Locations

Use the locations field to add Locations to a group.

{
    "id": "xxxx",
    "fields": {
        "locations": [
            "North",
            "Central"
        ]
    }
}

id=xxxx&fields%5Blocations%5D%5B0%5D=North&fields%5Blocations%5D%5B1%5D=Central

If you would like to replace a group's Locations, simply use the locations_replace field instead. This will remove the group's current Locations and replace with the ones you specify.

{
    "id": "xxxx",
    "fields": {
        "locations_replace": [
            "North",
            "Central"
        ]
    }
}

id=xxxx&fields%5Blocations_replace%5D%5B0%5D=North&fields%5Blocations_replace%5D%5B1%5D=Central

To remove specific Locations from a group, use the locations_remove field.

{
    "id": "xxxx",
    "fields": {
        "locations_remove": [
            "North",
            "Central"
        ]
    }
}

id=xxxx&fields%5Blocations_remove%5D%5B0%5D=North&fields%5Blocations_remove%5D%5B1%5D=Central