Welcome‎ > ‎Version 3‎ > ‎Publisher Api‎ > ‎Methods‎ > ‎6 - Subscription Management‎ > ‎

Update Subscription Info

Will update subscription information for a specific subscriber (by email address) at the publisher's third party email service provider.  If the subscriber does not exist, it will be created in the third party system.

Method: PUT /api/v3/publisher/subscription/{email}
Authentication: oauth

Parameters:
email - The email address of the subscriber whose information is being updated.
 
Put:
Required Form Name Data Type Explanation
No
AdditionalFields[0...n].Key string The list of keys for the additional demographic fields for the subscriber (corresponding value entry must go in AdditionalFields[0...n].Value)
No
AdditionalFields[0...n].Value
string
The list of values for the additional demographic fields for the subscriber (corresponding key entry must go in AdditionalFields[0...n].Key)
No AffiliateInfo.AffiliateId int When recording affiliate tracking, the id of the affiliate.
No AffiliateInfo.AffiliateSource string When recoding affiliate tracking, the source of the affiliate.
No AffiliateInfo.CreateTicks int64 When recording affiliate tracking, the Unix time or POSIX time the affiliate tracking started recording. 
No ChangeEmail
string Use this field to change the subscriber's email address at the third party. This is the new email address of the subscriber, and the Email field will contain the old (current) email address of the subscriber.
No FirstName string The first name of the subscriber.
No
GlobalOptOut
bool
Whether or not to opt this subscriber out of every list at the third party.  There is no default value, so if an email address has previously been opted out, it is necessary to set this value to false to opt the email back in.
NoIpAddress
string
The ip address of the subscriber.
No
LastName
string
The last name of the subscriber.
No
SubscriberListOptions[0...n] .ListKey
string
The list of list keys identifying lists to opt the subscriber in or out of at the third party (each entry must have a corresponding entry in SubscriberListOptions[0...n] .OptIn.
NoSubscriberListOptions[0...n] .OptInbool
The list of opt in/out values indicating whether or not the subscriber is opting in or out of specific lists at the third party.
No
SendEmail
bool
If true, a subscription verification email will be sent to the subscriber (true by default)
No
ZipCode
string
The zip code of the subscriber.

Returns
base response fields


Sample Request:

PUT http://api.groupcommerce.com/api/v3/publisher/subscription/noreply%40groupcommerce.com

Form: AdditionalFields%5B0%5D.Key=oneAdditionalField&AdditionalFields%5B0%5D.Value=andAValue&AffiliateInfo.AffiliateId=123&AffiliateInfo.AffiliateSource=affiliatesourcetext&AffiliateInfo.CreateUnixTimestamp=341144&Email=noreply%40groupcommerce.com&FirstName=Jeremy&GlobalOptOut=&IPAddress=184.74.178.114&LastName=Lin&SubscriberListOptions%5B0%5D.ListKey=ny&SubscriberListOptions%5B0%5D.OptIn=True&SubscriberListOptions%5B1%5D.ListKey=10012&SubscriberListOptions%5B1%5D.OptIn=False&SendEmail=False&ZipCode=10025

OAuth oauth_signature="2MWlWU%2btdoSAkpbbChbRJqHC3eg%3d", oauth_nonce="9005909", oauth_timestamp="1319762439", oauth_consumer_key="eeb6b959-b854-4ad1-b563-e801c83cf81d", oauth_signature_method="HMAC-SHA1", oauth_version="1.0"


Sample JSON Response:

{
    "errors":[],
    "lastPublished": "\/Date(1331851510281)\/",
    "success":true,
    "version":"3"
}


Sample XML Response:

<updateSubscriptionInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <errors />
  <lastPublished>2012-03-15T22:45:48.2625874Z</lastPublished>
  <success>true</success>
  <version>3</version>
</updateSubscriptionInfoResponse>
Comments