Update a subscriber
Describes the request and response details of this Moosend API endpoint to update a subscriber in your email list.
Request
|
Parameter |
In |
Type |
Required |
Description |
|---|---|---|---|---|
|
|
header |
string |
true |
Determines the expected format and data type to retrieve the response data. Value: |
|
|
path |
string |
true |
The ID of the email list that contains the subscriber. |
|
|
path |
string |
true |
The ID of the subscriber that you want to update. |
|
|
path |
string |
true |
The supported file format for getting a response. Possible values: |
|
|
query |
string |
true |
The API key of your account |
|
|
body |
string |
false |
The name of the subscriber. |
|
|
body |
string |
true |
The email address of the subscriber. |
|
|
body |
Boolean |
false |
When |
|
|
body |
array |
false |
A list of name-value pairs that match the subscriber’s custom fields defined in the email list. For example, if you have two custom fields for |
|
|
body |
object |
false |
The member tag you can use to filter members by when working with an email list. |
|
|
body |
object |
false |
The member preferences you can user to segment or filter members by, when working with an email list. |
Response
|
Status |
Description |
Headers |
Schema |
|---|---|---|---|
|
|
The request is successful. |
|
N/A |
-
Code- the response code. This is0if successful. -
Error- the response error message. This isnullif successful. -
Context- an object that contains all the following information for the updated subscriber:-
ID- the ID of the subscriber. -
Name- the name of the subscriber. -
Email- the email address of the subscriber. -
CreatedOn- the date-time the subscriber was added to the email list. -
UnsubscribedOn- the date-time the subscriber was unsubscribed from the email list. This isnullif not unsubscribed from the list. -
UnsubscribedFromID- the ID that the subscriber is unsubscribed from. -
SubscribeType- the status of the subscriber. For subscribed, this is1, for unsubscribed, this is2, for bounced, this is3, and for removed, this is4. -
SubscribeMethod- the method used to subscribe the member to the email list. For subscription forms, this is0, for file imports, this is1, for manually added, this is2. -
CustomFields- a list containing the custom fields of the new subscriber. Each custom field contains the following:-
CustomFieldID- the ID of the custom field. -
Name- the name of the custom field. -
Value- the value of the custom field.
-
-
RemovedOn- the date-time the subscriber was removed from the email list. -
Tags- a list containing the tags of the new subscriber.
-