Skip to content

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

Create 'Automationconfiguration'

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
organization_user_auto_anonymize_post_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
custom_idstring or null<= 128 characters
potential_customer_auto_anonymize_post_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
previous_customer_auto_anonymization_exact_date_matchboolean
organization_user_auto_anonymization_exact_date_matchboolean
customer_auto_adjust_deactivation_with_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
organizationobject or null(Organization)
potential_customer_auto_anonymization_exact_date_matchboolean
previous_customer_auto_anonymize_post_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
customer_auto_invite_pre_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
curl -i -X POST \
  https://dev.api.pigello.io/configurations/automationconfiguration/ \
  -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 '{
    "organization_user_auto_anonymize_post_days": -2147483648,
    "custom_id": "string",
    "potential_customer_auto_anonymize_post_days": -2147483648,
    "previous_customer_auto_anonymization_exact_date_match": true,
    "organization_user_auto_anonymization_exact_date_match": true,
    "customer_auto_adjust_deactivation_with_days": -2147483648,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "potential_customer_auto_anonymization_exact_date_match": true,
    "previous_customer_auto_anonymize_post_days": -2147483648,
    "customer_auto_invite_pre_days": -2147483648
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

organization_user_auto_anonymize_post_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
custom_idstring or null<= 128 characters
potential_customer_auto_anonymize_post_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
created_atstring(date-time)read-only
previous_customer_auto_anonymization_exact_date_matchboolean
organization_user_auto_anonymization_exact_date_matchboolean
customer_auto_adjust_deactivation_with_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
organizationobject or null(Organization)
potential_customer_auto_anonymization_exact_date_matchboolean
previous_customer_auto_anonymize_post_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
customer_auto_invite_pre_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
Response
application/json
{
  "organization_user_auto_anonymize_post_days": -2147483648,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "custom_id": "string",
  "potential_customer_auto_anonymize_post_days": -2147483648,
  "created_at": "2019-08-24T14:15:22Z",
  "previous_customer_auto_anonymization_exact_date_match": true,
  "organization_user_auto_anonymization_exact_date_match": true,
  "customer_auto_adjust_deactivation_with_days": -2147483648,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "potential_customer_auto_anonymization_exact_date_match": true,
  "previous_customer_auto_anonymize_post_days": -2147483648,
  "customer_auto_invite_pre_days": -2147483648
}

Update 'Automationconfiguration'

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
organization_user_auto_anonymize_post_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
custom_idstring or null<= 128 characters
potential_customer_auto_anonymize_post_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
previous_customer_auto_anonymization_exact_date_matchboolean
organization_user_auto_anonymization_exact_date_matchboolean
customer_auto_adjust_deactivation_with_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
organizationobject or null(Organization)
potential_customer_auto_anonymization_exact_date_matchboolean
previous_customer_auto_anonymize_post_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
customer_auto_invite_pre_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
curl -i -X PATCH \
  'https://dev.api.pigello.io/configurations/automationconfiguration/{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 '{
    "organization_user_auto_anonymize_post_days": -2147483648,
    "custom_id": "string",
    "potential_customer_auto_anonymize_post_days": -2147483648,
    "previous_customer_auto_anonymization_exact_date_match": true,
    "organization_user_auto_anonymization_exact_date_match": true,
    "customer_auto_adjust_deactivation_with_days": -2147483648,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "potential_customer_auto_anonymization_exact_date_match": true,
    "previous_customer_auto_anonymize_post_days": -2147483648,
    "customer_auto_invite_pre_days": -2147483648
  }'

Responses

Successful update

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

organization_user_auto_anonymize_post_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
custom_idstring or null<= 128 characters
potential_customer_auto_anonymize_post_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
created_atstring(date-time)read-only
previous_customer_auto_anonymization_exact_date_matchboolean
organization_user_auto_anonymization_exact_date_matchboolean
customer_auto_adjust_deactivation_with_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
organizationobject or null(Organization)
potential_customer_auto_anonymization_exact_date_matchboolean
previous_customer_auto_anonymize_post_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
customer_auto_invite_pre_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
Response
application/json
{
  "organization_user_auto_anonymize_post_days": -2147483648,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "custom_id": "string",
  "potential_customer_auto_anonymize_post_days": -2147483648,
  "created_at": "2019-08-24T14:15:22Z",
  "previous_customer_auto_anonymization_exact_date_match": true,
  "organization_user_auto_anonymization_exact_date_match": true,
  "customer_auto_adjust_deactivation_with_days": -2147483648,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "potential_customer_auto_anonymization_exact_date_match": true,
  "previous_customer_auto_anonymize_post_days": -2147483648,
  "customer_auto_invite_pre_days": -2147483648
}

Get 'Automationconfiguration'

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/automationconfiguration/{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
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

organization_user_auto_anonymize_post_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
custom_idstring or null<= 128 characters
potential_customer_auto_anonymize_post_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
created_atstring(date-time)read-only
previous_customer_auto_anonymization_exact_date_matchboolean
organization_user_auto_anonymization_exact_date_matchboolean
customer_auto_adjust_deactivation_with_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
organizationobject or null(Organization)
potential_customer_auto_anonymization_exact_date_matchboolean
previous_customer_auto_anonymize_post_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
customer_auto_invite_pre_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]
Response
application/json
{
  "organization_user_auto_anonymize_post_days": -2147483648,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "custom_id": "string",
  "potential_customer_auto_anonymize_post_days": -2147483648,
  "created_at": "2019-08-24T14:15:22Z",
  "previous_customer_auto_anonymization_exact_date_match": true,
  "organization_user_auto_anonymization_exact_date_match": true,
  "customer_auto_adjust_deactivation_with_days": -2147483648,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "potential_customer_auto_anonymization_exact_date_match": true,
  "previous_customer_auto_anonymize_post_days": -2147483648,
  "customer_auto_invite_pre_days": -2147483648
}

Customercommunicationconfiguration

Operations

Securityconfiguration

Operations

Retroactivityconfiguration

Operations
© Pigello. All rights reserved.