Update the settings for People360 such as postal address validation etc - cobra CRM Cloud

Request

Path Params

id

string | null

optional

Id of the entity to update.

Header Params

X-Integration-Name

string

required

Integration name

Example:

API Documentation

X-Integration-Provider

string

required

Integration provider

Example:

cobra GmbH

X-Cobra-TenantId

string

required

Tenant ID

Example:

12e39e53-ece1-4d8d-8958-e782de1dbef0

X-Integration-Contact

string

optional

Integration contact

Example:

info@cobra.de

Accept-Language

string

optional

Example:

de

Body Params application/json

DTO for create and update operations for the settings collection.

isAddressValidationActive

boolean

optional

Indicates if the address validation is active.
Each address will be checked with the 'Address Quality Service'.

Example:

true

Example

{
    "isAddressValidationActive": true
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request PUT 'https://api.cobra.de/v1/crm/settings/{id}' \
--header 'X-Integration-Name: API Documentation' \
--header 'X-Integration-Provider: cobra GmbH' \
--header 'X-Cobra-TenantId: 12e39e53-ece1-4d8d-8958-e782de1dbef0' \
--header 'Content-Type: application/json' \
--data-raw '{
    "isAddressValidationActive": true
}'

Responses

🟢200OK

application/json

OK

Body

data

object (SettingsForDetailed)

optional

The output DTO for the settings collection.

id

string | null

optional

Gets or sets the identifier for the entity.

Example:

123456789012345678901234

createdBy

string | null

optional

Gets or sets the name of the user who created the entity, if available.

Example:

Username

modifiedBy

string | null

optional

Gets or sets the name of the user who last modified the entity, if available.

Example:

Username

dateCreated

string <date-time> | null

optional

Gets or sets the date and time when the entity was created, if available.

Example:

2024-02-19T08:57:43.041Z

dateModified

string <date-time> | null

optional

Gets or sets the date and time when the entity was last modified, if available.

Example:

2024-02-19T08:57:43.041Z

createdByUserId

string <uuid> | null

optional

Gets or sets the ID of the user who created the entity, if available.

Example:

c0316f28-4d2d-4c79-b5fc-bd25f2bca40c

modifiedByUserId

string <uuid> | null

optional

Gets or sets the ID of the user who last modified the entity, if available.

Example:

c0316f28-4d2d-4c79-b5fc-bd25f2bca40c

isAddressValidationActive

boolean

optional

Indicates if the address validation is active.
Each address will be checked with the 'Address Quality Service'.

Example:

true

message

string | null

optional

metaData

object (ResponseMetaData)

optional

totalResults

integer <int32>

optional

responseTimeStamp

string <date-time>

optional

statusCode

integer <int32>

optional

Example

{
    "data": {
        "id": "123456789012345678901234",
        "createdBy": "Username",
        "modifiedBy": "Username",
        "dateCreated": "2024-02-19T08:57:43.041Z",
        "dateModified": "2024-02-19T08:57:43.041Z",
        "createdByUserId": "c0316f28-4d2d-4c79-b5fc-bd25f2bca40c",
        "modifiedByUserId": "c0316f28-4d2d-4c79-b5fc-bd25f2bca40c",
        "isAddressValidationActive": true
    },
    "message": "string",
    "metaData": {
        "totalResults": 0,
        "responseTimeStamp": "2019-08-24T14:15:22Z"
    },
    "statusCode": 0
}

🟠400Bad Request