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

Enums

ValueName
3EnglishUK
1EnglishUS
2Spanish

Request Body

Required Fields

Id
integer
required
The Id of the NewsLetterSubscriber record to update.
BusinessId
integer
required
ID of the business linked to this record.
Name
string
required
The name value for this news letter subscriber.
Language
integer
required
The language value for this news letter subscriber.
Email
string
required
The email value for this news letter subscriber.

Optional Fields

CompanyName
string
The company name value for this news letter subscriber.
VisitReason
string
The visit reason value for this news letter subscriber.
Active
boolean
Whether this news letter subscriber is currently active.
Groups
integer[]
List of groups linked to this record.
AddedGroups
integer[]
The added groups value for this news letter subscriber.
RemovedGroups
integer[]
The removed groups value for this news letter subscriber.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/content/newslettersubscribers" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "Language": 0,
    "Email": "",
    "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 newslettersubscriber was updated successfully.
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "NewsLetterSubscriber 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
}