Customer
post/v3/customers

Request

  • Base URL
    https://my.clockodo.com/api
  • URL
    https://my.clockodo.com/api/v3/customers
  • Auth
    • HTTP basic and API key in header X-Clockodo-External-Application
    • or API key in header X-ClockodoApiUser and API key in header X-ClockodoApiKey and API key in header X-Clockodo-External-Application
    • or OAuth 2
      Authorization code: /oauth/authorize
      Token URL: /token

Request body

activeboolean
bill_service_idstring nullable

Can only be set by administrators or workers with elevated access manage_customers_and_projects and if a billing application with customers support is linked up

billable_defaultboolean
color1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

Possible values:

  • 1: BloodOrange
  • 2: Sunflower
  • 3: LightGreen
  • 4: Caribbean
  • 5: Sky
  • 6: BrandBlue
  • 7: BluePurple
  • 8: Magenta
  • 9: ChewingGum
namestring required
notestring nullable

Can only be set by administrators or workers with elevated access manage_customers_and_projects

numberstring nullable

Freely selectable number for the customer

Response

Successful operation

Example response

{
  "data": {
    "id": 10,
    "name": "Hotel Bergblick",
    "number": "10",
    "note": "This customer is important for us",
    "bill_service_id": "1234",
    "service_assignments": [
      10
    ]
  }
}

Changes

    • warning

      added the new ArchiveCompanyDefaultIsNotAllowed enum value to the //// response property for the response status

    • warning

      added the new CannotModifyDemoData enum value to the //// response property for the response status

    • warning

      added the new HasToBeInactive enum value to the //// response property for the response status

    • warning

      added the new RelationsPreventDeletion enum value to the //// response property for the response status

    • warning

      added the new ResourceConflictFound enum value to the //// response property for the response status

    • warning

      added the new RunningEntriesPreventDeletion enum value to the //// response property for the response status

    • warning

      added the new UnexpectedValue enum value to the //// response property for the response status

    • warning

      added the new absences enum value to the ////// response property for the response status

    • warning

      added the new absences enum value to the ////// response property for the response status

    • warning

      added the new absences enum value to the ////// response property for the response status

    • warning

      added the new access_groups enum value to the ////// response property for the response status

    • warning

      added the new access_groups enum value to the ////// response property for the response status

    • warning

      added the new access_groups enum value to the ////// response property for the response status

    • warning

      added the new company enum value to the ////// response property for the response status

    • warning

      added the new company enum value to the ////// response property for the response status

    • warning

      added the new company enum value to the ////// response property for the response status

    • warning

      added the new company_state enum value to the ////// response property for the response status

    • warning

      added the new company_state enum value to the ////// response property for the response status

    • warning

      added the new company_state enum value to the ////// response property for the response status

    • warning

      added the new customers enum value to the ////// response property for the response status

    • warning

      added the new customers enum value to the ////// response property for the response status

    • warning

      added the new customers enum value to the ////// response property for the response status

    • warning

      added the new customers_projects_access enum value to the ////// response property for the response status

    • warning

      added the new customers_projects_access enum value to the ////// response property for the response status

    • warning

      added the new customers_projects_access enum value to the ////// response property for the response status

    • warning

      added the new entries enum value to the ////// response property for the response status

    • warning

      added the new entries enum value to the ////// response property for the response status

    • warning

      added the new entries enum value to the ////// response property for the response status

    • warning

      added the new favorite enum value to the ////// response property for the response status

    • warning

      added the new favorite enum value to the ////// response property for the response status

    • warning

      added the new favorite enum value to the ////// response property for the response status

    • warning

      added the new holidays_carry enum value to the ////// response property for the response status

    • warning

      added the new holidays_carry enum value to the ////// response property for the response status

    • warning

      added the new holidays_carry enum value to the ////// response property for the response status

    • warning

      added the new holidays_quota enum value to the ////// response property for the response status

    • warning

      added the new holidays_quota enum value to the ////// response property for the response status

    • warning

      added the new holidays_quota enum value to the ////// response property for the response status

    • warning

      added the new lumpsum_services enum value to the ////// response property for the response status

    • warning

      added the new lumpsum_services enum value to the ////// response property for the response status

    • warning

      added the new lumpsum_services enum value to the ////// response property for the response status

    • warning

      added the new nonbusiness_days enum value to the ////// response property for the response status

    • warning

      added the new nonbusiness_days enum value to the ////// response property for the response status

    • warning

      added the new nonbusiness_days enum value to the ////// response property for the response status

    • warning

      added the new nonbusiness_groups enum value to the ////// response property for the response status

    • warning

      added the new nonbusiness_groups enum value to the ////// response property for the response status

    • warning

      added the new nonbusiness_groups enum value to the ////// response property for the response status

    • warning

      added the new overtime_carrys enum value to the ////// response property for the response status

    • warning

      added the new overtime_carrys enum value to the ////// response property for the response status

    • warning

      added the new overtime_carrys enum value to the ////// response property for the response status

    • warning

      added the new project_reports enum value to the ////// response property for the response status

    • warning

      added the new project_reports enum value to the ////// response property for the response status

    • warning

      added the new project_reports enum value to the ////// response property for the response status

    • warning

      added the new project_reports_meta_data enum value to the ////// response property for the response status

    • warning

      added the new project_reports_meta_data enum value to the ////// response property for the response status

    • warning

      added the new project_reports_meta_data enum value to the ////// response property for the response status

    • warning

      added the new projects enum value to the ////// response property for the response status

    • warning

      added the new projects enum value to the ////// response property for the response status

    • warning

      added the new projects enum value to the ////// response property for the response status

    • warning

      added the new rates enum value to the ////// response property for the response status

    • warning

      added the new rates enum value to the ////// response property for the response status

    • warning

      added the new rates enum value to the ////// response property for the response status

    • warning

      added the new report_templates enum value to the ////// response property for the response status

    • warning

      added the new report_templates enum value to the ////// response property for the response status

    • warning

      added the new report_templates enum value to the ////// response property for the response status

    • warning

      added the new reports enum value to the ////// response property for the response status

    • warning

      added the new reports enum value to the ////// response property for the response status

    • warning

      added the new reports enum value to the ////// response property for the response status

    • warning

      added the new services enum value to the ////// response property for the response status

    • warning

      added the new services enum value to the ////// response property for the response status

    • warning

      added the new services enum value to the ////// response property for the response status

    • warning

      added the new subprojects enum value to the ////// response property for the response status

    • warning

      added the new subprojects enum value to the ////// response property for the response status

    • warning

      added the new subprojects enum value to the ////// response property for the response status

    • warning

      added the new surcharge_models enum value to the ////// response property for the response status

    • warning

      added the new surcharge_models enum value to the ////// response property for the response status

    • warning

      added the new surcharge_models enum value to the ////// response property for the response status

    • warning

      added the new targethours enum value to the ////// response property for the response status

    • warning

      added the new targethours enum value to the ////// response property for the response status

    • warning

      added the new targethours enum value to the ////// response property for the response status

    • warning

      added the new team enum value to the ////// response property for the response status

    • warning

      added the new team enum value to the ////// response property for the response status

    • warning

      added the new team enum value to the ////// response property for the response status

    • warning

      added the new users enum value to the ////// response property for the response status

    • warning

      added the new users enum value to the ////// response property for the response status

    • warning

      added the new users enum value to the ////// response property for the response status

    • warning

      added the new work_time_break_rules enum value to the ////// response property for the response status

    • warning

      added the new work_time_break_rules enum value to the ////// response property for the response status

    • warning

      added the new work_time_break_rules enum value to the ////// response property for the response status

    • warning

      added the new work_time_regulations enum value to the ////// response property for the response status

    • warning

      added the new work_time_regulations enum value to the ////// response property for the response status

    • warning

      added the new work_time_regulations enum value to the ////// response property for the response status

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added to the // response property anyOf list for the response status

    • info

      removed from the // response property anyOf list for the response status

    • breaking

      the request property type changed from integer to no type