Skip to content

Partially update an account

PATCH
/v1/account/{id}/

Update one or more fields of an existing account.

id
required
string format: uuid

A UUID string identifying this account.

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object
address_line_1
string
<= 50 characters
address_line_2
string
<= 50 characters
admin_contact
Admin contact email
string format: email
<= 254 characters
agent_type_display
object
key
additional properties
boolean
billing_contact
Billing contact email
string format: email
<= 254 characters
city
string
<= 255 characters
account_config
string format: uuid
nullable
country_name
string
country
  • AF - Afghanistan
  • AX - Åland Islands
  • AL - Albania
  • DZ - Algeria
  • AS - American Samoa
  • AD - Andorra
  • AO - Angola
  • AI - Anguilla
  • AQ - Antarctica
  • AG - Antigua and Barbuda
  • AR - Argentina
  • AM - Armenia
  • AW - Aruba
  • AU - Australia
  • AT - Austria
  • AZ - Azerbaijan
  • BS - Bahamas (The)
  • BH - Bahrain
  • BD - Bangladesh
  • BB - Barbados
  • BY - Belarus
  • BE - Belgium
  • BZ - Belize
  • BJ - Benin
  • BM - Bermuda
  • BT - Bhutan
  • BO - Bolivia
  • BQ - Bonaire, Sint Eustatius and Saba
  • BA - Bosnia and Herzegovina
  • BW - Botswana
  • BV - Bouvet Island
  • BR - Brazil
  • IO - British Indian Ocean Territory
  • BN - Brunei
  • BG - Bulgaria
  • BF - Burkina Faso
  • BI - Burundi
  • CV - Cabo Verde
  • KH - Cambodia
  • CM - Cameroon
  • CA - Canada
  • KY - Cayman Islands
  • CF - Central African Republic
  • TD - Chad
  • CL - Chile
  • CN - China
  • CX - Christmas Island
  • CC - Cocos (Keeling) Islands
  • CO - Colombia
  • KM - Comoros
  • CG - Congo
  • CK - Cook Islands
  • CR - Costa Rica
  • CI - Côte d’Ivoire
  • HR - Croatia
  • CU - Cuba
  • CW - Curaçao
  • CY - Cyprus
  • CZ - Czechia
  • CD - Democratic Republic of the Congo
  • DK - Denmark
  • DJ - Djibouti
  • DM - Dominica
  • DO - Dominican Republic
  • EC - Ecuador
  • EG - Egypt
  • SV - El Salvador
  • GQ - Equatorial Guinea
  • ER - Eritrea
  • EE - Estonia
  • SZ - Eswatini
  • ET - Ethiopia
  • FK - Falkland Islands (Malvinas)
  • FO - Faroe Islands
  • FJ - Fiji
  • FI - Finland
  • FR - France
  • GF - French Guiana
  • PF - French Polynesia
  • TF - French Southern Territories
  • GA - Gabon
  • GM - Gambia
  • GE - Georgia
  • DE - Germany
  • GH - Ghana
  • GI - Gibraltar
  • GR - Greece
  • GL - Greenland
  • GD - Grenada
  • GP - Guadeloupe
  • GU - Guam
  • GT - Guatemala
  • GG - Guernsey
  • GN - Guinea
  • GW - Guinea-Bissau
  • GY - Guyana
  • HT - Haiti
  • HM - Heard Island and McDonald Islands
  • HN - Honduras
  • HK - Hong Kong
  • HU - Hungary
  • IS - Iceland
  • IN - India
  • ID - Indonesia
  • IR - Iran
  • IQ - Iraq
  • IE - Ireland
  • IM - Isle of Man
  • IL - Israel
  • IT - Italy
  • JM - Jamaica
  • JP - Japan
  • JE - Jersey
  • JO - Jordan
  • KZ - Kazakhstan
  • KE - Kenya
  • KI - Kiribati
  • KW - Kuwait
  • KG - Kyrgyzstan
  • LA - Laos
  • LV - Latvia
  • LB - Lebanon
  • LS - Lesotho
  • LR - Liberia
  • LY - Libya
  • LI - Liechtenstein
  • LT - Lithuania
  • LU - Luxembourg
  • MO - Macao
  • MG - Madagascar
  • MW - Malawi
  • MY - Malaysia
  • MV - Maldives
  • ML - Mali
  • MT - Malta
  • MH - Marshall Islands
  • MQ - Martinique
  • MR - Mauritania
  • MU - Mauritius
  • YT - Mayotte
  • MX - Mexico
  • FM - Micronesia
  • MD - Moldova
  • MC - Monaco
  • MN - Mongolia
  • ME - Montenegro
  • MS - Montserrat
  • MA - Morocco
  • MZ - Mozambique
  • MM - Myanmar
  • NA - Namibia
  • NR - Nauru
  • NP - Nepal
  • NL - Netherlands
  • NC - New Caledonia
  • NZ - New Zealand
  • NI - Nicaragua
  • NE - Niger
  • NG - Nigeria
  • NU - Niue
  • NF - Norfolk Island
  • KP - North Korea
  • MK - North Macedonia
  • MP - Northern Mariana Islands
  • NO - Norway
  • OM - Oman
  • PK - Pakistan
  • PW - Palau
  • PS - Palestine
  • PA - Panama
  • PG - Papua New Guinea
  • PY - Paraguay
  • PE - Peru
  • PH - Philippines
  • PN - Pitcairn
  • PL - Poland
  • PT - Portugal
  • PR - Puerto Rico
  • QA - Qatar
  • RE - Réunion
  • RO - Romania
  • RU - Russia
  • RW - Rwanda
  • BL - Saint Barthélemy
  • SH - Saint Helena
  • KN - Saint Kitts and Nevis
  • LC - Saint Lucia
  • MF - Saint Martin (French part)
  • PM - Saint Pierre and Miquelon
  • VC - Saint Vincent and the Grenadines
  • WS - Samoa
  • SM - San Marino
  • ST - Sao Tome and Principe
  • SA - Saudi Arabia
  • SN - Senegal
  • RS - Serbia
  • SC - Seychelles
  • SL - Sierra Leone
  • SG - Singapore
  • SX - Sint Maarten (Dutch part)
  • SK - Slovakia
  • SI - Slovenia
  • SB - Solomon Islands
  • SO - Somalia
  • ZA - South Africa
  • GS - South Georgia
  • KR - South Korea
  • SS - South Sudan
  • ES - Spain
  • LK - Sri Lanka
  • SD - Sudan
  • SR - Suriname
  • SJ - Svalbard and Jan Mayen
  • SE - Sweden
  • CH - Switzerland
  • SY - Syria
  • TW - Taiwan
  • TJ - Tajikistan
  • TZ - Tanzania
  • TH - Thailand
  • TL - Timor-Leste
  • TG - Togo
  • TK - Tokelau
  • TO - Tonga
  • TT - Trinidad and Tobago
  • TN - Tunisia
  • TR - Türkiye
  • TM - Turkmenistan
  • TC - Turks and Caicos Islands
  • TV - Tuvalu
  • UG - Uganda
  • UA - Ukraine
  • AE - United Arab Emirates
  • GB - United Kingdom
  • UM - United States Minor Outlying Islands
  • US - United States of America
  • UY - Uruguay
  • UZ - Uzbekistan
  • VU - Vanuatu
  • VA - Vatican City
  • VE - Venezuela
  • VN - Vietnam
  • VG - Virgin Islands (British)
  • VI - Virgin Islands (U.S.)
  • WF - Wallis and Futuna
  • EH - Western Sahara
  • YE - Yemen
  • ZM - Zambia
  • ZW - Zimbabwe
string
Allowed values: AF AX AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BQ BA BW BV BR IO BN BG BF BI CV KH CM CA KY CF TD CL CN CX CC CO KM CG CK CR CI HR CU CW CY CZ CD DK DJ DM DO EC EG SV GQ ER EE SZ ET FK FO FJ FI FR GF PF TF GA GM GE DE GH GI GR GL GD GP GU GT GG GN GW GY HT HM HN HK HU IS IN ID IR IQ IE IM IL IT JM JP JE JO KZ KE KI KW KG LA LV LB LS LR LY LI LT LU MO MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN ME MS MA MZ MM NA NR NP NL NC NZ NI NE NG NU NF KP MK MP NO OM PK PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW BL SH KN LC MF PM VC WS SM ST SA SN RS SC SL SG SX SK SI SB SO ZA GS KR SS ES LK SD SR SJ SE CH SY TW TJ TZ TH TL TG TK TO TT TN TR TM TC TV UG UA AE GB UM US UY UZ VU VA VE VN VG VI WF EH YE ZM ZW
created_at
string format: date-time
created_by
string format: uuid
nullable
current_membership
string format: uuid
deactivated_comment
string
deactivated_reason
  • 0 - I don’t use the solution anymore
  • 1 - The tool setup is too complicated
  • 2 - Doesn’t meet my expectations
  • 3 - I never have downtime, no need monitoring :)
  • 4 - Another solution suits me better
  • 5 - One essential feature is missing
  • 6 - Other
integer
nullable >= -2147483648 <= 2147483647
Allowed values: 0 1 2 3 4 5 6
deactivated_reason_text
string
events_start_at
string format: date-time
id
string format: uuid
modified_at
string format: date-time
modified_by
string format: uuid
nullable
name
string
<= 100 characters
number_logs_bytes
integer
number_monitors
integer
number_of_each_status
Array<object>
object
key
additional properties
integer
number_ok_monitors
integer
number_ok_services
integer
number_recordingrules
integer
number_servers_online
integer
number_servers
integer
number_services
integer
number_silenced
integer
parent
string format: uuid
nullable
phone_number
string
<= 128 characters
registration_key
string
sandbox_is_active
boolean
security_contact
Security contact email
string format: email
<= 254 characters
zip_code
string
<= 10 characters

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object
address_line_1
string
<= 50 characters
address_line_2
string
<= 50 characters
admin_contact
Admin contact email
string format: email
<= 254 characters
agent_type_display
required
object
key
additional properties
boolean
billing_contact
Billing contact email
string format: email
<= 254 characters
city
string
<= 255 characters
account_config
required
string format: uuid
nullable
country_name
required
string
country
required
  • AF - Afghanistan
  • AX - Åland Islands
  • AL - Albania
  • DZ - Algeria
  • AS - American Samoa
  • AD - Andorra
  • AO - Angola
  • AI - Anguilla
  • AQ - Antarctica
  • AG - Antigua and Barbuda
  • AR - Argentina
  • AM - Armenia
  • AW - Aruba
  • AU - Australia
  • AT - Austria
  • AZ - Azerbaijan
  • BS - Bahamas (The)
  • BH - Bahrain
  • BD - Bangladesh
  • BB - Barbados
  • BY - Belarus
  • BE - Belgium
  • BZ - Belize
  • BJ - Benin
  • BM - Bermuda
  • BT - Bhutan
  • BO - Bolivia
  • BQ - Bonaire, Sint Eustatius and Saba
  • BA - Bosnia and Herzegovina
  • BW - Botswana
  • BV - Bouvet Island
  • BR - Brazil
  • IO - British Indian Ocean Territory
  • BN - Brunei
  • BG - Bulgaria
  • BF - Burkina Faso
  • BI - Burundi
  • CV - Cabo Verde
  • KH - Cambodia
  • CM - Cameroon
  • CA - Canada
  • KY - Cayman Islands
  • CF - Central African Republic
  • TD - Chad
  • CL - Chile
  • CN - China
  • CX - Christmas Island
  • CC - Cocos (Keeling) Islands
  • CO - Colombia
  • KM - Comoros
  • CG - Congo
  • CK - Cook Islands
  • CR - Costa Rica
  • CI - Côte d’Ivoire
  • HR - Croatia
  • CU - Cuba
  • CW - Curaçao
  • CY - Cyprus
  • CZ - Czechia
  • CD - Democratic Republic of the Congo
  • DK - Denmark
  • DJ - Djibouti
  • DM - Dominica
  • DO - Dominican Republic
  • EC - Ecuador
  • EG - Egypt
  • SV - El Salvador
  • GQ - Equatorial Guinea
  • ER - Eritrea
  • EE - Estonia
  • SZ - Eswatini
  • ET - Ethiopia
  • FK - Falkland Islands (Malvinas)
  • FO - Faroe Islands
  • FJ - Fiji
  • FI - Finland
  • FR - France
  • GF - French Guiana
  • PF - French Polynesia
  • TF - French Southern Territories
  • GA - Gabon
  • GM - Gambia
  • GE - Georgia
  • DE - Germany
  • GH - Ghana
  • GI - Gibraltar
  • GR - Greece
  • GL - Greenland
  • GD - Grenada
  • GP - Guadeloupe
  • GU - Guam
  • GT - Guatemala
  • GG - Guernsey
  • GN - Guinea
  • GW - Guinea-Bissau
  • GY - Guyana
  • HT - Haiti
  • HM - Heard Island and McDonald Islands
  • HN - Honduras
  • HK - Hong Kong
  • HU - Hungary
  • IS - Iceland
  • IN - India
  • ID - Indonesia
  • IR - Iran
  • IQ - Iraq
  • IE - Ireland
  • IM - Isle of Man
  • IL - Israel
  • IT - Italy
  • JM - Jamaica
  • JP - Japan
  • JE - Jersey
  • JO - Jordan
  • KZ - Kazakhstan
  • KE - Kenya
  • KI - Kiribati
  • KW - Kuwait
  • KG - Kyrgyzstan
  • LA - Laos
  • LV - Latvia
  • LB - Lebanon
  • LS - Lesotho
  • LR - Liberia
  • LY - Libya
  • LI - Liechtenstein
  • LT - Lithuania
  • LU - Luxembourg
  • MO - Macao
  • MG - Madagascar
  • MW - Malawi
  • MY - Malaysia
  • MV - Maldives
  • ML - Mali
  • MT - Malta
  • MH - Marshall Islands
  • MQ - Martinique
  • MR - Mauritania
  • MU - Mauritius
  • YT - Mayotte
  • MX - Mexico
  • FM - Micronesia
  • MD - Moldova
  • MC - Monaco
  • MN - Mongolia
  • ME - Montenegro
  • MS - Montserrat
  • MA - Morocco
  • MZ - Mozambique
  • MM - Myanmar
  • NA - Namibia
  • NR - Nauru
  • NP - Nepal
  • NL - Netherlands
  • NC - New Caledonia
  • NZ - New Zealand
  • NI - Nicaragua
  • NE - Niger
  • NG - Nigeria
  • NU - Niue
  • NF - Norfolk Island
  • KP - North Korea
  • MK - North Macedonia
  • MP - Northern Mariana Islands
  • NO - Norway
  • OM - Oman
  • PK - Pakistan
  • PW - Palau
  • PS - Palestine
  • PA - Panama
  • PG - Papua New Guinea
  • PY - Paraguay
  • PE - Peru
  • PH - Philippines
  • PN - Pitcairn
  • PL - Poland
  • PT - Portugal
  • PR - Puerto Rico
  • QA - Qatar
  • RE - Réunion
  • RO - Romania
  • RU - Russia
  • RW - Rwanda
  • BL - Saint Barthélemy
  • SH - Saint Helena
  • KN - Saint Kitts and Nevis
  • LC - Saint Lucia
  • MF - Saint Martin (French part)
  • PM - Saint Pierre and Miquelon
  • VC - Saint Vincent and the Grenadines
  • WS - Samoa
  • SM - San Marino
  • ST - Sao Tome and Principe
  • SA - Saudi Arabia
  • SN - Senegal
  • RS - Serbia
  • SC - Seychelles
  • SL - Sierra Leone
  • SG - Singapore
  • SX - Sint Maarten (Dutch part)
  • SK - Slovakia
  • SI - Slovenia
  • SB - Solomon Islands
  • SO - Somalia
  • ZA - South Africa
  • GS - South Georgia
  • KR - South Korea
  • SS - South Sudan
  • ES - Spain
  • LK - Sri Lanka
  • SD - Sudan
  • SR - Suriname
  • SJ - Svalbard and Jan Mayen
  • SE - Sweden
  • CH - Switzerland
  • SY - Syria
  • TW - Taiwan
  • TJ - Tajikistan
  • TZ - Tanzania
  • TH - Thailand
  • TL - Timor-Leste
  • TG - Togo
  • TK - Tokelau
  • TO - Tonga
  • TT - Trinidad and Tobago
  • TN - Tunisia
  • TR - Türkiye
  • TM - Turkmenistan
  • TC - Turks and Caicos Islands
  • TV - Tuvalu
  • UG - Uganda
  • UA - Ukraine
  • AE - United Arab Emirates
  • GB - United Kingdom
  • UM - United States Minor Outlying Islands
  • US - United States of America
  • UY - Uruguay
  • UZ - Uzbekistan
  • VU - Vanuatu
  • VA - Vatican City
  • VE - Venezuela
  • VN - Vietnam
  • VG - Virgin Islands (British)
  • VI - Virgin Islands (U.S.)
  • WF - Wallis and Futuna
  • EH - Western Sahara
  • YE - Yemen
  • ZM - Zambia
  • ZW - Zimbabwe
string
Allowed values: AF AX AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BQ BA BW BV BR IO BN BG BF BI CV KH CM CA KY CF TD CL CN CX CC CO KM CG CK CR CI HR CU CW CY CZ CD DK DJ DM DO EC EG SV GQ ER EE SZ ET FK FO FJ FI FR GF PF TF GA GM GE DE GH GI GR GL GD GP GU GT GG GN GW GY HT HM HN HK HU IS IN ID IR IQ IE IM IL IT JM JP JE JO KZ KE KI KW KG LA LV LB LS LR LY LI LT LU MO MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN ME MS MA MZ MM NA NR NP NL NC NZ NI NE NG NU NF KP MK MP NO OM PK PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW BL SH KN LC MF PM VC WS SM ST SA SN RS SC SL SG SX SK SI SB SO ZA GS KR SS ES LK SD SR SJ SE CH SY TW TJ TZ TH TL TG TK TO TT TN TR TM TC TV UG UA AE GB UM US UY UZ VU VA VE VN VG VI WF EH YE ZM ZW
created_at
required
string format: date-time
created_by
required
string format: uuid
nullable
current_membership
required
string format: uuid
deactivated_comment
string
deactivated_reason
  • 0 - I don’t use the solution anymore
  • 1 - The tool setup is too complicated
  • 2 - Doesn’t meet my expectations
  • 3 - I never have downtime, no need monitoring :)
  • 4 - Another solution suits me better
  • 5 - One essential feature is missing
  • 6 - Other
integer
nullable >= -2147483648 <= 2147483647
Allowed values: 0 1 2 3 4 5 6
deactivated_reason_text
required
string
events_start_at
required
string format: date-time
id
required
string format: uuid
modified_at
required
string format: date-time
modified_by
required
string format: uuid
nullable
name
required
string
<= 100 characters
number_logs_bytes
required
integer
number_monitors
required
integer
number_of_each_status
required
Array<object>
object
key
additional properties
integer
number_ok_monitors
required
integer
number_ok_services
required
integer
number_recordingrules
required
integer
number_servers_online
required
integer
number_servers
required
integer
number_services
required
integer
number_silenced
required
integer
parent
string format: uuid
nullable
phone_number
string
<= 128 characters
registration_key
required
string
sandbox_is_active
boolean
security_contact
Security contact email
string format: email
<= 254 characters
zip_code
string
<= 10 characters