1. API
  2. Groups

groups/edit

Edit an existing group.

POST
 https://api.elvanto.com/v1/groups/edit.{json|xml|php}

Notes

  • As of 2.2 the meeting_day and meeting_time parameters are no longer used and meeting_frequency has been reworked to support new group meeting frequencies. All three parameters will work as they did before the update for backwards compatibility but if you would like to take advantage of new parameters such as meeting_start_date then we recommend you update to the latest format.

Parameters

Name Type Description
id Required string The ID of the group.
name string The name of the group.
status string The status of the group.
Accepted Values: active or suspended.
meeting_address string The meeting address of the group.
meeting_city string The meeting city of the group.
meeting_state string The meeting state of the group.
meeting_postcode string The meeting postcode or zip of the group.
meeting_country string The meeting country of the group.
meeting_start_date date The date the group commenced. E.g: 2024-12-30
meeting_start_time string The time of day that the group meets. Needs to be in a valid time format. E.g: 1:00 PM or 13:00
meeting_end_time string The time of day that the group finishes its meeting. Needs to be in a valid time format. E.g: 1:00 PM or 13:00
meeting_end_date date The date the group finishes. E.g: 2024-12-30
meeting_frequency array How often the group meets.
Keys and their accepted values:
type - weekly or monthly
count - the amount of weeks/months between meetings
day - the name of the day the group meets
occurrence (only required for monthly meetings) - an array of one or more values: 1, 2, 3, 4, 5, last
fields array The extra fields you would like to add to the group. More information on group fields.
Expected request JSON HTTP POST 
{
    "id": "57beccc8-af4a-11e0-9b4e-f27fa4b6a61b",
    "name": "Women's Connect",
    "status": "Active",
    "meeting_address": "123 Sandra Street",
    "meeting_city": "Potsworth",
    "meeting_state": "QLD",
    "meeting_postcode": "4321",
    "meeting_country": "Australia",
    "meeting_start_date": "2024-12-30",
    "meeting_start_time": "6:00 AM",
    "meeting_end_time": "7:00 AM",
    "meeting_end_date": "2029-12-30",
    "meeting_frequency": {
        "type": "monthly",
        "count": 2,
        "day": "Tuesday",
        "occurrence": [
            1,
            3,
            "last"
        ]
    },
    "fields": {
        "categories": [
            "Small Groups",
            "Connect Groups"
        ]
    }
}
Expected response JSON XML PHP 
{
    "generated_in": "0.021",
    "status": "ok",
    "group": {
        "id": "57beccc8-af4a-11e0-9b4e-f27fa4b6a61b"
    }
}
Error responses

Please see our response status codes documentation for details of potential error responses for any API request.

  • 404: Invalid Group ID The Group ID you provided does not exist.