Agendize Platform API

Privacy Policy API Reference

The Privacy Policy API eallow to get and define yout account privacy policy.


Resource representation

{ "owner": {string}, "privateData": { "cleanDelay": {int}, "consentMode": {string}, "cleanMode": {string}, "consentText": { "EN": {string}, "FR": {string}, "ES": {string}, "DE": {string}, "IT": {string}, "PT": {string}, "NL": {string}, "JP": {string} } }, "marketing": { "consentMode": {string}, "consentText": { "EN": {string}, "FR": {string}, "ES": {string}, "DE": {string}, "IT": {string}, "PT": {string}, "NL": {string}, "JP": {string} } }, "crm": { "createContactAuthorized": {boolean}, "importContactAuthorized": {boolean} } }
Parameter name Value Description Notes
owner string Login of the account owner
privateData object Mandatory consent data
cleanDelay int Delay after which the personal data are anonymised or deleted (in days). values are:
  • -1 (for never)
  • 7 (7 days)
  • 30 (1 month)
  • 91 (3 months)
  • 183 (6 months)
  • 365 (1 year)
  • 730 (2 years)
  • 1825 (5 years)
  • 3650 (10 years)
consentMode string Active/Deactivate mandatory consent data. Values are:
  • ON
  • OFF
cleanMode string Delete or anonimze personal data. Values are:
  • DELETE_PERSONAL_DATA
  • ANONYMIZE_PERSONAL_DATA
consentText object Mandatory consent text
consentText.EN string Mandatory consent english text
consentText.FR string Mandatory consent french text
consentText.ES string Mandatory consent spanish text
consentText.DE string Mandatory consent german text
consentText.IT string Mandatory consent italian text
consentText.NL string Mandatory consent dutch text
consentText.PT string Mandatory consent portuguese text
consentText.JP string Mandatory consent japanese text
marketing object Mail and SMS marketing consent data
consentMode string Active/Deactivate mandatory marketing consent. Values are:
  • ON
  • OFF
consentText object Marketing consent text
consentText.EN string Marketing consent english text
consentText.FR string Marketing consent french text
consentText.ES string Marketing consent spanish text
consentText.DE string Marketing consent german text
consentText.IT string Marketing consent italian text
consentText.NL string Marketing consent dutch text
consentText.PT string Marketing consent portuguese text
consentText.JP string Marketing consent japanese text

Get

Return account privacy policy.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET http://api.agendize.com/api/2.0/accounts/privacy

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Privacy policy resource in the response body.


null

Privacy Policy: insert

Request

HTTP Request

POST http://api.agendize.com/api/2.0/platform/accounts/privacy

Request body

In the request body, supply a Privacy Policy Resource with the following properties:

Parameter name Value Description
Required Properties
privateData object Mandatory consent.

Response

If successful, this method returns a Privacy Policy resource in the response body.


Update

Update a privacy policy.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

PUT http://api.agendize.com/api/2.0/accounts/privacy

Request body

In the request body, supply a Privacy policy resource with the following properties:

Parameter name Value Description
Required Properties
privateData object Mandatory consent.

Response

If successful, this method returns a Privacy policy in the response body.