Skip to main content
PUT
/
api
/
content
/
subscribergroups
Update SubscriberGroup
curl --request PUT \
  --url https://spaces.nexudus.com/api/content/subscribergroups \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "Name": "<string>"
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
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

Id
integer
required
The Id of the SubscriberGroup record to update.
BusinessId
integer
required
ID of the business linked to this record.
Name
string
required
The name value for this subscriber group.

Optional Fields

NewsLetterSubscribers
integer[]
List of news letter subscribers linked to this record.
AddedNewsLetterSubscribers
integer[]
The added news letter subscribers value for this subscriber group.
RemovedNewsLetterSubscribers
integer[]
The removed news letter subscribers value for this subscriber group.
AutoAddMembers
boolean
Whether auto add members is enabled.
AutoAddContacts
boolean
Whether auto add contacts is enabled.
AutoAddBookings
boolean
Whether auto add bookings is enabled.
AutoAddEvents
boolean
Whether auto add events is enabled.
AutoAddVisitors
boolean
Whether auto add visitors is enabled.
AutoAddPayingMembers
boolean
Whether auto add paying members is enabled.
Tariffs
integer[]
List of tariffs linked to this record.
AddedTariffs
integer[]
The added tariffs value for this subscriber group.
RemovedTariffs
integer[]
The removed tariffs value for this subscriber group.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/content/subscribergroups" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "Id": 87654321
}'

Response

200

Status
integer
HTTP status code. 200 on success.
Message
string
A human-readable message confirming the update.
Value
object
Contains the Id of the updated record.
WasSuccessful
boolean
true if the subscribergroup was updated successfully.
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "SubscriberGroup was successfully updated.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

Message
string
A summary of the validation error(s), in the format PropertyName: error message.
Value
any
null on validation failure.
Errors
object[]
Array of validation errors.
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}