Skip to content
/
Bulk write 'Customercommu...

Configurations (2.0.0)

The 'Configurations' application of the Core API

Download OpenAPI description
Download Postman Collection
Download OpenAPI Specification (json)
Download OpenAPI Specification (yaml)
Languages
Servers
https://{environment}.pigello.io

Commonorganizationsettings

Operations

Validationconfiguration

Operations

Automationconfiguration

Operations

Customercommunicationconfiguration

Operations

Create 'Customercommunicationconfiguration'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Bodyapplication/json
can_view_apartment_contract_renewal_termsbooleanrequired
can_cancel_industrial_premises_contractsbooleanrequired
can_view_structural_objectsbooleanrequired
can_view_common_areasbooleanrequired
can_view_inspection_errandsbooleanrequired
can_view_measurementsbooleanrequired
can_handle_general_errandsbooleanrequired
priorityinteger(int32)[ -2147483648 .. 2147483647 ]required
can_cancel_outdoor_section_contractsbooleanrequired
can_view_industrial_premises_contract_renewal_termsbooleanrequired
can_view_other_contract_renewal_termsbooleanrequired
can_view_general_errandsbooleanrequired
can_cancel_parking_spot_contractsbooleanrequired
can_view_parking_spot_contract_renewal_termsbooleanrequired
can_cancel_apartment_contractsbooleanrequired
can_view_block_contract_renewal_termsbooleanrequired
can_view_personal_informationbooleanrequired
can_update_customer_earning_reportsbooleanrequired
can_create_customer_earning_reportsbooleanrequired
can_delete_customer_earning_reportsbooleanrequired
can_handle_protected_identitybooleanrequired
can_view_non_personal_informationbooleanrequired
can_cancel_block_contractsbooleanrequired
can_view_outdoor_section_contract_renewal_termsbooleanrequired
can_cancel_other_contractsbooleanrequired
can_handle_personal_informationbooleanrequired
can_handle_non_personal_informationbooleanrequired
receive_sms_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

custom_application_domainstring or null<= 255 characters'^([a-z]+\.)+[a-z]+$'
receive_notifications_forArray of objects
organizationobject or null(Organization)
receive_email_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

custom_idstring or null<= 128 characters
curl -i -X POST \
  https://dev.api.pigello.io/configurations/customercommunicationconfiguration/ \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '{
    "can_view_apartment_contract_renewal_terms": true,
    "receive_sms_notifications_for": [
      null
    ],
    "can_cancel_industrial_premises_contracts": true,
    "can_view_structural_objects": true,
    "can_view_common_areas": true,
    "can_view_inspection_errands": true,
    "custom_application_domain": "string",
    "can_view_measurements": true,
    "can_handle_general_errands": true,
    "priority": -2147483648,
    "receive_notifications_for": [
      null
    ],
    "can_cancel_outdoor_section_contracts": true,
    "can_view_industrial_premises_contract_renewal_terms": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "can_view_other_contract_renewal_terms": true,
    "can_view_general_errands": true,
    "can_cancel_parking_spot_contracts": true,
    "can_view_parking_spot_contract_renewal_terms": true,
    "can_cancel_apartment_contracts": true,
    "receive_email_notifications_for": [
      null
    ],
    "can_view_block_contract_renewal_terms": true,
    "can_view_personal_information": true,
    "can_update_customer_earning_reports": true,
    "can_create_customer_earning_reports": true,
    "can_delete_customer_earning_reports": true,
    "custom_id": "string",
    "can_handle_protected_identity": true,
    "can_view_non_personal_information": true,
    "can_cancel_block_contracts": true,
    "can_view_outdoor_section_contract_renewal_terms": true,
    "can_cancel_other_contracts": true,
    "can_handle_personal_information": true,
    "can_handle_non_personal_information": true
  }'

Responses

Successful creation

Bodyapplication/json
can_view_apartment_contract_renewal_termsbooleanrequired
can_cancel_industrial_premises_contractsbooleanrequired
can_view_structural_objectsbooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

can_view_common_areasbooleanrequired
can_view_inspection_errandsbooleanrequired
can_view_measurementsbooleanrequired
can_handle_general_errandsbooleanrequired
priorityinteger(int32)[ -2147483648 .. 2147483647 ]required
can_cancel_outdoor_section_contractsbooleanrequired
can_view_industrial_premises_contract_renewal_termsbooleanrequired
can_view_other_contract_renewal_termsbooleanrequired
can_view_general_errandsbooleanrequired
can_cancel_parking_spot_contractsbooleanrequired
can_view_parking_spot_contract_renewal_termsbooleanrequired
can_cancel_apartment_contractsbooleanrequired
can_view_block_contract_renewal_termsbooleanrequired
can_view_personal_informationbooleanrequired
can_update_customer_earning_reportsbooleanrequired
can_create_customer_earning_reportsbooleanrequired
can_delete_customer_earning_reportsbooleanrequired
can_handle_protected_identitybooleanrequired
can_view_non_personal_informationbooleanrequired
can_cancel_block_contractsbooleanrequired
can_view_outdoor_section_contract_renewal_termsbooleanrequired
can_cancel_other_contractsbooleanrequired
can_handle_personal_informationbooleanrequired
can_handle_non_personal_informationbooleanrequired
receive_sms_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

custom_application_domainstring or null<= 255 characters'^([a-z]+\.)+[a-z]+$'
tagsanyread-only
receive_notifications_forArray of objects
organizationobject or null(Organization)
customer_columnsanyread-only
receive_email_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
Response
application/json
{
  "can_view_apartment_contract_renewal_terms": true,
  "receive_sms_notifications_for": [
    null
  ],
  "can_cancel_industrial_premises_contracts": true,
  "can_view_structural_objects": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "can_view_common_areas": true,
  "can_view_inspection_errands": true,
  "custom_application_domain": "string",
  "can_view_measurements": true,
  "tags": null,
  "can_handle_general_errands": true,
  "priority": -2147483648,
  "receive_notifications_for": [
    null
  ],
  "can_cancel_outdoor_section_contracts": true,
  "can_view_industrial_premises_contract_renewal_terms": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "can_view_other_contract_renewal_terms": true,
  "can_view_general_errands": true,
  "can_cancel_parking_spot_contracts": true,
  "can_view_parking_spot_contract_renewal_terms": true,
  "can_cancel_apartment_contracts": true,
  "receive_email_notifications_for": [
    null
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "can_view_block_contract_renewal_terms": true,
  "can_view_personal_information": true,
  "can_update_customer_earning_reports": true,
  "can_create_customer_earning_reports": true,
  "can_delete_customer_earning_reports": true,
  "custom_id": "string",
  "can_handle_protected_identity": true,
  "can_view_non_personal_information": true,
  "can_cancel_block_contracts": true,
  "can_view_outdoor_section_contract_renewal_terms": true,
  "can_cancel_other_contracts": true,
  "can_handle_personal_information": true,
  "can_handle_non_personal_information": true
}

List 'Customercommunicationconfiguration'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Query
_jsonlboolean
_order_byArray of strings
Example: _order_by=field_a,-field_b
_pageinteger(int32)>= 1

Additional Validation Information:

This value must be set together with the following fields: _page_size

_page_sizeinteger(int32)

Additional Validation Information:

This value must be set together with the following fields: _page

_searchstring
_slimboolean
_statisticsboolean
customer_columnsArray of objects
global_realestatesArray of objects
global_segmentsArray of objects
tagsArray of objects
can_cancel_apartment_contractsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_cancel_block_contractsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_cancel_industrial_premises_contractsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_cancel_other_contractsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_cancel_outdoor_section_contractsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_cancel_parking_spot_contractsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_create_customer_earning_reportsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_delete_customer_earning_reportsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_handle_general_errandsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_handle_non_personal_informationany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_handle_personal_informationany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_handle_protected_identityany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_update_customer_earning_reportsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_view_apartment_contract_renewal_termsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_view_block_contract_renewal_termsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_view_common_areasany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_view_general_errandsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_view_industrial_premises_contract_renewal_termsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_view_inspection_errandsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_view_measurementsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_view_non_personal_informationany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_view_other_contract_renewal_termsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_view_outdoor_section_contract_renewal_termsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_view_parking_spot_contract_renewal_termsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_view_personal_informationany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

can_view_structural_objectsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

created_atany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

custom_application_domainany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

custom_idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

organizationany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

priorityany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

curl -i -X GET \
  'https://dev.api.pigello.io/configurations/customercommunicationconfiguration/list/?_jsonl=true&_order_by=field_a%2C-field_b&_page=1&_page_size=0&_search=string&_slim=true&_statistics=true' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful query

Bodyapplication/jsonArray [
can_view_apartment_contract_renewal_termsbooleanrequired
can_cancel_industrial_premises_contractsbooleanrequired
can_view_structural_objectsbooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

can_view_common_areasbooleanrequired
can_view_inspection_errandsbooleanrequired
can_view_measurementsbooleanrequired
can_handle_general_errandsbooleanrequired
priorityinteger(int32)[ -2147483648 .. 2147483647 ]required
can_cancel_outdoor_section_contractsbooleanrequired
can_view_industrial_premises_contract_renewal_termsbooleanrequired
can_view_other_contract_renewal_termsbooleanrequired
can_view_general_errandsbooleanrequired
can_cancel_parking_spot_contractsbooleanrequired
can_view_parking_spot_contract_renewal_termsbooleanrequired
can_cancel_apartment_contractsbooleanrequired
can_view_block_contract_renewal_termsbooleanrequired
can_view_personal_informationbooleanrequired
can_update_customer_earning_reportsbooleanrequired
can_create_customer_earning_reportsbooleanrequired
can_delete_customer_earning_reportsbooleanrequired
can_handle_protected_identitybooleanrequired
can_view_non_personal_informationbooleanrequired
can_cancel_block_contractsbooleanrequired
can_view_outdoor_section_contract_renewal_termsbooleanrequired
can_cancel_other_contractsbooleanrequired
can_handle_personal_informationbooleanrequired
can_handle_non_personal_informationbooleanrequired
receive_sms_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

custom_application_domainstring or null<= 255 characters'^([a-z]+\.)+[a-z]+$'
tagsanyread-only
receive_notifications_forArray of objects
organizationobject or null(Organization)
customer_columnsanyread-only
receive_email_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
]
Response
application/json
[
  {
    "can_view_apartment_contract_renewal_terms": true,
    "receive_sms_notifications_for": [ … ],
    "can_cancel_industrial_premises_contracts": true,
    "can_view_structural_objects": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "can_view_common_areas": true,
    "can_view_inspection_errands": true,
    "custom_application_domain": "string",
    "can_view_measurements": true,
    "tags": null,
    "can_handle_general_errands": true,
    "priority": -2147483648,
    "receive_notifications_for": [ … ],
    "can_cancel_outdoor_section_contracts": true,
    "can_view_industrial_premises_contract_renewal_terms": true,
    "organization": { … },
    "customer_columns": null,
    "can_view_other_contract_renewal_terms": true,
    "can_view_general_errands": true,
    "can_cancel_parking_spot_contracts": true,
    "can_view_parking_spot_contract_renewal_terms": true,
    "can_cancel_apartment_contracts": true,
    "receive_email_notifications_for": [ … ],
    "created_at": "2019-08-24T14:15:22Z",
    "can_view_block_contract_renewal_terms": true,
    "can_view_personal_information": true,
    "can_update_customer_earning_reports": true,
    "can_create_customer_earning_reports": true,
    "can_delete_customer_earning_reports": true,
    "custom_id": "string",
    "can_handle_protected_identity": true,
    "can_view_non_personal_information": true,
    "can_cancel_block_contracts": true,
    "can_view_outdoor_section_contract_renewal_terms": true,
    "can_cancel_other_contracts": true,
    "can_handle_personal_information": true,
    "can_handle_non_personal_information": true
  }
]

Bulk write 'Customercommunicationconfiguration'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Bodyapplication/jsonArray [
can_view_apartment_contract_renewal_termsbooleanrequired
can_cancel_industrial_premises_contractsbooleanrequired
can_view_structural_objectsbooleanrequired
can_view_common_areasbooleanrequired
can_view_inspection_errandsbooleanrequired
can_view_measurementsbooleanrequired
can_handle_general_errandsbooleanrequired
priorityinteger(int32)[ -2147483648 .. 2147483647 ]required
can_cancel_outdoor_section_contractsbooleanrequired
can_view_industrial_premises_contract_renewal_termsbooleanrequired
can_view_other_contract_renewal_termsbooleanrequired
can_view_general_errandsbooleanrequired
can_cancel_parking_spot_contractsbooleanrequired
can_view_parking_spot_contract_renewal_termsbooleanrequired
can_cancel_apartment_contractsbooleanrequired
can_view_block_contract_renewal_termsbooleanrequired
can_view_personal_informationbooleanrequired
can_update_customer_earning_reportsbooleanrequired
can_create_customer_earning_reportsbooleanrequired
can_delete_customer_earning_reportsbooleanrequired
can_handle_protected_identitybooleanrequired
can_view_non_personal_informationbooleanrequired
can_cancel_block_contractsbooleanrequired
can_view_outdoor_section_contract_renewal_termsbooleanrequired
can_cancel_other_contractsbooleanrequired
can_handle_personal_informationbooleanrequired
can_handle_non_personal_informationbooleanrequired
receive_sms_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

custom_application_domainstring or null<= 255 characters'^([a-z]+\.)+[a-z]+$'
receive_notifications_forArray of objects
organizationobject or null(Organization)
receive_email_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

custom_idstring or null<= 128 characters
]
curl -i -X POST \
  https://dev.api.pigello.io/configurations/customercommunicationconfiguration/list/ \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '[
    {
      "can_view_apartment_contract_renewal_terms": true,
      "receive_sms_notifications_for": [
        null
      ],
      "can_cancel_industrial_premises_contracts": true,
      "can_view_structural_objects": true,
      "can_view_common_areas": true,
      "can_view_inspection_errands": true,
      "custom_application_domain": "string",
      "can_view_measurements": true,
      "can_handle_general_errands": true,
      "priority": -2147483648,
      "receive_notifications_for": [
        null
      ],
      "can_cancel_outdoor_section_contracts": true,
      "can_view_industrial_premises_contract_renewal_terms": true,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "can_view_other_contract_renewal_terms": true,
      "can_view_general_errands": true,
      "can_cancel_parking_spot_contracts": true,
      "can_view_parking_spot_contract_renewal_terms": true,
      "can_cancel_apartment_contracts": true,
      "receive_email_notifications_for": [
        null
      ],
      "can_view_block_contract_renewal_terms": true,
      "can_view_personal_information": true,
      "can_update_customer_earning_reports": true,
      "can_create_customer_earning_reports": true,
      "can_delete_customer_earning_reports": true,
      "custom_id": "string",
      "can_handle_protected_identity": true,
      "can_view_non_personal_information": true,
      "can_cancel_block_contracts": true,
      "can_view_outdoor_section_contract_renewal_terms": true,
      "can_cancel_other_contracts": true,
      "can_handle_personal_information": true,
      "can_handle_non_personal_information": true
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
can_view_apartment_contract_renewal_termsbooleanrequired
can_cancel_industrial_premises_contractsbooleanrequired
can_view_structural_objectsbooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

can_view_common_areasbooleanrequired
can_view_inspection_errandsbooleanrequired
can_view_measurementsbooleanrequired
can_handle_general_errandsbooleanrequired
priorityinteger(int32)[ -2147483648 .. 2147483647 ]required
can_cancel_outdoor_section_contractsbooleanrequired
can_view_industrial_premises_contract_renewal_termsbooleanrequired
can_view_other_contract_renewal_termsbooleanrequired
can_view_general_errandsbooleanrequired
can_cancel_parking_spot_contractsbooleanrequired
can_view_parking_spot_contract_renewal_termsbooleanrequired
can_cancel_apartment_contractsbooleanrequired
can_view_block_contract_renewal_termsbooleanrequired
can_view_personal_informationbooleanrequired
can_update_customer_earning_reportsbooleanrequired
can_create_customer_earning_reportsbooleanrequired
can_delete_customer_earning_reportsbooleanrequired
can_handle_protected_identitybooleanrequired
can_view_non_personal_informationbooleanrequired
can_cancel_block_contractsbooleanrequired
can_view_outdoor_section_contract_renewal_termsbooleanrequired
can_cancel_other_contractsbooleanrequired
can_handle_personal_informationbooleanrequired
can_handle_non_personal_informationbooleanrequired
receive_sms_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

custom_application_domainstring or null<= 255 characters'^([a-z]+\.)+[a-z]+$'
tagsanyread-only
receive_notifications_forArray of objects
organizationobject or null(Organization)
customer_columnsanyread-only
receive_email_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
]
Response
application/json
[
  {
    "can_view_apartment_contract_renewal_terms": true,
    "receive_sms_notifications_for": [ … ],
    "can_cancel_industrial_premises_contracts": true,
    "can_view_structural_objects": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "can_view_common_areas": true,
    "can_view_inspection_errands": true,
    "custom_application_domain": "string",
    "can_view_measurements": true,
    "tags": null,
    "can_handle_general_errands": true,
    "priority": -2147483648,
    "receive_notifications_for": [ … ],
    "can_cancel_outdoor_section_contracts": true,
    "can_view_industrial_premises_contract_renewal_terms": true,
    "organization": { … },
    "customer_columns": null,
    "can_view_other_contract_renewal_terms": true,
    "can_view_general_errands": true,
    "can_cancel_parking_spot_contracts": true,
    "can_view_parking_spot_contract_renewal_terms": true,
    "can_cancel_apartment_contracts": true,
    "receive_email_notifications_for": [ … ],
    "created_at": "2019-08-24T14:15:22Z",
    "can_view_block_contract_renewal_terms": true,
    "can_view_personal_information": true,
    "can_update_customer_earning_reports": true,
    "can_create_customer_earning_reports": true,
    "can_delete_customer_earning_reports": true,
    "custom_id": "string",
    "can_handle_protected_identity": true,
    "can_view_non_personal_information": true,
    "can_cancel_block_contracts": true,
    "can_view_outdoor_section_contract_renewal_terms": true,
    "can_cancel_other_contracts": true,
    "can_handle_personal_information": true,
    "can_handle_non_personal_information": true
  }
]

Update 'Customercommunicationconfiguration'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
Bodyapplication/json
can_view_apartment_contract_renewal_termsbooleanrequired
can_cancel_industrial_premises_contractsbooleanrequired
can_view_structural_objectsbooleanrequired
can_view_common_areasbooleanrequired
can_view_inspection_errandsbooleanrequired
can_view_measurementsbooleanrequired
can_handle_general_errandsbooleanrequired
priorityinteger(int32)[ -2147483648 .. 2147483647 ]required
can_cancel_outdoor_section_contractsbooleanrequired
can_view_industrial_premises_contract_renewal_termsbooleanrequired
can_view_other_contract_renewal_termsbooleanrequired
can_view_general_errandsbooleanrequired
can_cancel_parking_spot_contractsbooleanrequired
can_view_parking_spot_contract_renewal_termsbooleanrequired
can_cancel_apartment_contractsbooleanrequired
can_view_block_contract_renewal_termsbooleanrequired
can_view_personal_informationbooleanrequired
can_update_customer_earning_reportsbooleanrequired
can_create_customer_earning_reportsbooleanrequired
can_delete_customer_earning_reportsbooleanrequired
can_handle_protected_identitybooleanrequired
can_view_non_personal_informationbooleanrequired
can_cancel_block_contractsbooleanrequired
can_view_outdoor_section_contract_renewal_termsbooleanrequired
can_cancel_other_contractsbooleanrequired
can_handle_personal_informationbooleanrequired
can_handle_non_personal_informationbooleanrequired
receive_sms_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

custom_application_domainstring or null<= 255 characters'^([a-z]+\.)+[a-z]+$'
receive_notifications_forArray of objects
organizationobject or null(Organization)
receive_email_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

custom_idstring or null<= 128 characters
curl -i -X PATCH \
  'https://dev.api.pigello.io/configurations/customercommunicationconfiguration/{pk}/' \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '{
    "can_view_apartment_contract_renewal_terms": true,
    "receive_sms_notifications_for": [
      null
    ],
    "can_cancel_industrial_premises_contracts": true,
    "can_view_structural_objects": true,
    "can_view_common_areas": true,
    "can_view_inspection_errands": true,
    "custom_application_domain": "string",
    "can_view_measurements": true,
    "can_handle_general_errands": true,
    "priority": -2147483648,
    "receive_notifications_for": [
      null
    ],
    "can_cancel_outdoor_section_contracts": true,
    "can_view_industrial_premises_contract_renewal_terms": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "can_view_other_contract_renewal_terms": true,
    "can_view_general_errands": true,
    "can_cancel_parking_spot_contracts": true,
    "can_view_parking_spot_contract_renewal_terms": true,
    "can_cancel_apartment_contracts": true,
    "receive_email_notifications_for": [
      null
    ],
    "can_view_block_contract_renewal_terms": true,
    "can_view_personal_information": true,
    "can_update_customer_earning_reports": true,
    "can_create_customer_earning_reports": true,
    "can_delete_customer_earning_reports": true,
    "custom_id": "string",
    "can_handle_protected_identity": true,
    "can_view_non_personal_information": true,
    "can_cancel_block_contracts": true,
    "can_view_outdoor_section_contract_renewal_terms": true,
    "can_cancel_other_contracts": true,
    "can_handle_personal_information": true,
    "can_handle_non_personal_information": true
  }'

Responses

Successful update

Bodyapplication/json
can_view_apartment_contract_renewal_termsbooleanrequired
can_cancel_industrial_premises_contractsbooleanrequired
can_view_structural_objectsbooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

can_view_common_areasbooleanrequired
can_view_inspection_errandsbooleanrequired
can_view_measurementsbooleanrequired
can_handle_general_errandsbooleanrequired
priorityinteger(int32)[ -2147483648 .. 2147483647 ]required
can_cancel_outdoor_section_contractsbooleanrequired
can_view_industrial_premises_contract_renewal_termsbooleanrequired
can_view_other_contract_renewal_termsbooleanrequired
can_view_general_errandsbooleanrequired
can_cancel_parking_spot_contractsbooleanrequired
can_view_parking_spot_contract_renewal_termsbooleanrequired
can_cancel_apartment_contractsbooleanrequired
can_view_block_contract_renewal_termsbooleanrequired
can_view_personal_informationbooleanrequired
can_update_customer_earning_reportsbooleanrequired
can_create_customer_earning_reportsbooleanrequired
can_delete_customer_earning_reportsbooleanrequired
can_handle_protected_identitybooleanrequired
can_view_non_personal_informationbooleanrequired
can_cancel_block_contractsbooleanrequired
can_view_outdoor_section_contract_renewal_termsbooleanrequired
can_cancel_other_contractsbooleanrequired
can_handle_personal_informationbooleanrequired
can_handle_non_personal_informationbooleanrequired
receive_sms_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

custom_application_domainstring or null<= 255 characters'^([a-z]+\.)+[a-z]+$'
tagsanyread-only
receive_notifications_forArray of objects
organizationobject or null(Organization)
customer_columnsanyread-only
receive_email_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
Response
application/json
{
  "can_view_apartment_contract_renewal_terms": true,
  "receive_sms_notifications_for": [
    null
  ],
  "can_cancel_industrial_premises_contracts": true,
  "can_view_structural_objects": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "can_view_common_areas": true,
  "can_view_inspection_errands": true,
  "custom_application_domain": "string",
  "can_view_measurements": true,
  "tags": null,
  "can_handle_general_errands": true,
  "priority": -2147483648,
  "receive_notifications_for": [
    null
  ],
  "can_cancel_outdoor_section_contracts": true,
  "can_view_industrial_premises_contract_renewal_terms": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "can_view_other_contract_renewal_terms": true,
  "can_view_general_errands": true,
  "can_cancel_parking_spot_contracts": true,
  "can_view_parking_spot_contract_renewal_terms": true,
  "can_cancel_apartment_contracts": true,
  "receive_email_notifications_for": [
    null
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "can_view_block_contract_renewal_terms": true,
  "can_view_personal_information": true,
  "can_update_customer_earning_reports": true,
  "can_create_customer_earning_reports": true,
  "can_delete_customer_earning_reports": true,
  "custom_id": "string",
  "can_handle_protected_identity": true,
  "can_view_non_personal_information": true,
  "can_cancel_block_contracts": true,
  "can_view_outdoor_section_contract_renewal_terms": true,
  "can_cancel_other_contracts": true,
  "can_handle_personal_information": true,
  "can_handle_non_personal_information": true
}

Delete 'Customercommunicationconfiguration'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
curl -i -X DELETE \
  'https://dev.api.pigello.io/configurations/customercommunicationconfiguration/{pk}/' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful deletion

Response
No content

Get 'Customercommunicationconfiguration'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
curl -i -X GET \
  'https://dev.api.pigello.io/configurations/customercommunicationconfiguration/{pk}/' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful selection

Bodyapplication/json
can_view_apartment_contract_renewal_termsbooleanrequired
can_cancel_industrial_premises_contractsbooleanrequired
can_view_structural_objectsbooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

can_view_common_areasbooleanrequired
can_view_inspection_errandsbooleanrequired
can_view_measurementsbooleanrequired
can_handle_general_errandsbooleanrequired
priorityinteger(int32)[ -2147483648 .. 2147483647 ]required
can_cancel_outdoor_section_contractsbooleanrequired
can_view_industrial_premises_contract_renewal_termsbooleanrequired
can_view_other_contract_renewal_termsbooleanrequired
can_view_general_errandsbooleanrequired
can_cancel_parking_spot_contractsbooleanrequired
can_view_parking_spot_contract_renewal_termsbooleanrequired
can_cancel_apartment_contractsbooleanrequired
can_view_block_contract_renewal_termsbooleanrequired
can_view_personal_informationbooleanrequired
can_update_customer_earning_reportsbooleanrequired
can_create_customer_earning_reportsbooleanrequired
can_delete_customer_earning_reportsbooleanrequired
can_handle_protected_identitybooleanrequired
can_view_non_personal_informationbooleanrequired
can_cancel_block_contractsbooleanrequired
can_view_outdoor_section_contract_renewal_termsbooleanrequired
can_cancel_other_contractsbooleanrequired
can_handle_personal_informationbooleanrequired
can_handle_non_personal_informationbooleanrequired
receive_sms_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

custom_application_domainstring or null<= 255 characters'^([a-z]+\.)+[a-z]+$'
tagsanyread-only
receive_notifications_forArray of objects
organizationobject or null(Organization)
customer_columnsanyread-only
receive_email_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
Response
application/json
{
  "can_view_apartment_contract_renewal_terms": true,
  "receive_sms_notifications_for": [
    null
  ],
  "can_cancel_industrial_premises_contracts": true,
  "can_view_structural_objects": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "can_view_common_areas": true,
  "can_view_inspection_errands": true,
  "custom_application_domain": "string",
  "can_view_measurements": true,
  "tags": null,
  "can_handle_general_errands": true,
  "priority": -2147483648,
  "receive_notifications_for": [
    null
  ],
  "can_cancel_outdoor_section_contracts": true,
  "can_view_industrial_premises_contract_renewal_terms": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "can_view_other_contract_renewal_terms": true,
  "can_view_general_errands": true,
  "can_cancel_parking_spot_contracts": true,
  "can_view_parking_spot_contract_renewal_terms": true,
  "can_cancel_apartment_contracts": true,
  "receive_email_notifications_for": [
    null
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "can_view_block_contract_renewal_terms": true,
  "can_view_personal_information": true,
  "can_update_customer_earning_reports": true,
  "can_create_customer_earning_reports": true,
  "can_delete_customer_earning_reports": true,
  "custom_id": "string",
  "can_handle_protected_identity": true,
  "can_view_non_personal_information": true,
  "can_cancel_block_contracts": true,
  "can_view_outdoor_section_contract_renewal_terms": true,
  "can_cancel_other_contracts": true,
  "can_handle_personal_information": true,
  "can_handle_non_personal_information": true
}

Securityconfiguration

Operations

Retroactivityconfiguration

Operations
© Pigello. All rights reserved.