Marketing

Customer-facing subscription tooling

Subscribe to marketing emails

post

Subscribes a contact to marketing communications.

Validation

• Email required and must be unique per gateway rules

• Optional profile fields (first name, last name, gender)

Side Effects

• IP address stored with the subscription record

• Dispatches the request to the configured subscription gateway

Body

application/json

Input payload for marketing subscriptions

emailstring · emailRequiredExample: [email protected]

first_nameany ofOptionalExample: Ada

string · max: 50Optional

last_nameany ofOptionalExample: Lovelace

string · max: 50Optional

genderany ofOptional

Value from omnicore.users.enums.GenderType

Example: female

stringOptional

Responses

200

Subscription request accepted

No content

400

Validation failed

application/json

post

/email-subscription/

HTTPcURLJavaScriptPython

POST /email-subscription/ HTTP/1.1
Host: sandbox.akinon.com
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "email": "[email protected]",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "gender": "female"
}

No content