PUT v3/subscribers/{subscriberId}

https://api.questline.com/v3/subscribers/{subscriberId}

Updates an existing subscriber. Requires all fields in the request body to be sent; fields not sent in the request body will be cleared out.

Request Information

URI Parameters

Name Description Type Additional Info
subscriberId The ID of the subscriber. globally unique identifier Required

Body Parameters

The request body.

PutSubscriberRequestV3
Name Description Type Additional Info
Address The email address of the subscriber. string None.
Attributes The list of attributes for the subscriber. Collection of SubscriberAttributeV3 None.
FaxNumber The fax number of the subscriber. string None.
FirstName The first name of the subscriber. string None.
HasEmail Flag that determines if the subscriber's global email channel is turned on. boolean None.
HasFax Flag that determines if the subscriber's global fax channel is turned on. boolean None.
HasSms Flag that determines if the subscriber's global SMS channel is turned on. boolean None.
LastName The last name of the subscriber. string None.
SmsNumber The SMS number of the subscriber. string None.
SubscriberKey The key of the subscriber. string None.
Suppressed Flag that determines if the subscriber is suppressed. boolean None.
AccountManager The name of the subscriber's account mananger. string None.
AccountNumber Number associating the subscriber with a non-Engage account. string None.
AddressLine1 The subscriber's primary address. string None.
AddressLine2 Additional address information for the subscriber. string None.
City What city the subscriber is in. string None.
Company The subscriber's company name. string None.
State The subscriber's state of residence. string None.
ZipCode The subscriber's ZIP code. string None.
PreferredContentTopics The subscriber's preferred content topics. string None.
PreferredMediaTypes The subscriber's preferred media types. string None.
LanguagePreference The subscriber's preferred language. string None.

Request Formats

application/json, text/json

Sample:

{
  "Address": "sample string 1",
  "Attributes": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "FaxNumber": "sample string 2",
  "FirstName": "sample string 3",
  "HasEmail": true,
  "HasFax": true,
  "HasSms": true,
  "LastName": "sample string 7",
  "SmsNumber": "sample string 8",
  "SubscriberKey": "sample string 9",
  "Suppressed": true,
  "AccountManager": "sample string 11",
  "AccountNumber": "sample string 12",
  "AddressLine1": "sample string 13",
  "AddressLine2": "sample string 14",
  "City": "sample string 15",
  "Company": "sample string 16",
  "State": "sample string 17",
  "ZipCode": "sample string 18",
  "PreferredContentTopics": "sample string 19",
  "PreferredMediaTypes": "sample string 20",
  "LanguagePreference": "sample string 21"
}

Response Information

Resource Description

PutSubscriberResponseV3
Name Description Type Additional Info
Subscriber The subscriber. SubscriberV3 None.
Error The response error, if any. ResponseErrorV3 None.

Response Formats

application/json, text/json

Sample:

{
  "Subscriber": {
    "Address": "sample string 1",
    "Attributes": [
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "Created": "2025-10-28T01:34:57.91661+00:00",
    "FaxNumber": "sample string 3",
    "FirstName": "sample string 4",
    "HasEmail": true,
    "HasFax": true,
    "HasSms": true,
    "LastName": "sample string 8",
    "Modified": "2025-10-28T01:34:57.91661+00:00",
    "SmsNumber": "sample string 10",
    "SubscriberId": "b155462d-c312-4d58-91f1-43845032c4d4",
    "SubscriberKey": "sample string 12",
    "Subscriptions": [
      {
        "Name": "sample string 1",
        "ReceiveEmail": true,
        "ReceiveFax": true,
        "ReceiveSms": true,
        "SubscriptionId": "f46214b4-c106-4f7d-92e4-0066a62f165f"
      },
      {
        "Name": "sample string 1",
        "ReceiveEmail": true,
        "ReceiveFax": true,
        "ReceiveSms": true,
        "SubscriptionId": "f46214b4-c106-4f7d-92e4-0066a62f165f"
      }
    ],
    "Suppressed": true,
    "AccountManager": "sample string 14",
    "AccountNumber": "sample string 15",
    "AddressLine1": "sample string 16",
    "AddressLine2": "sample string 17",
    "City": "sample string 18",
    "Company": "sample string 19",
    "State": "sample string 20",
    "ZipCode": "sample string 21",
    "PreferredContentTopics": "sample string 22",
    "PreferredMediaTypes": "sample string 23",
    "LanguagePreference": "sample string 24"
  },
  "Error": {
    "ErrorId": 1,
    "ErrorMessage": "sample string 1"
  }
}

text/javascript, application/javascript, application/json-p

Sample:

/**/ typeof  === 'function' && ({"Subscriber":{"Address":"sample string 1","Attributes":[{"Name":"sample string 1","Value":"sample string 2"},{"Name":"sample string 1","Value":"sample string 2"}],"Created":"2025-10-28T01:34:57.91661+00:00","FaxNumber":"sample string 3","FirstName":"sample string 4","HasEmail":true,"HasFax":true,"HasSms":true,"LastName":"sample string 8","Modified":"2025-10-28T01:34:57.91661+00:00","SmsNumber":"sample string 10","SubscriberId":"b155462d-c312-4d58-91f1-43845032c4d4","SubscriberKey":"sample string 12","Subscriptions":[{"Name":"sample string 1","ReceiveEmail":true,"ReceiveFax":true,"ReceiveSms":true,"SubscriptionId":"f46214b4-c106-4f7d-92e4-0066a62f165f"},{"Name":"sample string 1","ReceiveEmail":true,"ReceiveFax":true,"ReceiveSms":true,"SubscriptionId":"f46214b4-c106-4f7d-92e4-0066a62f165f"}],"Suppressed":true,"AccountManager":"sample string 14","AccountNumber":"sample string 15","AddressLine1":"sample string 16","AddressLine2":"sample string 17","City":"sample string 18","Company":"sample string 19","State":"sample string 20","ZipCode":"sample string 21","PreferredContentTopics":"sample string 22","PreferredMediaTypes":"sample string 23","LanguagePreference":"sample string 24"},"Error":{"ErrorId":1,"ErrorMessage":"sample string 1"}});