OptIn
A single opt in.
More info: see the get operation and the opt ins endpoint.
Fields
| Field | Description |
|---|---|
id int (required) | Unique ID Example value:123 |
typeid int (required) | Type of the opt-in. Can be ‘Mandatory’ (40001) or ‘Optional’ (40002) Example value:40001 |
name mlstring (required) | Name Example value:"Marketing e-mails" |
availability | Sales channel where this opt-in is available Example value:[ { "saleschannelid": 1 }, { "saleschannelid": 2 } ] |
caption mlstring (required) | Caption for the checkbox, needs to be set when typeid is "I do not wish to receive e-mails." |
description mlstring (required) | Description Example value:"Receive marketing related communications" |
nocaption mlstring (required) | Caption for no radio button, needs to be set when typeid is "No thanks." |
yescaption mlstring (required) | Caption for yes radio button, needs to be set when typeid is "Yes, I would like to receive marketing related communications." |
isarchived bool (required) | Whether or not this item is archived |
createdts timestamp (required) | Created timestamp Example value:"2014-09-26 15:24:36" |
lastupdatets timestamp (required) | Last updated timestamp Example value:"2014-09-26 15:24:36" |
Example
1{
2 "id": 123,
3 "typeid": 40001,
4 "name": "Marketing e-mails",
5 "availability": [
6 {
7 "saleschannelid": 1
8 },
9 {
10 "saleschannelid": 2
11 }
12 ],
13 "caption": "I do not wish to receive e-mails.",
14 "description": "Receive marketing related communications",
15 "nocaption": "No thanks.",
16 "yescaption": "Yes, I would like to receive marketing related communications.",
17 "isarchived": false,
18 "createdts": "2014-09-26 15:24:36",
19 "lastupdatets": "2014-09-26 15:24:36"
20}