Updates a contract
curl --request PUT \
--url https://api.chargecloud.dev/api/v1/crm/contracts/{uuid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ext_contract_id": "<string>",
"external_id": "<string>",
"customer_group_id": 123,
"campaign_id": 123,
"company_name": "<string>",
"firstname": "<string>",
"surname": "<string>",
"street": "<string>",
"house_number": "<string>",
"zip": "<string>",
"city": "<string>",
"country_id": 123,
"phone": "<string>",
"email": "<string>",
"reference_field_1": "<string>",
"reference_field_2": "<string>",
"billing_company": "<string>",
"billing_title": "<string>",
"billing_firstname": "<string>",
"billing_surname": "<string>",
"billing_street": "<string>",
"billing_house_number": "<string>",
"billing_zip": "<string>",
"billing_city": "<string>",
"billing_country_id": 123,
"billing_email": "<string>",
"billing_phone": "<string>",
"disabled": false,
"auth_enabled": false,
"auth_username": "<string>",
"is_employer": false,
"payment_method_id": 123,
"attributes": "<string>"
}
'import requests
url = "https://api.chargecloud.dev/api/v1/crm/contracts/{uuid}"
payload = {
"ext_contract_id": "<string>",
"external_id": "<string>",
"customer_group_id": 123,
"campaign_id": 123,
"company_name": "<string>",
"firstname": "<string>",
"surname": "<string>",
"street": "<string>",
"house_number": "<string>",
"zip": "<string>",
"city": "<string>",
"country_id": 123,
"phone": "<string>",
"email": "<string>",
"reference_field_1": "<string>",
"reference_field_2": "<string>",
"billing_company": "<string>",
"billing_title": "<string>",
"billing_firstname": "<string>",
"billing_surname": "<string>",
"billing_street": "<string>",
"billing_house_number": "<string>",
"billing_zip": "<string>",
"billing_city": "<string>",
"billing_country_id": 123,
"billing_email": "<string>",
"billing_phone": "<string>",
"disabled": False,
"auth_enabled": False,
"auth_username": "<string>",
"is_employer": False,
"payment_method_id": 123,
"attributes": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ext_contract_id: '<string>',
external_id: '<string>',
customer_group_id: 123,
campaign_id: 123,
company_name: '<string>',
firstname: '<string>',
surname: '<string>',
street: '<string>',
house_number: '<string>',
zip: '<string>',
city: '<string>',
country_id: 123,
phone: '<string>',
email: '<string>',
reference_field_1: '<string>',
reference_field_2: '<string>',
billing_company: '<string>',
billing_title: '<string>',
billing_firstname: '<string>',
billing_surname: '<string>',
billing_street: '<string>',
billing_house_number: '<string>',
billing_zip: '<string>',
billing_city: '<string>',
billing_country_id: 123,
billing_email: '<string>',
billing_phone: '<string>',
disabled: false,
auth_enabled: false,
auth_username: '<string>',
is_employer: false,
payment_method_id: 123,
attributes: '<string>'
})
};
fetch('https://api.chargecloud.dev/api/v1/crm/contracts/{uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.chargecloud.dev/api/v1/crm/contracts/{uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'ext_contract_id' => '<string>',
'external_id' => '<string>',
'customer_group_id' => 123,
'campaign_id' => 123,
'company_name' => '<string>',
'firstname' => '<string>',
'surname' => '<string>',
'street' => '<string>',
'house_number' => '<string>',
'zip' => '<string>',
'city' => '<string>',
'country_id' => 123,
'phone' => '<string>',
'email' => '<string>',
'reference_field_1' => '<string>',
'reference_field_2' => '<string>',
'billing_company' => '<string>',
'billing_title' => '<string>',
'billing_firstname' => '<string>',
'billing_surname' => '<string>',
'billing_street' => '<string>',
'billing_house_number' => '<string>',
'billing_zip' => '<string>',
'billing_city' => '<string>',
'billing_country_id' => 123,
'billing_email' => '<string>',
'billing_phone' => '<string>',
'disabled' => false,
'auth_enabled' => false,
'auth_username' => '<string>',
'is_employer' => false,
'payment_method_id' => 123,
'attributes' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.chargecloud.dev/api/v1/crm/contracts/{uuid}"
payload := strings.NewReader("{\n \"ext_contract_id\": \"<string>\",\n \"external_id\": \"<string>\",\n \"customer_group_id\": 123,\n \"campaign_id\": 123,\n \"company_name\": \"<string>\",\n \"firstname\": \"<string>\",\n \"surname\": \"<string>\",\n \"street\": \"<string>\",\n \"house_number\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"country_id\": 123,\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"reference_field_1\": \"<string>\",\n \"reference_field_2\": \"<string>\",\n \"billing_company\": \"<string>\",\n \"billing_title\": \"<string>\",\n \"billing_firstname\": \"<string>\",\n \"billing_surname\": \"<string>\",\n \"billing_street\": \"<string>\",\n \"billing_house_number\": \"<string>\",\n \"billing_zip\": \"<string>\",\n \"billing_city\": \"<string>\",\n \"billing_country_id\": 123,\n \"billing_email\": \"<string>\",\n \"billing_phone\": \"<string>\",\n \"disabled\": false,\n \"auth_enabled\": false,\n \"auth_username\": \"<string>\",\n \"is_employer\": false,\n \"payment_method_id\": 123,\n \"attributes\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.chargecloud.dev/api/v1/crm/contracts/{uuid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ext_contract_id\": \"<string>\",\n \"external_id\": \"<string>\",\n \"customer_group_id\": 123,\n \"campaign_id\": 123,\n \"company_name\": \"<string>\",\n \"firstname\": \"<string>\",\n \"surname\": \"<string>\",\n \"street\": \"<string>\",\n \"house_number\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"country_id\": 123,\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"reference_field_1\": \"<string>\",\n \"reference_field_2\": \"<string>\",\n \"billing_company\": \"<string>\",\n \"billing_title\": \"<string>\",\n \"billing_firstname\": \"<string>\",\n \"billing_surname\": \"<string>\",\n \"billing_street\": \"<string>\",\n \"billing_house_number\": \"<string>\",\n \"billing_zip\": \"<string>\",\n \"billing_city\": \"<string>\",\n \"billing_country_id\": 123,\n \"billing_email\": \"<string>\",\n \"billing_phone\": \"<string>\",\n \"disabled\": false,\n \"auth_enabled\": false,\n \"auth_username\": \"<string>\",\n \"is_employer\": false,\n \"payment_method_id\": 123,\n \"attributes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chargecloud.dev/api/v1/crm/contracts/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ext_contract_id\": \"<string>\",\n \"external_id\": \"<string>\",\n \"customer_group_id\": 123,\n \"campaign_id\": 123,\n \"company_name\": \"<string>\",\n \"firstname\": \"<string>\",\n \"surname\": \"<string>\",\n \"street\": \"<string>\",\n \"house_number\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"country_id\": 123,\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"reference_field_1\": \"<string>\",\n \"reference_field_2\": \"<string>\",\n \"billing_company\": \"<string>\",\n \"billing_title\": \"<string>\",\n \"billing_firstname\": \"<string>\",\n \"billing_surname\": \"<string>\",\n \"billing_street\": \"<string>\",\n \"billing_house_number\": \"<string>\",\n \"billing_zip\": \"<string>\",\n \"billing_city\": \"<string>\",\n \"billing_country_id\": 123,\n \"billing_email\": \"<string>\",\n \"billing_phone\": \"<string>\",\n \"disabled\": false,\n \"auth_enabled\": false,\n \"auth_username\": \"<string>\",\n \"is_employer\": false,\n \"payment_method_id\": 123,\n \"attributes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"contract": {
"uuid": "<string>",
"type": "energy",
"blocked": false,
"disabled": false,
"billing_blocked": false,
"dunning_locked": false,
"account_id": 123,
"business": false,
"salutation": "0",
"firstname": "<string>",
"surname": "<string>",
"street": "<string>",
"house_number": "<string>",
"zip": "<string>",
"city": "<string>",
"phone": "<string>",
"email": "<string>",
"billing_salutation": "0",
"billing_firstname": "<string>",
"billing_surname": "<string>",
"billing_street": "<string>",
"billing_house_number": "<string>",
"billing_zip": "<string>",
"billing_city": "<string>",
"billing_email": "<string>",
"billing_phone": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"ordered_at": "2023-11-07T05:31:56Z",
"status": "open",
"modification_date": "2023-11-07T05:31:56Z",
"ext_contract_id": "<string>",
"external_id": "<string>",
"customer_group_id": 123,
"company_name": "<string>",
"country_id": 123,
"reference_field_1": "<string>",
"reference_field_2": "<string>",
"billing_company": "<string>",
"billing_title": "<string>",
"billing_country_id": 123,
"title": "<string>",
"tax_code": "<string>",
"external_customer_id": "<string>",
"auth_enabled": false,
"auth_username": "<string>",
"phone_home": "<string>",
"phone_home_area_code": "<string>",
"phone_mobile": "<string>",
"phone_mobile_area_code": "<string>",
"phone_business": "<string>",
"phone_business_area_code": "<string>",
"email_private": "<string>",
"email_business": "<string>",
"advertising_agreement_mail": false,
"advertising_agreement_phone": false,
"advertising_agreement_email": false
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"errors": [
{
"errorKey": "<string>",
"message": "<string>",
"parameter": "<string>"
}
]
}V1
Updates a contract
Updates a contract. Required permission: crm:contracts:update. Available contexts: API Key
PUT
/
api
/
v1
/
crm
/
contracts
/
{uuid}
Updates a contract
curl --request PUT \
--url https://api.chargecloud.dev/api/v1/crm/contracts/{uuid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ext_contract_id": "<string>",
"external_id": "<string>",
"customer_group_id": 123,
"campaign_id": 123,
"company_name": "<string>",
"firstname": "<string>",
"surname": "<string>",
"street": "<string>",
"house_number": "<string>",
"zip": "<string>",
"city": "<string>",
"country_id": 123,
"phone": "<string>",
"email": "<string>",
"reference_field_1": "<string>",
"reference_field_2": "<string>",
"billing_company": "<string>",
"billing_title": "<string>",
"billing_firstname": "<string>",
"billing_surname": "<string>",
"billing_street": "<string>",
"billing_house_number": "<string>",
"billing_zip": "<string>",
"billing_city": "<string>",
"billing_country_id": 123,
"billing_email": "<string>",
"billing_phone": "<string>",
"disabled": false,
"auth_enabled": false,
"auth_username": "<string>",
"is_employer": false,
"payment_method_id": 123,
"attributes": "<string>"
}
'import requests
url = "https://api.chargecloud.dev/api/v1/crm/contracts/{uuid}"
payload = {
"ext_contract_id": "<string>",
"external_id": "<string>",
"customer_group_id": 123,
"campaign_id": 123,
"company_name": "<string>",
"firstname": "<string>",
"surname": "<string>",
"street": "<string>",
"house_number": "<string>",
"zip": "<string>",
"city": "<string>",
"country_id": 123,
"phone": "<string>",
"email": "<string>",
"reference_field_1": "<string>",
"reference_field_2": "<string>",
"billing_company": "<string>",
"billing_title": "<string>",
"billing_firstname": "<string>",
"billing_surname": "<string>",
"billing_street": "<string>",
"billing_house_number": "<string>",
"billing_zip": "<string>",
"billing_city": "<string>",
"billing_country_id": 123,
"billing_email": "<string>",
"billing_phone": "<string>",
"disabled": False,
"auth_enabled": False,
"auth_username": "<string>",
"is_employer": False,
"payment_method_id": 123,
"attributes": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ext_contract_id: '<string>',
external_id: '<string>',
customer_group_id: 123,
campaign_id: 123,
company_name: '<string>',
firstname: '<string>',
surname: '<string>',
street: '<string>',
house_number: '<string>',
zip: '<string>',
city: '<string>',
country_id: 123,
phone: '<string>',
email: '<string>',
reference_field_1: '<string>',
reference_field_2: '<string>',
billing_company: '<string>',
billing_title: '<string>',
billing_firstname: '<string>',
billing_surname: '<string>',
billing_street: '<string>',
billing_house_number: '<string>',
billing_zip: '<string>',
billing_city: '<string>',
billing_country_id: 123,
billing_email: '<string>',
billing_phone: '<string>',
disabled: false,
auth_enabled: false,
auth_username: '<string>',
is_employer: false,
payment_method_id: 123,
attributes: '<string>'
})
};
fetch('https://api.chargecloud.dev/api/v1/crm/contracts/{uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.chargecloud.dev/api/v1/crm/contracts/{uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'ext_contract_id' => '<string>',
'external_id' => '<string>',
'customer_group_id' => 123,
'campaign_id' => 123,
'company_name' => '<string>',
'firstname' => '<string>',
'surname' => '<string>',
'street' => '<string>',
'house_number' => '<string>',
'zip' => '<string>',
'city' => '<string>',
'country_id' => 123,
'phone' => '<string>',
'email' => '<string>',
'reference_field_1' => '<string>',
'reference_field_2' => '<string>',
'billing_company' => '<string>',
'billing_title' => '<string>',
'billing_firstname' => '<string>',
'billing_surname' => '<string>',
'billing_street' => '<string>',
'billing_house_number' => '<string>',
'billing_zip' => '<string>',
'billing_city' => '<string>',
'billing_country_id' => 123,
'billing_email' => '<string>',
'billing_phone' => '<string>',
'disabled' => false,
'auth_enabled' => false,
'auth_username' => '<string>',
'is_employer' => false,
'payment_method_id' => 123,
'attributes' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.chargecloud.dev/api/v1/crm/contracts/{uuid}"
payload := strings.NewReader("{\n \"ext_contract_id\": \"<string>\",\n \"external_id\": \"<string>\",\n \"customer_group_id\": 123,\n \"campaign_id\": 123,\n \"company_name\": \"<string>\",\n \"firstname\": \"<string>\",\n \"surname\": \"<string>\",\n \"street\": \"<string>\",\n \"house_number\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"country_id\": 123,\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"reference_field_1\": \"<string>\",\n \"reference_field_2\": \"<string>\",\n \"billing_company\": \"<string>\",\n \"billing_title\": \"<string>\",\n \"billing_firstname\": \"<string>\",\n \"billing_surname\": \"<string>\",\n \"billing_street\": \"<string>\",\n \"billing_house_number\": \"<string>\",\n \"billing_zip\": \"<string>\",\n \"billing_city\": \"<string>\",\n \"billing_country_id\": 123,\n \"billing_email\": \"<string>\",\n \"billing_phone\": \"<string>\",\n \"disabled\": false,\n \"auth_enabled\": false,\n \"auth_username\": \"<string>\",\n \"is_employer\": false,\n \"payment_method_id\": 123,\n \"attributes\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.chargecloud.dev/api/v1/crm/contracts/{uuid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ext_contract_id\": \"<string>\",\n \"external_id\": \"<string>\",\n \"customer_group_id\": 123,\n \"campaign_id\": 123,\n \"company_name\": \"<string>\",\n \"firstname\": \"<string>\",\n \"surname\": \"<string>\",\n \"street\": \"<string>\",\n \"house_number\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"country_id\": 123,\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"reference_field_1\": \"<string>\",\n \"reference_field_2\": \"<string>\",\n \"billing_company\": \"<string>\",\n \"billing_title\": \"<string>\",\n \"billing_firstname\": \"<string>\",\n \"billing_surname\": \"<string>\",\n \"billing_street\": \"<string>\",\n \"billing_house_number\": \"<string>\",\n \"billing_zip\": \"<string>\",\n \"billing_city\": \"<string>\",\n \"billing_country_id\": 123,\n \"billing_email\": \"<string>\",\n \"billing_phone\": \"<string>\",\n \"disabled\": false,\n \"auth_enabled\": false,\n \"auth_username\": \"<string>\",\n \"is_employer\": false,\n \"payment_method_id\": 123,\n \"attributes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chargecloud.dev/api/v1/crm/contracts/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ext_contract_id\": \"<string>\",\n \"external_id\": \"<string>\",\n \"customer_group_id\": 123,\n \"campaign_id\": 123,\n \"company_name\": \"<string>\",\n \"firstname\": \"<string>\",\n \"surname\": \"<string>\",\n \"street\": \"<string>\",\n \"house_number\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"country_id\": 123,\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"reference_field_1\": \"<string>\",\n \"reference_field_2\": \"<string>\",\n \"billing_company\": \"<string>\",\n \"billing_title\": \"<string>\",\n \"billing_firstname\": \"<string>\",\n \"billing_surname\": \"<string>\",\n \"billing_street\": \"<string>\",\n \"billing_house_number\": \"<string>\",\n \"billing_zip\": \"<string>\",\n \"billing_city\": \"<string>\",\n \"billing_country_id\": 123,\n \"billing_email\": \"<string>\",\n \"billing_phone\": \"<string>\",\n \"disabled\": false,\n \"auth_enabled\": false,\n \"auth_username\": \"<string>\",\n \"is_employer\": false,\n \"payment_method_id\": 123,\n \"attributes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"contract": {
"uuid": "<string>",
"type": "energy",
"blocked": false,
"disabled": false,
"billing_blocked": false,
"dunning_locked": false,
"account_id": 123,
"business": false,
"salutation": "0",
"firstname": "<string>",
"surname": "<string>",
"street": "<string>",
"house_number": "<string>",
"zip": "<string>",
"city": "<string>",
"phone": "<string>",
"email": "<string>",
"billing_salutation": "0",
"billing_firstname": "<string>",
"billing_surname": "<string>",
"billing_street": "<string>",
"billing_house_number": "<string>",
"billing_zip": "<string>",
"billing_city": "<string>",
"billing_email": "<string>",
"billing_phone": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"ordered_at": "2023-11-07T05:31:56Z",
"status": "open",
"modification_date": "2023-11-07T05:31:56Z",
"ext_contract_id": "<string>",
"external_id": "<string>",
"customer_group_id": 123,
"company_name": "<string>",
"country_id": 123,
"reference_field_1": "<string>",
"reference_field_2": "<string>",
"billing_company": "<string>",
"billing_title": "<string>",
"billing_country_id": 123,
"title": "<string>",
"tax_code": "<string>",
"external_customer_id": "<string>",
"auth_enabled": false,
"auth_username": "<string>",
"phone_home": "<string>",
"phone_home_area_code": "<string>",
"phone_mobile": "<string>",
"phone_mobile_area_code": "<string>",
"phone_business": "<string>",
"phone_business_area_code": "<string>",
"email_private": "<string>",
"email_business": "<string>",
"advertising_agreement_mail": false,
"advertising_agreement_phone": false,
"advertising_agreement_email": false
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"errors": [
{
"errorKey": "<string>",
"message": "<string>",
"parameter": "<string>"
}
]
}Authorizations
OAuth2 Bearer Authorization
Path Parameters
Contract UUID
Maximum string length:
36Body
application/json
Updates a contract. Required permission: crm:contracts:update. Available contexts: API Key
Contract identifier as known by an external CRM. This is the primary field used to match ChargeCloud contracts to records in upstream systems (EDI feeds, partner integrations, migrations). Max 50 chars.
Maximum string length:
50External customer id
Maximum string length:
15Customer group id
Campaign id
Company name
Maximum string length:
255Salutation code for the contract holder. New private/business registrations only accept {1, 2, 3, 8}.
Available options:
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 Firstname
Maximum string length:
70Surname
Maximum string length:
70Street
Maximum string length:
255House number
Maximum string length:
16Postal code of the contract holder's primary address. Length and format are validated against country_id — invalid combinations are rejected.
Maximum string length:
16City
Maximum string length:
128Country id
Phone
Maximum string length:
255Maximum string length:
255Free-text client-configurable reference. Common use cases include TecDoc identifiers, HC (Hauptkunde) numbers, cost centres, purchase-order numbers, and project IDs. No semantic enforcement by the system.
Maximum string length:
255Second free-text client-configurable reference, parallel to reference_field_1. Same use cases (TecDoc, HC, cost centres, etc.) — provided as a second slot when one reference is not enough.
Maximum string length:
255Billing company
Maximum string length:
255Salutation code for the billing recipient. Same value set as salutation.
Available options:
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 Billing title
Maximum string length:
70Billing firstname
Maximum string length:
70Billing surname
Maximum string length:
70Billing street
Maximum string length:
255Billing house number
Maximum string length:
16Billing ZIP
Maximum string length:
16Billing city
Maximum string length:
128Billing country id
Billing email
Maximum string length:
128Billing phone
Maximum string length:
128Disabled
App login enabled
App login username
Maximum string length:
255Is employer contract
Payment method ID
JSON-encoded map of contract attributes (e.g. {"attribute_key":"value", ...}). Keys and value types are configured per client — see the Attributes API for the available set. Unknown keys are rejected; optional attributes fall back to their configured default when omitted.
Response
Edited contract
Contract
Show child attributes
Show child attributes
⌘I