Jump to

• Request
• Response
• Examples

Modify admin settings

put

/api/{version}/admin/defaults

Versions Supported:

v4

Request

Path Parameters

• version: string

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

A body of type:

• application/json
• application/xml

Root Schema : schema

Type: object

Show Source

• defaultAdvFilters(optional): array defaultAdvFilters
• defaultFilters(optional): array defaultFilters
• defaultMaps(optional): array defaultMaps
• defaultOutputFormat(optional): string

{
    "properties":{
        "defaultAdvFilters":{
            "items":{
                "$ref":"#/components/schemas/DefaultAdvFiltersInfo"
            },
            "type":"array"
        },
        "defaultFilters":{
            "items":{
            },
            "type":"array"
        },
        "defaultMaps":{
            "items":{
                "$ref":"#/components/schemas/DefaultMap"
            },
            "type":"array"
        },
        "defaultOutputFormat":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : defaultAdvFilters

Type: array

Show Source

• Array of: object DefaultAdvFiltersInfo

{
    "items":{
        "$ref":"#/components/schemas/DefaultAdvFiltersInfo"
    },
    "type":"array"
}

Nested Schema : defaultFilters

Type: array

Show Source

• Array of:

{
    "items":{
    },
    "type":"array"
}

Nested Schema : defaultMaps

Type: array

Show Source

• Array of: object DefaultMap

{
    "items":{
        "$ref":"#/components/schemas/DefaultMap"
    },
    "type":"array"
}

Nested Schema : DefaultAdvFiltersInfo

Type: object

Show Source

• filterFields(optional): array filterFields
• objectType(optional): string
  Allowed Values: [ "COMPANY", "CONTACT" ]
• radialFilter(optional): object RadialFilter
• rangeFilters(optional): array rangeFilters

{
    "properties":{
        "filterFields":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        },
        "objectType":{
            "$ref":"#/components/schemas/ObjectType1"
        },
        "radialFilter":{
            "$ref":"#/components/schemas/RadialFilter"
        },
        "rangeFilters":{
            "items":{
                "$ref":"#/components/schemas/RangeFilterInfo"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : filterFields

Type: array

Show Source

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

Nested Schema : RadialFilter

Type: object

Show Source

• countryName(optional): string
• isNotNullFlag(optional): boolean
• name(optional): string
• notNullFlag(optional): boolean
• operator(optional): string
  Allowed Values: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• radius(optional): string
• unit(optional): string
  Allowed Values: [ "km", "mi" ]
• value(optional): string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        },
        "countryName":{
            "type":"string"
        },
        "radius":{
            "type":"string"
        },
        "unit":{
            "$ref":"#/components/schemas/UNIT"
        }
    },
    "type":"object"
}

Nested Schema : rangeFilters

Type: array

Show Source

• Array of: object RangeFilterInfo

{
    "items":{
        "$ref":"#/components/schemas/RangeFilterInfo"
    },
    "type":"array"
}

Nested Schema : FilterInfo

Type: object

Show Source

• isNotNullFlag(optional): boolean
• name(optional): string
• notNullFlag(optional): boolean
• operator(optional): string
  Allowed Values: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• value(optional): string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : RangeFilterInfo

Type: object

Show Source

• isNotNullFlag(optional): boolean
• name(optional): string
• notNullFlag(optional): boolean
• operator(optional): string
  Allowed Values: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• range(optional): object Range
• value(optional): string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "range":{
            "$ref":"#/components/schemas/Range"
        }
    },
    "type":"object"
}

Nested Schema : Range

Type: object

Show Source

• from(optional): string
• to(optional): string

{
    "properties":{
        "from":{
            "type":"string"
        },
        "to":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : DefaultMap

Type: object

Show Source

• mapMode(optional): string
• mapName(optional): string
• mapType(optional): string
• objectType(optional): string

{
    "properties":{
        "mapMode":{
            "type":"string"
        },
        "mapName":{
            "type":"string"
        },
        "mapType":{
            "type":"string"
        },
        "objectType":{
            "type":"string"
        }
    },
    "type":"object"
}

Request Body - application/json ()

A body of type:

• application/json
• application/xml

Root Schema : schema

Type: object

Show Source

• defaultAdvFilters(optional): array defaultAdvFilters
• defaultFilters(optional): array defaultFilters
• defaultMaps(optional): array defaultMaps
• defaultOutputFormat(optional): string

{
    "properties":{
        "defaultAdvFilters":{
            "items":{
                "$ref":"#/components/schemas/DefaultAdvFiltersInfo"
            },
            "type":"array"
        },
        "defaultFilters":{
            "items":{
            },
            "type":"array"
        },
        "defaultMaps":{
            "items":{
                "$ref":"#/components/schemas/DefaultMap"
            },
            "type":"array"
        },
        "defaultOutputFormat":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : defaultAdvFilters

Type: array

Show Source

• Array of: object DefaultAdvFiltersInfo

{
    "items":{
        "$ref":"#/components/schemas/DefaultAdvFiltersInfo"
    },
    "type":"array"
}

Nested Schema : defaultFilters

Type: array

Show Source

• Array of:

{
    "items":{
    },
    "type":"array"
}

Nested Schema : defaultMaps

Type: array

Show Source

• Array of: object DefaultMap

{
    "items":{
        "$ref":"#/components/schemas/DefaultMap"
    },
    "type":"array"
}

Nested Schema : DefaultAdvFiltersInfo

Type: object

Show Source

• filterFields(optional): array filterFields
• objectType(optional): string
  Allowed Values: [ "COMPANY", "CONTACT" ]
• radialFilter(optional): object RadialFilter
• rangeFilters(optional): array rangeFilters

{
    "properties":{
        "filterFields":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        },
        "objectType":{
            "$ref":"#/components/schemas/ObjectType1"
        },
        "radialFilter":{
            "$ref":"#/components/schemas/RadialFilter"
        },
        "rangeFilters":{
            "items":{
                "$ref":"#/components/schemas/RangeFilterInfo"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : filterFields

Type: array

Show Source

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

Nested Schema : RadialFilter

Type: object

Show Source

• countryName(optional): string
• isNotNullFlag(optional): boolean
• name(optional): string
• notNullFlag(optional): boolean
• operator(optional): string
  Allowed Values: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• radius(optional): string
• unit(optional): string
  Allowed Values: [ "km", "mi" ]
• value(optional): string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        },
        "countryName":{
            "type":"string"
        },
        "radius":{
            "type":"string"
        },
        "unit":{
            "$ref":"#/components/schemas/UNIT"
        }
    },
    "type":"object"
}

Nested Schema : rangeFilters

Type: array

Show Source

• Array of: object RangeFilterInfo

{
    "items":{
        "$ref":"#/components/schemas/RangeFilterInfo"
    },
    "type":"array"
}

Nested Schema : FilterInfo

Type: object

Show Source

• isNotNullFlag(optional): boolean
• name(optional): string
• notNullFlag(optional): boolean
• operator(optional): string
  Allowed Values: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• value(optional): string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : RangeFilterInfo

Type: object

Show Source

• isNotNullFlag(optional): boolean
• name(optional): string
• notNullFlag(optional): boolean
• operator(optional): string
  Allowed Values: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• range(optional): object Range
• value(optional): string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "range":{
            "$ref":"#/components/schemas/Range"
        }
    },
    "type":"object"
}

Nested Schema : Range

Type: object

Show Source

• from(optional): string
• to(optional): string

{
    "properties":{
        "from":{
            "type":"string"
        },
        "to":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : DefaultMap

Type: object

Show Source

• mapMode(optional): string
• mapName(optional): string
• mapType(optional): string
• objectType(optional): string

{
    "properties":{
        "mapMode":{
            "type":"string"
        },
        "mapName":{
            "type":"string"
        },
        "mapType":{
            "type":"string"
        },
        "objectType":{
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success

Body ()

Root Schema : Defaults

Type: object

Title: Defaults

Show Source

• defaultAdvFilters(optional): array defaultAdvFilters
• defaultFilters(optional): array defaultFilters
• defaultMaps(optional): array defaultMaps
• defaultOutputFormat(optional): string

{
    "properties":{
        "defaultAdvFilters":{
            "items":{
                "$ref":"#/components/schemas/DefaultAdvFiltersInfo"
            },
            "type":"array"
        },
        "defaultFilters":{
            "items":{
            },
            "type":"array"
        },
        "defaultMaps":{
            "items":{
                "$ref":"#/components/schemas/DefaultMap"
            },
            "type":"array"
        },
        "defaultOutputFormat":{
            "type":"string"
        }
    },
    "title":"Defaults",
    "type":"object"
}

Nested Schema : defaultAdvFilters

Type: array

Show Source

• Array of: object DefaultAdvFiltersInfo

{
    "items":{
        "$ref":"#/components/schemas/DefaultAdvFiltersInfo"
    },
    "type":"array"
}

Nested Schema : defaultFilters

Type: array

Show Source

• Array of:

{
    "items":{
    },
    "type":"array"
}

Nested Schema : defaultMaps

Type: array

Show Source

• Array of: object DefaultMap

{
    "items":{
        "$ref":"#/components/schemas/DefaultMap"
    },
    "type":"array"
}

Nested Schema : DefaultAdvFiltersInfo

Type: object

Show Source

• filterFields(optional): array filterFields
• objectType(optional): string
  Allowed Values: [ "COMPANY", "CONTACT" ]
• radialFilter(optional): object RadialFilter
• rangeFilters(optional): array rangeFilters

{
    "properties":{
        "filterFields":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        },
        "objectType":{
            "$ref":"#/components/schemas/ObjectType1"
        },
        "radialFilter":{
            "$ref":"#/components/schemas/RadialFilter"
        },
        "rangeFilters":{
            "items":{
                "$ref":"#/components/schemas/RangeFilterInfo"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : filterFields

Type: array

Show Source

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

Nested Schema : RadialFilter

Type: object

Show Source

• countryName(optional): string
• isNotNullFlag(optional): boolean
• name(optional): string
• notNullFlag(optional): boolean
• operator(optional): string
  Allowed Values: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• radius(optional): string
• unit(optional): string
  Allowed Values: [ "km", "mi" ]
• value(optional): string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        },
        "countryName":{
            "type":"string"
        },
        "radius":{
            "type":"string"
        },
        "unit":{
            "$ref":"#/components/schemas/UNIT"
        }
    },
    "type":"object"
}

Nested Schema : rangeFilters

Type: array

Show Source

• Array of: object RangeFilterInfo

{
    "items":{
        "$ref":"#/components/schemas/RangeFilterInfo"
    },
    "type":"array"
}

Nested Schema : FilterInfo

Type: object

Show Source

• isNotNullFlag(optional): boolean
• name(optional): string
• notNullFlag(optional): boolean
• operator(optional): string
  Allowed Values: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• value(optional): string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : RangeFilterInfo

Type: object

Show Source

• isNotNullFlag(optional): boolean
• name(optional): string
• notNullFlag(optional): boolean
• operator(optional): string
  Allowed Values: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• range(optional): object Range
• value(optional): string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "range":{
            "$ref":"#/components/schemas/Range"
        }
    },
    "type":"object"
}

Nested Schema : Range

Type: object

Show Source

• from(optional): string
• to(optional): string

{
    "properties":{
        "from":{
            "type":"string"
        },
        "to":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : DefaultMap

Type: object

Show Source

• mapMode(optional): string
• mapName(optional): string
• mapType(optional): string
• objectType(optional): string

{
    "properties":{
        "mapMode":{
            "type":"string"
        },
        "mapName":{
            "type":"string"
        },
        "mapType":{
            "type":"string"
        },
        "objectType":{
            "type":"string"
        }
    },
    "type":"object"
}

404 Response

Requested resource could not be found.

Body ()

Root Schema : schema

Type: object

500 Response

An unexpected error occurred during the request.

Body ()

Root Schema : schema

Type: object

Back to Top

Examples

Example Request:

/api/v4/admin/defaults

Example Request Body:

 {
     "defaultFilters": [
         {
             "filterName": "CompanyInBusiness",
             "filterValue":"Y"
         },
         {
             "filterName": "Enterprise Companies",
             "filterValue":"Y"
         },
         {
         		"filterName": "Defunct",
         		"filterValue":"N"
         }
     ],
     "defaultMaps": [
         {
             "mapMode": "CRM_STANDARD",
             "mapName": "CXContactExport",
             "mapType": "EXPORT",
             "objectType": "CONTACT"
         },
         {
             "mapMode": "CRM_STANDARD",
             "mapName": "CXCompanyExport",
             "mapType": "EXPORT",
             "objectType": "COMPANY"
         },
         {
             "mapMode": "CRM_STANDARD",
             "mapName": "CXContactMatch",
             "mapType": "ENRICH",
             "objectType": "CONTACT"
         },
         {
             "mapMode": "CRM_STANDARD",
             "mapName": "CXCompanyMatch",
             "mapType": "ENRICH",
             "objectType": "COMPANY"
         }
     ]
     "defaultOutputFormat": "TXT"
}

Example Response:

 {
     "defaultFilters": [
         {
             "filterName": "CompanyInBusiness",
             "filterValue":"Y"
         },
         {
             "filterName": "Enterprise Companies",
             "filterValue":"N"
         },
         {
         		"filterName": "Defunct",
         		"filterValue":"Y"
         }
     ],
     "defaultMaps": [
         {
             "mapMode": "CRM_STANDARD",
             "mapName": "CXContactExport",
             "mapType": "EXPORT",
             "objectType": "CONTACT"
         },
         {
             "mapMode": "CRM_STANDARD",
             "mapName": "CXCompanyExport",
             "mapType": "EXPORT",
             "objectType": "COMPANY"
         },
         {
             "mapMode": "CRM_STANDARD",
             "mapName": "CXContactMatch",
             "mapType": "ENRICH",
             "objectType": "CONTACT"
         },
         {
             "mapMode": "CRM_STANDARD",
             "mapName": "CXCompanyMatch",
             "mapType": "ENRICH",
             "objectType": "COMPANY"
         }
     ]
     "defaultOutputFormat": "TXT"
}

Back to Top