Skip to content

Edit customer

Request

Change name, disabled state or data source configuration for customer.

PATCH https://partners.zoined.com/api/customers/{id}

Security
partnerToken
Path
idstringrequired

id of customer

Example:dm_company
Bodyapplication/jsonrequired
namestring

Customer's name

Example:"New name"
disabledboolean

Customer's processing state. Disabled customers don't poll for new data and customer users have no portal access nor receive emails.

Example:false
dataSourceobject(DataSourceConfiguration)
licensesArray of strings

Array of customer product licenses

Example:
[
  "limited"
]
curl -i -X PATCH \
  https://zone-api.zoined.com/_mock/api/customers/dm_company \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "New name",
    "disabled": false,
    "dataSource": {
      "host": "db-host",
      "port": 3306,
      "database": "database_name",
      "username": "db-username",
      "password": "db-password"
    },
    "licenses": [
      "limited"
    ]
  }'

Responses

Customer was updated successfully.

Bodyapplication/json
keystring

Company's key

Example:"dm_company"
namestring

Company name

Example:"Demo company"
createdAtstring

12-10T12:12:30Z (string) - Customer creation time stamp

Example:"2019"
disabledboolean

Customers's processing state. Disabled customers don't poll for new data

Example:false
productionboolean

Whether customer is in production mode

Example:true
customerTypestring

Customer Type

Example:"other"
tokenstring

ZAPI access token for customer if applicable

Example:"abcdefghijklmn"
statusstring

Status for the customer

Example:"ok"
licensesArray of strings

Customer product licenses

Example:
[
  "standard"
]
dataUpdatedobject(DataUpdated)
dataSourceobject(DataSourceConfigurationResponse)
ssoSecretstring

SSO token if defined

Example:"asdajksdajdsjsdadjsasodaj"
Response
{
  "key": "dm_company",
  "name": "Demo company",
  "createdAt": "2019",
  "disabled": false,
  "production": true,
  "customerType": "other",
  "token": "abcdefghijklmn",
  "status": "ok",
  "licenses": [
    "standard"
  ],
  "dataUpdated": {
    "visitors": "2016-03-22T13:02:36.000+02:00"
  },
  "dataSource": {
    "host": "db-host",
    "port": 3306,
    "database": "database_name",
    "username": "db-username",
    "password": "db-XXXXXXXX"
  },
  "ssoSecret": "asdajksdajdsjsdadjsasodaj"
}