SubscriberGroups
Update SubscriberGroup
Update an existing SubscriberGroup record.
PUT
Update SubscriberGroup
Updates an existing SubscriberGroup record. You must include the
Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the SubscriberGroup-Edit role.Request Body
Required Fields
The Id of the SubscriberGroup record to update.
ID of the business linked to this record.
The name value for this subscriber group.
Optional Fields
List of news letter subscribers linked to this record.
The added news letter subscribers value for this subscriber group.
The removed news letter subscribers value for this subscriber group.
Whether auto add members is enabled.
Whether auto add contacts is enabled.
Whether auto add bookings is enabled.
Whether auto add events is enabled.
Whether auto add visitors is enabled.
Whether auto add paying members is enabled.
List of tariffs linked to this record.
The added tariffs value for this subscriber group.
The removed tariffs value for this subscriber group.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the update.
Contains the
Id of the updated record.true if the subscribergroup was updated successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response
Update SubscriberGroup