communication_unrestricted_parameters_update_parameter

communication_unrestricted_parameters_parameters object parameter data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD, UPDATE, REMOVE

unrestricted_parameter_identifier

(mandatory and applicable only on update or remove)

Communication Unrestricted Parameter Identifier

The unrestricted parameter related with the communication that should be updated. The supported unrestricted parameter identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The id of the communication unrestricted parameter

key

(semi-optional)

String

The key of the communication unrestricted parameter

name

(semi-optional)

String

The name of the communication unrestricted parameter

type

(mandatory and applicable only on add. Optional on update)

String

The type of the communication unrestricted parameter which can be STRING, FLOAT, INTEGER or DATE

name

(mandatory and applicable only on add. Optional on update)

String

The name of the communication unrestricted parameter

string_value

(mandatory on conditions and applicable only on add or update)

String

The string value of the communication unrestricted parameter. This applicable and mandatory only if the type is set to STRING

float_value

(mandatory on conditions and applicable only on add or update)

Number

The float value of the communication unrestricted parameter. This applicable and mandatory only if the type is set to FLOAT

integer_value

(mandatory on conditions and applicable only on add or update)

Integer

The integer value of the communication unrestricted parameter. This applicable and mandatory only if the type is set to INTEGER

date_value

(mandatory on conditions and applicable only on add or update)

Date

The date value of the communication unrestricted parameter. This applicable and mandatory only if the type is set to DATE