7248a065f67f

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