v1

latestSwagger 2.02026-08-0613288149.8 KB
groups

create new receiver. 🔐

create a new receiver<br/> <br/> Carefully use the fields 'registered', 'activated' and 'deactivated':<br/> <br/> - provide 'registered' with current time if receiver is new.<br/> - provide 'activated' only for immedite activation (no DOI mail will work then).<br/> - provide 'deactivated' other than 0 and your receiver will definitely be inactive.<br/> <br/> Omission of all of those fields leads to an activated receiver ('registered' and 'activated' to current time)!<br/> <br/> <strong>Example Post Data:</strong><br/> <code> {<br/>     "email":"bruce@gotham.com",<br/>     "registered": "1118354400",<br/>     "activated": "1118354400", // omit if receiver is to be activated later, e.g. DOI mail<br/>     "deactivated": "0", // omit field unless you know what you are doing!<br/>     "source":"Batcave Computer",<br/>     "attributes": {<br/>         "is_batman":"1"<br/>     },<br/>     "global_attributes": {<br/>         "firstname":"Bruce",<br/>         "lastname":"Wayne"<br/>     },<br/>     "tags": [ "hero", "rich", "smart" ],<br/>     "orders": [<br/>         {<br/>             "order_id": "xyz123412",<br/>             "product_id": "SN9876543",<br/>             "product": "Batman - The Movie (DVD)",<br/>             "price": 9.99,<br/>             "currency": "EUR",<br/>             "quantity": 1,<br/>             "mailing_id": "12345678"<br/>         },<br/>         {<br/>             "order_id": "xyz123411",<br/>             "product_id": "SN9876542",<br/>             "product": "Batman - The Soundtrack (CD)",<br/>             "price": 9.99,<br/>             "currency": "EUR",<br/>             "quantity": 1,<br/>             "mailing_id": "12345678"<br/>         }<br/>     ]<br/> }<br/> </code>

post/v3/groups/{group_id}/receivers

Path parameters

group_idstring required

Group ID

Request body

postdataobject required

Data for receivers to be inserted

Response

the created receiver

string required