Accounts (Private)

Manage partner accounts including creation, retrieval, updates, activation/deactivation, and recurring payment configuration. Requires Private API (Bearer token) authentication.

Get account by ID

GET

https://api.chameleoon.sk

/private/accounts/{id}

Returns details of a specific account.

Get account by ID › path Parameters

id

string · uuid · required

Unique account identifier

Get account by ID › Responses

Account details

AccountDto

id

string · uuid · required

Unique account identifier

name

string · required

Company or trading name of the account holder

street

string · required

Street name and building number of the account billing address

city

string · required

City or town of the account billing address

zipCode

string · required

Postal/ZIP code of the account billing address

countryCode

string · pattern: ^[A-Z]{2}$ · required

ISO 3166-1 alpha-2 country code of the account billing address (e.g., "SK", "CZ")

email

string · email · required

Primary contact email address for billing and platform notifications

phone

string · required

Primary contact phone number including country code (e.g., +421901234567)

status

string · enum · required

Current account status; inactive accounts cannot create shipments or use API functionality

Enum values:

active

inactive

createdAt

string · date-time · required

Timestamp when the account was created (format yyyy-MM-ddTHH:mm:ss.fff)

changedAt

string · date-time · required

Timestamp when the account was last modified (format yyyy-MM-ddTHH:mm:ss.fff)

businessId

string

National business/company registration number (e.g., ICO in SK/CZ)

taxId

string

Tax identification number (e.g., DIC in SK/CZ)

vatId

string

VAT identification number for EU VAT purposes (e.g., IC DPH in SK/CZ)

credit

number · decimal

Current prepaid credit balance available for shipment processing

recurringPaymentsEnabled

boolean

Whether automatic top-up payments are enabled when credit balance drops below the configured threshold

object

Additional account-level configuration parameters as key-value pairs

Update account

PUT

https://api.chameleoon.sk

/private/accounts/{id}

Updates an existing account with new information.

Update account › path Parameters

id

string · uuid · required

Unique account identifier

Update account › Request Body

Request to update an existing account

UpdateAccountRequestDto

name

string · required

Company or trading name of the account holder

street

string · required

Street name and building number of the billing address

city

string · required

City or town of the billing address

zipCode

string · required

Postal/ZIP code of the billing address

countryCode

string · pattern: ^[A-Z]{2}$ · required

ISO 3166-1 alpha-2 country code of the billing address (e.g., "SK", "CZ")

email

string · email · required

Primary contact email address for billing and platform notifications

phone

string · required

Primary contact phone number including country code (e.g., +421901234567)

businessId

string

National business/company registration number (e.g., ICO in SK/CZ)

taxId

string

Tax identification number (e.g., DIC in SK/CZ)

vatId

string

VAT identification number for EU VAT purposes (e.g., IC DPH in SK/CZ)

object

Additional account-level configuration parameters as key-value pairs

Update account › Responses

Account updated successfully

Account details

AccountDto

id

string · uuid · required

Unique account identifier

name

string · required

Company or trading name of the account holder

street

string · required

Street name and building number of the account billing address

city

string · required

City or town of the account billing address

zipCode

string · required

Postal/ZIP code of the account billing address

countryCode

string · pattern: ^[A-Z]{2}$ · required

ISO 3166-1 alpha-2 country code of the account billing address (e.g., "SK", "CZ")

email

string · email · required

Primary contact email address for billing and platform notifications

phone

string · required

Primary contact phone number including country code (e.g., +421901234567)

status

string · enum · required

Current account status; inactive accounts cannot create shipments or use API functionality

Enum values:

active

inactive

createdAt

string · date-time · required

Timestamp when the account was created (format yyyy-MM-ddTHH:mm:ss.fff)

changedAt

string · date-time · required

Timestamp when the account was last modified (format yyyy-MM-ddTHH:mm:ss.fff)

businessId

string

National business/company registration number (e.g., ICO in SK/CZ)

taxId

string

Tax identification number (e.g., DIC in SK/CZ)

vatId

string

VAT identification number for EU VAT purposes (e.g., IC DPH in SK/CZ)

credit

number · decimal

Current prepaid credit balance available for shipment processing

recurringPaymentsEnabled

boolean

Whether automatic top-up payments are enabled when credit balance drops below the configured threshold

object

Additional account-level configuration parameters as key-value pairs

PUT/private/accounts/{id}

curl https://api.chameleoon.sk/private/accounts/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "ACME Corporation",
  "street": "Main Street 123",
  "city": "Bratislava",
  "zipCode": "12345",
  "countryCode": "SK",
  "email": "contact@acme.com",
  "phone": "+421901234567",
  "businessId": "12345678",
  "taxId": "2023456789",
  "vatId": "SK2023456789",
  "parameters": {
    "key": "string"
  }
}'

Example Request Body

{
  "name": "ACME Corporation",
  "street": "Main Street 123",
  "city": "Bratislava",
  "zipCode": "12345",
  "countryCode": "SK",
  "email": "contact@acme.com",
  "phone": "+421901234567",
  "businessId": "12345678",
  "taxId": "2023456789",
  "vatId": "SK2023456789",
  "parameters": {
    "key": "string"
  }
}

json

Example Responses

{
  "id": "e5b357eb-837d-41c0-82c8-663b8399ff47",
  "name": "ACME Corporation",
  "street": "Main Street 123",
  "city": "Bratislava",
  "zipCode": "12345",
  "countryCode": "SK",
  "email": "contact@acme.com",
  "phone": "+421901234567",
  "businessId": "12345678",
  "taxId": "2023456789",
  "vatId": "SK2023456789",
  "credit": 150,
  "recurringPaymentsEnabled": true,
  "status": "active",
  "parameters": {
    "key": "string"
  },
  "createdAt": "2024-01-15T10:30:00.000",
  "changedAt": "2024-06-20T14:45:00.000"
}

json

application/json

List accounts

GET

https://api.chameleoon.sk

/private/accounts

Returns a paginated list of partner accounts created by the caller's organization. Results are automatically scoped to accounts where the creating organization matches the M2M client's partner.

List accounts › query Parameters

name

string

Filter by account name (partial match)

email

string · email

Filter by email address (partial match)

businessId

string

Filter by business/company registration number (exact match)

parameters[key]

string

Filter by account parameter key-value pair. Use bracket notation to specify the parameter key (e.g., parameters[externalId]=abc123). Multiple parameter filters can be combined.

page

integer · min: 1

Page number for pagination

Default: 1

pageSize

integer · min: 1 · max: 100

Number of items per page

Default: 20

List accounts › Responses

Paginated list of accounts

PagedAccountListDto

page

integer · required

Current page number

pageSize

integer · required

Number of items per page

totalPages

integer · required

Total number of pages

nextPage

boolean · required

Whether a next page exists

previousPage

boolean · required

Whether a previous page exists

itemsCount

integer · required

Total number of items across all pages

AccountListItemDto[]

List of accounts

GET/private/accounts

curl https://api.chameleoon.sk/private/accounts \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "page": 1,
  "pageSize": 20,
  "totalPages": 5,
  "nextPage": true,
  "previousPage": false,
  "itemsCount": 95,
  "items": [
    {
      "id": "e5b357eb-837d-41c0-82c8-663b8399ff47",
      "name": "ACME Corporation",
      "street": "Main Street 123",
      "city": "Bratislava",
      "zipCode": "12345",
      "countryCode": "SK",
      "email": "contact@acme.com",
      "phone": "+421901234567",
      "businessId": "12345678",
      "taxId": "2023456789",
      "vatId": "SK2023456789",
      "status": "active",
      "parameters": {
        "key": "string"
      },
      "createdAt": "2024-01-15T10:30:00.000",
      "changedAt": "2024-06-20T14:45:00.000"
    }
  ]
}

json

application/json

Create account

POST

https://api.chameleoon.sk

/private/accounts

Creates a new account. API keys are managed separately via /private/api-keys.

Create account › Request Body

Request to create a new account

CreateAccountRequestDto

name

string · required

Company or trading name of the account holder

street

string · required

Street name and building number of the billing address

city

string · required

City or town of the billing address

zipCode

string · required

Postal/ZIP code of the billing address

countryCode

string · pattern: ^[A-Z]{2}$ · required

ISO 3166-1 alpha-2 country code of the billing address (e.g., "SK", "CZ")

email

string · email · required

Primary contact email address for billing and platform notifications

phone

string · required

Primary contact phone number including country code (e.g., +421901234567)

businessId

string

National business/company registration number (e.g., ICO in SK/CZ)

taxId

string

Tax identification number (e.g., DIC in SK/CZ)

vatId

string

VAT identification number for EU VAT purposes (e.g., IC DPH in SK/CZ)

object

Additional account-level configuration parameters as key-value pairs

Create account › Responses

Account created successfully

Account details

AccountDto

id

string · uuid · required

Unique account identifier

name

string · required

Company or trading name of the account holder

street

string · required

Street name and building number of the account billing address

city

string · required

City or town of the account billing address

zipCode

string · required

Postal/ZIP code of the account billing address

countryCode

string · pattern: ^[A-Z]{2}$ · required

ISO 3166-1 alpha-2 country code of the account billing address (e.g., "SK", "CZ")

email

string · email · required

Primary contact email address for billing and platform notifications

phone

string · required

Primary contact phone number including country code (e.g., +421901234567)

status

string · enum · required

Current account status; inactive accounts cannot create shipments or use API functionality

Enum values:

active

inactive

createdAt

string · date-time · required

Timestamp when the account was created (format yyyy-MM-ddTHH:mm:ss.fff)

changedAt

string · date-time · required

Timestamp when the account was last modified (format yyyy-MM-ddTHH:mm:ss.fff)

businessId

string

National business/company registration number (e.g., ICO in SK/CZ)

taxId

string

Tax identification number (e.g., DIC in SK/CZ)

vatId

string

VAT identification number for EU VAT purposes (e.g., IC DPH in SK/CZ)

credit

number · decimal

Current prepaid credit balance available for shipment processing

recurringPaymentsEnabled

boolean

Whether automatic top-up payments are enabled when credit balance drops below the configured threshold

object

Additional account-level configuration parameters as key-value pairs

POST/private/accounts

curl https://api.chameleoon.sk/private/accounts \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "ACME Corporation",
  "street": "Main Street 123",
  "city": "Bratislava",
  "zipCode": "12345",
  "countryCode": "SK",
  "email": "contact@acme.com",
  "phone": "+421901234567",
  "businessId": "12345678",
  "taxId": "2023456789",
  "vatId": "SK2023456789",
  "parameters": {
    "key": "string"
  }
}'

Example Request Body

{
  "name": "ACME Corporation",
  "street": "Main Street 123",
  "city": "Bratislava",
  "zipCode": "12345",
  "countryCode": "SK",
  "email": "contact@acme.com",
  "phone": "+421901234567",
  "businessId": "12345678",
  "taxId": "2023456789",
  "vatId": "SK2023456789",
  "parameters": {
    "key": "string"
  }
}

json

Example Responses

{
  "id": "e5b357eb-837d-41c0-82c8-663b8399ff47",
  "name": "ACME Corporation",
  "street": "Main Street 123",
  "city": "Bratislava",
  "zipCode": "12345",
  "countryCode": "SK",
  "email": "contact@acme.com",
  "phone": "+421901234567",
  "businessId": "12345678",
  "taxId": "2023456789",
  "vatId": "SK2023456789",
  "credit": 150,
  "recurringPaymentsEnabled": true,
  "status": "active",
  "parameters": {
    "key": "string"
  },
  "createdAt": "2024-01-15T10:30:00.000",
  "changedAt": "2024-06-20T14:45:00.000"
}

json

application/json

Activate account

PUT

https://api.chameleoon.sk

/private/accounts/{id}/activate

Activates a previously deactivated account.

Activate account › path Parameters

id

string · uuid · required

Unique account identifier

Activate account › Responses

Account activated successfully

No data returned

Deactivate account

PUT

https://api.chameleoon.sk

/private/accounts/{id}/deactivate

Deactivates an account. Deactivated accounts cannot create shipments or use API functionality until reactivated. Existing shipments and data are retained.

Deactivate account › path Parameters

id

string · uuid · required

Unique account identifier

Deactivate account › Responses

Account deactivated successfully

No data returned

Delete recurring payment configuration

DELETE

https://api.chameleoon.sk

/private/accounts/{id}/recurring-payments

Removes recurring payment configuration and stored payment method for an account.

Delete recurring payment configuration › path Parameters

id

string · uuid · required

Unique account identifier

Delete recurring payment configuration › Responses

Recurring payment configuration deleted successfully

No data returned

Authentication API Keys (Private)

Get account by ID

GET

https://api.chameleoon.sk

/private/accounts/{id}

Returns details of a specific account.

Get account by ID › path Parameters

id

string · uuid · required

Unique account identifier

Get account by ID › Responses

Account details

AccountDto

id

string · uuid · required

Unique account identifier

name

string · required

Company or trading name of the account holder

street

string · required

Street name and building number of the account billing address

city

string · required

City or town of the account billing address

zipCode

string · required

Postal/ZIP code of the account billing address

countryCode

string · pattern: ^[A-Z]{2}$ · required

ISO 3166-1 alpha-2 country code of the account billing address (e.g., "SK", "CZ")

email

string · email · required

Primary contact email address for billing and platform notifications

phone

string · required

Primary contact phone number including country code (e.g., +421901234567)

status

string · enum · required

Current account status; inactive accounts cannot create shipments or use API functionality

Enum values:

active

inactive

createdAt

string · date-time · required

Timestamp when the account was created (format yyyy-MM-ddTHH:mm:ss.fff)

changedAt

string · date-time · required

Timestamp when the account was last modified (format yyyy-MM-ddTHH:mm:ss.fff)

businessId

string

National business/company registration number (e.g., ICO in SK/CZ)

taxId

string

Tax identification number (e.g., DIC in SK/CZ)

vatId

string

VAT identification number for EU VAT purposes (e.g., IC DPH in SK/CZ)

credit

number · decimal

Current prepaid credit balance available for shipment processing

recurringPaymentsEnabled

boolean

Whether automatic top-up payments are enabled when credit balance drops below the configured threshold

object

Additional account-level configuration parameters as key-value pairs

Update account

PUT

https://api.chameleoon.sk

/private/accounts/{id}

Updates an existing account with new information.

Update account › path Parameters

id

string · uuid · required

Unique account identifier

Update account › Request Body

Request to update an existing account

UpdateAccountRequestDto

name

string · required

Company or trading name of the account holder

street

string · required

Street name and building number of the billing address

city

string · required

City or town of the billing address

zipCode

string · required

Postal/ZIP code of the billing address

countryCode

string · pattern: ^[A-Z]{2}$ · required

ISO 3166-1 alpha-2 country code of the billing address (e.g., "SK", "CZ")

email

string · email · required

Primary contact email address for billing and platform notifications

phone

string · required

Primary contact phone number including country code (e.g., +421901234567)

businessId

string

National business/company registration number (e.g., ICO in SK/CZ)

taxId

string

Tax identification number (e.g., DIC in SK/CZ)

vatId

string

VAT identification number for EU VAT purposes (e.g., IC DPH in SK/CZ)

object

Additional account-level configuration parameters as key-value pairs

Update account › Responses

Account updated successfully

Account details

AccountDto

id

string · uuid · required

Unique account identifier

name

string · required

Company or trading name of the account holder

street

string · required

Street name and building number of the account billing address

city

string · required

City or town of the account billing address

zipCode

string · required

Postal/ZIP code of the account billing address

countryCode

string · pattern: ^[A-Z]{2}$ · required

ISO 3166-1 alpha-2 country code of the account billing address (e.g., "SK", "CZ")

email

string · email · required

Primary contact email address for billing and platform notifications

phone

string · required

Primary contact phone number including country code (e.g., +421901234567)

status

string · enum · required

Current account status; inactive accounts cannot create shipments or use API functionality

Enum values:

active

inactive

createdAt

string · date-time · required

Timestamp when the account was created (format yyyy-MM-ddTHH:mm:ss.fff)

changedAt

string · date-time · required

Timestamp when the account was last modified (format yyyy-MM-ddTHH:mm:ss.fff)

businessId

string

National business/company registration number (e.g., ICO in SK/CZ)

taxId

string

Tax identification number (e.g., DIC in SK/CZ)

vatId

string

VAT identification number for EU VAT purposes (e.g., IC DPH in SK/CZ)

credit

number · decimal

Current prepaid credit balance available for shipment processing

recurringPaymentsEnabled

boolean

Whether automatic top-up payments are enabled when credit balance drops below the configured threshold

object

Additional account-level configuration parameters as key-value pairs

List accounts

GET

https://api.chameleoon.sk

/private/accounts

Returns a paginated list of partner accounts created by the caller's organization. Results are automatically scoped to accounts where the creating organization matches the M2M client's partner.

List accounts › query Parameters

name

string

Filter by account name (partial match)

email

string · email

Filter by email address (partial match)

businessId

string

Filter by business/company registration number (exact match)

parameters[key]

string

Filter by account parameter key-value pair. Use bracket notation to specify the parameter key (e.g., parameters[externalId]=abc123). Multiple parameter filters can be combined.

page

integer · min: 1

Page number for pagination

Default: 1

pageSize

integer · min: 1 · max: 100

Number of items per page

Default: 20

List accounts › Responses

Paginated list of accounts

PagedAccountListDto

page

integer · required

Current page number

pageSize

integer · required

Number of items per page

totalPages

integer · required

Total number of pages

nextPage

boolean · required

Whether a next page exists

previousPage

boolean · required

Whether a previous page exists

itemsCount

integer · required

Total number of items across all pages

AccountListItemDto[]

List of accounts

Create account

POST

https://api.chameleoon.sk

/private/accounts

Creates a new account. API keys are managed separately via /private/api-keys.

Create account › Request Body

Request to create a new account

CreateAccountRequestDto

name

string · required

Company or trading name of the account holder

street

string · required

Street name and building number of the billing address

city

string · required

City or town of the billing address

zipCode

string · required

Postal/ZIP code of the billing address

countryCode

string · pattern: ^[A-Z]{2}$ · required

ISO 3166-1 alpha-2 country code of the billing address (e.g., "SK", "CZ")

email

string · email · required

Primary contact email address for billing and platform notifications

phone

string · required

Primary contact phone number including country code (e.g., +421901234567)

businessId

string

National business/company registration number (e.g., ICO in SK/CZ)

taxId

string

Tax identification number (e.g., DIC in SK/CZ)

vatId

string

VAT identification number for EU VAT purposes (e.g., IC DPH in SK/CZ)

object

Additional account-level configuration parameters as key-value pairs

Create account › Responses

Account created successfully

Account details

AccountDto

id

string · uuid · required

Unique account identifier

name

string · required

Company or trading name of the account holder

street

string · required

Street name and building number of the account billing address

city

string · required

City or town of the account billing address

zipCode

string · required

Postal/ZIP code of the account billing address

countryCode

string · pattern: ^[A-Z]{2}$ · required

ISO 3166-1 alpha-2 country code of the account billing address (e.g., "SK", "CZ")

email

string · email · required

Primary contact email address for billing and platform notifications

phone

string · required

Primary contact phone number including country code (e.g., +421901234567)

status

string · enum · required

Current account status; inactive accounts cannot create shipments or use API functionality

Enum values:

active

inactive

createdAt

string · date-time · required

Timestamp when the account was created (format yyyy-MM-ddTHH:mm:ss.fff)

changedAt

string · date-time · required

Timestamp when the account was last modified (format yyyy-MM-ddTHH:mm:ss.fff)

businessId

string

National business/company registration number (e.g., ICO in SK/CZ)

taxId

string

Tax identification number (e.g., DIC in SK/CZ)

vatId

string

VAT identification number for EU VAT purposes (e.g., IC DPH in SK/CZ)

credit

number · decimal

Current prepaid credit balance available for shipment processing

recurringPaymentsEnabled

boolean

Whether automatic top-up payments are enabled when credit balance drops below the configured threshold

object

Additional account-level configuration parameters as key-value pairs

Deactivate account

PUT

https://api.chameleoon.sk

/private/accounts/{id}/deactivate

Deactivates an account. Deactivated accounts cannot create shipments or use API functionality until reactivated. Existing shipments and data are retained.

Deactivate account › path Parameters

id

string · uuid · required

Unique account identifier

Deactivate account › Responses

Account deactivated successfully

No data returned

Delete recurring payment configuration

DELETE

https://api.chameleoon.sk

/private/accounts/{id}/recurring-payments

Removes recurring payment configuration and stored payment method for an account.

Delete recurring payment configuration › path Parameters

id

string · uuid · required

Unique account identifier

Delete recurring payment configuration › Responses

Recurring payment configuration deleted successfully

No data returned