Sign in
restricted

UpdateProfile

Update a user profile

put/profiles/{fiscal_code}

Request

  • Base URL: https://api.cd.italia.it/api/v1
  • URL: https://api.cd.italia.it/api/v1/profiles/{fiscal_code}
  • Auth: API key in header X-Functions-Key

Path parameters

fiscal_codestring required

The fiscal code of the user, all upper case.

Request body

emailstring email
blocked_inbox_or_channelsBlockedInboxOrChannels

All the notification channels blocked by the user. Each channel is related to a specific service (sender).

preferred_languagesPreferredLanguage[]

Indicates the User's preferred written or spoken languages in order of preference. Generally used for selecting a localized User interface. Valid values are concatenation of the ISO 639-1 two letter language code, an underscore, and the ISO 3166-1 2 letter country code; e.g., 'en_US' specifies the language English and country US.

is_inbox_enabledboolean

True if the recipient of a message wants to store its content for later retrieval.

accepted_tos_versionnumber

Version of latest terms of service accepted by the user.

is_webhook_enabledboolean

True if the recipient of a message wants to forward the notifications to the default webhook.

is_email_enabledboolean

True if the recipient of a message wants to forward the notifications to his email address.

reminder_statusstring

Api definition of reminder opt-in status

last_app_versionstring

A string field in Semantic Versioning format

push_notifications_content_typestring

This parameter specifies how a specific user wants to visualize push notifications. FULL leads to descriptive push notifications while ANONYMOUS leads to silent ones.

versioninteger required
namestring required

Example request

{
  "email": "foobar@example.com",
  "preferred_languages": [
    "it_IT"
  ],
  "reminder_status": "ENABLED",
  "last_app_version": "1.10.11",
  "push_notifications_content_type": "FULL"
}

Response

Profile updated

emailstring email
blocked_inbox_or_channelsBlockedInboxOrChannels

All the notification channels blocked by the user. Each channel is related to a specific service (sender).

preferred_languagesPreferredLanguage[]

Indicates the User's preferred written or spoken languages in order of preference. Generally used for selecting a localized User interface. Valid values are concatenation of the ISO 639-1 two letter language code, an underscore, and the ISO 3166-1 2 letter country code; e.g., 'en_US' specifies the language English and country US.

is_inbox_enabledboolean required

True if the recipient of a message wants to store its content for later retrieval.

accepted_tos_versionnumber

Version of latest terms of service accepted by the user.

is_webhook_enabledboolean required

True if the recipient of a message wants to forward the notifications to the default webhook.

is_email_enabledboolean required

True if the recipient of a message wants to forward the notifications to his email address.

is_email_validatedboolean required

True if the user email has been validated.

is_email_already_takenboolean required

True if the user email has been validated by another user. If so, the user must provide a new email.

reminder_statusstring

Api definition of reminder opt-in status

is_test_profileboolean

True if the user's profile is only for test purpose.

last_app_versionstring

A string field in Semantic Versioning format

push_notifications_content_typestring

This parameter specifies how a specific user wants to visualize push notifications. FULL leads to descriptive push notifications while ANONYMOUS leads to silent ones.

versioninteger required

Example response

{
  "email": "foobar@example.com",
  "preferred_languages": [
    "it_IT"
  ],
  "reminder_status": "ENABLED",
  "last_app_version": "1.10.11",
  "push_notifications_content_type": "FULL"
}

Changes

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