Page Comparison

ClientCustomerId (deprecated)

optional

This field is being deprecated, please use ExternalCustomerId instead. The id of the customer in the external/interfacing system. This id is assumed to be unique within the brand and is used to lookup the record in the internal database in order to determine whether an insert or update is made. If you plan on using OmedaCustomerId as the way to identify the user, do not pass in this element.

OmedaCustomerId

optional

the internal id of the customer. This id is unique. Providing this guarantees that identityresolution processing will be bypassed. You should provide this id only if you are certain that the data provided in this call is definitely associated with the individual specified by the id. If you plan on using ClientCustomerId as the way to identify the user, do not pass in this element.

ExternalCustomerId

optional

the external customer id that can be used to identity a customer.

ExternalCustomerIdNamespace

optional

the namespace that is associated with which the ExternalCustomerId will be associated with. Please contact your Omeda Account Manager to determine what needs to be sent in here. It is recommended if the ExternalCustomerId is on the request, that this field is also set, otherwise the default will be used, if there is no default an error will be returned.

Salutation

optional

salutation (Ms., Mr. , Dr. etc) of customer, up 10 characters long

FirstName

optional

first name of customer, up to 100 characters long

MiddleName

optional

middle name of customer, up to 100 characters long

LastName

optional

last name of customer, up to 100 characters long

Suffix

optional

suffix of customer (Jr. Sr., III, etc.) , up to 10 characters long

Title

optional

job title, up to 100 characters long

Gender

optional

(M,F) male=M, female=F

SignupDate

optional

Two formats are available: yyyy-MM-dd and yyyy-MM-dd HH:mm. Date the person signed up

ClientOrderId

optional

Client assigned order ID.This is an integer value.

PromoCode

optional

Promocode for all product orders in this call,up to 50 char long.

OrderDate

optional

Date of order, If missed, default is today’s date. Two formats are available: yyyy-MM-dd and yyyy-MM-dd HH:mm.

Addresses

optional

JSON element containing multiple Address elements (see below)

Phones

optional

JSON element containing multiple Phone elements (see below)

Emails

optional

JSON element containing multiple Email elements (see below)

CustomerDemographics

optional

JSON element containing multiple CustomerDemographic elements (see below)

Products

optional

JSON element containing multiple Product Elements elements (see below)

ProductUpdates

optional

JSON element containing multiple Product Updates Elements elements (see below)

Telemarketing

optional

JSON element containing multiple Telemarketing Elements elements (see below)

DonorId

optional

This field is used for Gift Subscriptions. DonorId is the OmedaCustomerId of a different existing customer who is giving gift subscription(s). If provided, all subscriptions for this transaction will be considered Gift Subscriptions given by the DonorId customer.

MergeCode

optional

This field is used to specify whether the customer record should be mergeable or non-mergeable. When a mergeable record is processed, if another customer record sufficiently matches the merge criteria, the data from both records will be merged into one record. Valid values are “1”, indicating the record is mergeable, and “0”, indicating the record is non-mergeable. If no value is provided, the default value is “1”.

AddressContactType

optional

see Address Contact Types. If none is provided, 100 (business) is assumed.

Company

optional

if the address contains a company name put it here, up to 255 characters long. Do not use the Street, ApartmentMailStop, or ExtraAddress fields to store company name information.

Street

optional

first line of street address, up to 255 characters long

ApartmentMailStop

optional

apartment, mail stop or suite number, up to 255 characters long

ExtraAddress

optional

last line of street address, only if necessary, up to 255 characters long

City

optional

city name, up to 100 characters long

RegionCode

optional

For country_code=’USA’ or ‘CAN’, this must be the 2-character US state or Canadian code used by the postal service. Omeda also has region codes for other countries of the world

Region

optional

name of region. Only used when region_code cannot be given. Should contain the region, up to 100 characters long.

PostalCode

optional

ZIP code or postal code.

CountryCode

optional

3-character country code

Country

optional

Name of country. Only used when country code cannot be provided. Should contain the country, up to 100 characters long.

AddressProducts

optional

Comma-separated list of product ids to associate this address with or one of the following keywords; “ALL” (All products), “NONE” (No Products), “ALL_PRINT” (All Products that are of “Magazine” type), “ALL_NEWSLETTER” (All Products that are of “Newsletter” type. If omitted, default is “NONE”.

Airmail

optional

If including this entry in the JSON the only valid submissions are “A” or an empty string””. An empty string is the only way to clear an existing entry of “A”.

EmailContactType

optional

see Email Contact Types. If none is provided, 300 (primary/business) is assumed.

EmailAddress

required

email address, must be properly formatted

EmailProducts

optional

Comma-separated list of product ids to associate this email address with or one of the following keywords; “ALL” (All products), “NONE” (No Products), “ALL_PRINT” (All Products that are of “Magazine” type), “ALL_NEWSLETTER” (All Products that are of “Newsletter” type. If ommitted, default is “NONE”.

PhoneContactType

optional

see Phone Contact Types. If none is provided, 200 (business) is assumed.

Number

required

phone number

Extension

optional

separate extension digits, if known

OmedaDemographicId

conditional

Identifier that specifies the explicit omeda demographic ID. This is an integer value.

OmedaDemographicValue

conditional

Holds the explicit value id that is associated with the OmedaDemographicId provided above. This is a String value. If OmedaDemographicId is present then OmedaDemographicValue must be present.

WriteInDesc

optional

“Other” text description, 100 char max. Only single response and multi response demographics can have values for the WriteInDesc field and only applicable to demographic values with value type of “Other”.

OmedaProductId

conditional

integer

Explicit Omeda product id for the product being requested. Note: If any product information is provided then OmedaProductId must be given.Only Magazines (productType=1) and Newsletters (productType=2) can be updated via this API. Use the OptIn/Optout APIs forEmail Deployment updates (productType=5) and the Assign Behavior API for Event updates (prouductType=3). For a full list of types-queue see Product Types.

Receive

optional

short

1 = opt-in, 0 = opt-out. Assumed to be 1 if not given. Explicitly allows this order service to capture opt-out behaviors as part of the order transaction.

Quantity

optional

integer

Quantity requested. Assumed to be 1 if not given.

PersonalIdentifier

optional

string

A Personal Identifier for the product. For example, “What is your Eye Color?” Maximum of 50 characters.

RequestedVersion

optional

char

Applicable only for products that have different versions (‘P’ for print, ‘D’ for digital, ‘B’ for both).

ShippingAddressId

optional

integer

Explicit Omeda postal address id for the customer. Note: if submitted, OmedaCustomerId must be given.

EmailAddressId

optional

integer

Explicit Omeda email address id for the customer. Note: if submitted, OmedaCustomerId must be given.

Sku

conditional

string

Product code or tracking number. Required for Single Copy Sales products.

OmedaProductIdUpdate

required

integer

Explicit Omeda product id for the product being requested. Note: If any product information is provided then OmedaProductIdUpdate must be given.Only Magazines (productType=1) and Newsletters (productType=2) can be updated via this API. Use the OptIn/Optout APIs forEmail Deployment updates (productType=5) and the Assign Behavior API for Event updates (prouductType=3). For a full list of types see Product Types.

RequestedVersionUpdate

required

char

Applicable only for products that have different versions (‘P’ for print, ‘D’ for digital, ‘B’ for both).

OmedaProductId

required

integer

Explicit Omeda product id for the product being requested.Only Marketing Products (productType=11) can be updated via this element.

ShippingAddressId

optional

integer

Explicit Omeda postal address id for the customer. Note: if submitted, OmedaCustomerId must be given.

EmailAddressId

optional

integer

Explicit Omeda email address id for the customer. Note: if submitted, OmedaCustomerId must be given.

ProductFieldResponses

optional

JSON Array

JSON element containing multiple Product Field Response Elements (see below)

ProductFieldId

required

integer

Explicit Omeda product field id for the marketing product field being requested.

ProductFieldResponseValue

required

string, integer, or date

The response value for the product field specified. The data type is dependent upon the product field.If it’s a date field, two formats are available: yyyy-MM-dd and yyyy-MM-dd HH:mm

TelemarketingCompany

required

string

Name of Telemarketing Company, 100 char max

TelemarketingRecordingId

required

string

ID needed to locate recording, 50 char max

TelemarketingAgent

required

string

Name/ID of telemarketing agent, 20 char max

PersonalIdQuestion

required

string

Personal ID value provided by customer, 100 char max

TimeOfCall

optional

date

Time Call occurred (date/time).Two formats are available: yyyy-MM-dd and yyyy-MM-dd HH:mm.

EndOfCall

optional

date

Time Call ended (date/time).Two formats are available: yyyy-MM-dd and yyyy-MM-dd HH:mm.

LengthOfCall

optional

integer

Length of call in minutes

SpokeToName

required

string

Name of person the agent spoke to, 100 char max

SpokeToTitle

required

string

Title of person the agent spoke to, 100 char max

AuthorizedAssistantResponse

optional

boolean(true/false)

Was person spoke to authorized to make a product request (true/false)

GeneralTeleInfo

optional

string

Miscellaneous information, 255 char max

BehaviorId

Required

Omeda Behavior ID (Integer value)

BehaviorDate

Required

Date the behavior occurred (yyyy-MM-dd HH:mm:ss )

BehaviorPromoCode

optional

Promocode

BehaviorAttributes

optional

JSON element containing multiple BehaviorAttributes Elements elements (see below)

BehaviorAttributeTypeId

Required

Omeda Behavior Attribute Type ID (Integer value)

BehaviorAttributeValue

Conditional

attribute value – is required for all BehaviorAttributes unless it is a type 1 and BehaviorAttributeValueId is present on the request

BehaviorAttributeValueId

Conditional

attribute value Id – can only be present for Type 1 BehaviorAttributes and can only be present if BehaviorAttributeValue is not present

200 OK

The request has succeeded. See Example Response below.

400 Bad Request

Typically, this error occurs when the request does not follow the specifications.

403 Forbidden

Typically, this error occurs when the credentials are erroneous. Potentially, an incorrect x-omeda-appid.

404 Not Found

Typically, this error occurs with a malformed URL or the resource that is searched for is not found.

405 Method Not Allowed

Typically, this error occurs when the resource accessed is not allowed by the HTTP Method utilized. Make sure you employ the correct HTTP Method (POST) for this request.

500 Internal Server Error

In the rare case that there is a server-side problem, this response will be returned. This generally indicates a problem of a more serious nature, and submitting additional requests may not be advisable. Please contact Omeda Account Representative.