POST v3/subscribers

https://api.questline.com/v3/subscribers

Creates a new subscriber.

Request Information

URI Parameters

None.

Body Parameters

The request body.

PostSubscriberRequestV3
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.
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.
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",
  "LastName": "sample string 4",
  "SmsNumber": "sample string 5",
  "SubscriberKey": "sample string 6",
  "AccountManager": "sample string 7",
  "AccountNumber": "sample string 8",
  "AddressLine1": "sample string 9",
  "AddressLine2": "sample string 10",
  "City": "sample string 11",
  "Company": "sample string 12",
  "State": "sample string 13",
  "ZipCode": "sample string 14",
  "PreferredContentTopics": "sample string 15",
  "PreferredMediaTypes": "sample string 16",
  "LanguagePreference": "sample string 17"
}

Response Information

Resource Description

PostSubscriberResponseV3
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-11-03T02:41:46.0599362+00:00",
    "FaxNumber": "sample string 3",
    "FirstName": "sample string 4",
    "HasEmail": true,
    "HasFax": true,
    "HasSms": true,
    "LastName": "sample string 8",
    "Modified": "2025-11-03T02:41:46.0599362+00:00",
    "SmsNumber": "sample string 10",
    "SubscriberId": "4b276d31-cd08-4737-94a7-8ad029d36e9a",
    "SubscriberKey": "sample string 12",
    "Subscriptions": [
      {
        "Name": "sample string 1",
        "ReceiveEmail": true,
        "ReceiveFax": true,
        "ReceiveSms": true,
        "SubscriptionId": "c58b9c47-88c2-4d80-a19b-b818f2b49a52"
      },
      {
        "Name": "sample string 1",
        "ReceiveEmail": true,
        "ReceiveFax": true,
        "ReceiveSms": true,
        "SubscriptionId": "c58b9c47-88c2-4d80-a19b-b818f2b49a52"
      }
    ],
    "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-11-03T02:41:46.0599362+00:00","FaxNumber":"sample string 3","FirstName":"sample string 4","HasEmail":true,"HasFax":true,"HasSms":true,"LastName":"sample string 8","Modified":"2025-11-03T02:41:46.0599362+00:00","SmsNumber":"sample string 10","SubscriberId":"4b276d31-cd08-4737-94a7-8ad029d36e9a","SubscriberKey":"sample string 12","Subscriptions":[{"Name":"sample string 1","ReceiveEmail":true,"ReceiveFax":true,"ReceiveSms":true,"SubscriptionId":"c58b9c47-88c2-4d80-a19b-b818f2b49a52"},{"Name":"sample string 1","ReceiveEmail":true,"ReceiveFax":true,"ReceiveSms":true,"SubscriptionId":"c58b9c47-88c2-4d80-a19b-b818f2b49a52"}],"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"}});