NewsLetterSubscribers
Update NewsLetterSubscriber
Update an existing NewsLetterSubscriber record.
PUT
Update NewsLetterSubscriber
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
eLanguage — Language values
eLanguage — Language values
| Value | Name |
|---|---|
| 3 | EnglishUK |
| 1 | EnglishUS |
| 2 | Spanish |
Request Body
Required Fields
The Id of the NewsLetterSubscriber record to update.
ID of the business linked to this record.
The name value for this news letter subscriber.
The language value for this news letter subscriber.
The email value for this news letter subscriber.
Optional Fields
The company name value for this news letter subscriber.
The visit reason value for this news letter subscriber.
Whether this news letter subscriber is currently active.
List of groups linked to this record.
The added groups value for this news letter subscriber.
The removed groups value for this news letter subscriber.
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 newslettersubscriber 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 NewsLetterSubscriber