Fields

Fields retrieved for all people method calls

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

Optional fields for people method calls

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

Advanced: Access Permissions

Use the access_permissions field to add Access Permissions to a person.

{
    "id": "xxxx",
    "fields": {
        "access_permissions": [
            "Leader",
            "Preacher"
        ]
    }
}

id=xxxx&fields%5Baccess_permissions%5D%5B0%5D=Leader&fields%5Baccess_permissions%5D%5B1%5D=Preacher

If you would like to replace a person's Access Permissions, simply use the access_permissions_replace field instead. This will remove the person's current Access Permissions and replace with the ones you specify.

{
    "id": "xxxx",
    "fields": {
        "access_permissions_replace": [
            "Leader",
            "Preacher"
        ]
    }
}

id=xxxx&fields%5Baccess_permissions_replace%5D%5B0%5D=Leader&fields%5Baccess_permissions_replace%5D%5B1%5D=Preacher

To remove specific Access Permissions from a person, use the access_permissions_remove field.

{
    "id": "xxxx",
    "fields": {
        "access_permissions_remove": [
            "Leader",
            "Preacher"
        ]
    }
}

id=xxxx&fields%5Baccess_permissions_remove%5D%5B0%5D=Leader&fields%5Baccess_permissions_remove%5D%5B1%5D=Preacher

Advanced: Departments

Use the departments field to add Departments to a person.

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

You can add Departments as a string by separating them by a comma.

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

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

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

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

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

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

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

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

Advanced: Service Types

Use the service_types field to add Service Types to a person.

{
    "id": "xxxx",
    "fields": {
        "service_types": [
            "Sunday Morning",
            "Sunday Night"
        ]
    }
}

id=xxxx&fields%5Bservice_types%5D%5B0%5D=Sunday+Morning&fields%5Bservice_types%5D%5B1%5D=Sunday+Night

If you would like to replace a person's Service Types, simply use the service_types_replace field instead. This will remove the person's current Service Types and replace with the ones you specify.

{
    "id": "xxxx",
    "fields": {
        "service_types_replace": [
            "Sunday Night",
            "Friday Night"
        ]
    }
}

id=xxxx&fields%5Bservice_types_replace%5D%5B0%5D=Sunday+Night&fields%5Bservice_types_replace%5D%5B1%5D=Friday+Night

To remove specific Service Types from a person, use the service_types_remove field.

{
    "id": "xxxx",
    "fields": {
        "service_types_remove": [
            "Sunday Morning",
            "Friday Night"
        ]
    }
}

id=xxxx&fields%5Bservice_types_remove%5D%5B0%5D=Sunday+Morning&fields%5Bservice_types_remove%5D%5B1%5D=Friday+Night

Advanced: Demographics

Use the demographics field to add Demographics to a person.

{
    "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 person's Demographics, simply use the demographics_replace field instead. This will remove the person's current Demographics and replace with the ones you specify.

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

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

To remove specific Demographics from a person, 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 person.

{
    "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 person's Locations, simply use the locations_replace field instead. This will remove the person's current Locations and replace with the ones you specify.

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

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

To remove specific Locations from a person, 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