groups

update receiver. ๐Ÿ”

Update any information of a receiver<br/> <strong>Please note that you can not change the email!</strong><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. 0 will eventually reactivate receivers!<br/> Just omit 'deactivated' unless you know, what you are doing!<br/> <br/> <strong>Example Post Data:</strong><br/> <code> {<br/> ย ย ย ย "registered": "1118354400", // usually not needed to be set on update<br/> ย ย ย ย "activated": "1118354400", // only use to immediately activate the receiver<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> <br/>

put/v3/groups/{group_id}/receivers/{id}

Request

  • Base URL
    https://rest.cleverreach.com
  • URL
    https://rest.cleverreach.com/v3/groups/{group_id}/receivers/{id}
  • Auth
    API key in header Authorization

Path parameters

group_idstring required

ID of the group

idstring required

ID or email of receiver

Request body

postdataobject required

Receiver data to be updated

Response

Success

string required

Changes

No recorded changes to this operation across all 4 revisions of this API.