Skip to content
/
Create 'Commonorganizatio...

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

Create 'Commonorganizationsettings'

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
brf_realtor_image_common_info_textstring or null
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
curl -i -X POST \
  https://dev.api.pigello.io/configurations/commonorganizationsettings/ \
  -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 '{
    "brf_realtor_image_common_info_text": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string"
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

brf_realtor_image_common_info_textstring or null
organizationobject or null(Organization)
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
Response
application/json
{
  "brf_realtor_image_common_info_text": "string",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "custom_id": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Update 'Commonorganizationsettings'

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
brf_realtor_image_common_info_textstring or null
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
curl -i -X PATCH \
  'https://dev.api.pigello.io/configurations/commonorganizationsettings/{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 '{
    "brf_realtor_image_common_info_text": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string"
  }'

Responses

Successful update

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

brf_realtor_image_common_info_textstring or null
organizationobject or null(Organization)
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
Response
application/json
{
  "brf_realtor_image_common_info_text": "string",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "custom_id": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get 'Commonorganizationsettings'

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/commonorganizationsettings/{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

brf_realtor_image_common_info_textstring or null
organizationobject or null(Organization)
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
Response
application/json
{
  "brf_realtor_image_common_info_text": "string",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "custom_id": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Validationconfiguration

Operations

Automationconfiguration

Operations

Customercommunicationconfiguration

Operations

Securityconfiguration

Operations

Retroactivityconfiguration

Operations
© Pigello. All rights reserved.