Skip to content

Partially update company settings
Stable

Request

Partially updates the company settings for the specified enterprise, returning the full updated record. Supply only the fields you want to change — all omitted fields retain their current values.

About Partial Update Company Settings

This endpoint (formerly "Partial Update Enterprise Information") applies sparse updates to the EnterpriseV1 record using the EnterpriseUpdateV1 schema. All fields in the request body are optional; only those included will be changed. Read-only fields (id, short_code, created_on, updated_on, emm) cannot be modified and should be omitted from the request body. The response returns the complete updated EnterpriseV1 object. Call GET /v1/enterprise/{enterprise_id}/ first to retrieve current values before making changes.

Key Fields

enterprise_id (path, required) — UUID of the enterprise to update

name (optional) — Display name of the enterprise (max 255 chars)

registered_name (optional) — Formal legal name of the organization

registered_address (optional) — Registered business address

location (optional) — City, state, and country

zipcode (optional) — Postal code for the enterprise location (max 8 chars)

contact_person (optional, nullable) — Primary point-of-contact name

contact_number (optional, nullable) — Contact phone number

contact_email (optional) — Contact email address

wifi_lte_toggle_flag (optional) — Toggles data saver mode; only effective if the feature is enabled for the enterprise

Common Use Cases

Updating enterprise contact details after an organizational change

Correcting the registered name or address on file

Toggling wifi_lte_toggle_flag when enabling or disabling data saver mode

Best Practices

Call GET /v1/enterprise/{enterprise_id}/ first to confirm current values before issuing a PATCH

Include only the fields you intend to change; PATCH is safe to use for single-field updates

Do not include id, short_code, created_on, updated_on, or emm in the request body — they are read-only and will be ignored or may cause errors

Verify the update took effect by inspecting the returned EnterpriseV1 object in the response

Workflow

Call GET /v1/enterprise/{enterprise_id}/ to retrieve the current enterprise record

Construct a partial payload containing only the fields to update

Call PATCH /v1/enterprise/{enterprise_id}/ with the payload

Confirm the changes in the returned EnterpriseV1 response object

Security
esper_cloud_api_apiKey
Path
enterprise_idstring, (uuid)required

A UUID string identifying this enterprise.

Body*/*required
namestring, [ 1 .. 255 ] characters(Enterprise Name)

Name of the enterprise

registered_namestring, [ 1 .. 255 ] characters(Registered name)

Registered Name of the enterprise

registered_addressstring, [ 1 .. 255 ] characters(Registered address)

Registered address of the enterprise.

locationstring, [ 1 .. 255 ] characters(Enterprise location)

City, State, Country location of the enterprise

zipcodestring, [ 1 .. 8 ] characters(Enterprise zipcode)

Description of the enterprise

contact_personstring or null, [ 1 .. 255 ] characters(Contact person)

Person who is the point of contact for the enterprise

contact_numberstring or null, [ 1 .. 20 ] characters(Contact number)

Contact number of the enterprise

contact_emailstring, (email), [ 1 .. 254 ] characters(Contact email)

Contact email address of the enterprise

wifi_lte_toggle_flagboolean(Enable data saver mode)

Will only be available if feature is enabled

cURL
curl -i -X PATCH \
  'https://api.esper.io/_mock/openapi/v1/enterprise/{enterprise_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: */*' \
  -d '{
    "name": "string",
    "registered_name": "string",
    "registered_address": "string",
    "location": "string",
    "zipcode": "string",
    "contact_person": "string",
    "contact_number": "string",
    "contact_email": "user@example.com",
    "wifi_lte_toggle_flag": true
  }'

Responses

successful operation

Bodyapplication/json
idstring, (uuid)(Id)read-onlyrequired

Id of the enterprise

namestring, [ 1 .. 255 ] characters(Name)required

Name of the enterprise

short_codestring, [ 1 .. 10 ] characters(Short code)read-onlyrequired

A short 10-char representation of the enterprise, separated by hyphens. Field is optional, as system will auto-generate a value if none is provided.

registered_namestring, [ 1 .. 255 ] characters(Registered name of the enterprise)

Registered Name of the enterprise

registered_addressstring, [ 1 .. 255 ] characters(Registered address)

Registered address of the enterprise.

locationstring, [ 1 .. 255 ] characters(Enterprise location)

City, State, Country location of the enterprise

zipcodestring, [ 1 .. 8 ] characters(Enterprise zipcode)

Zip code of enterprise location

contact_personstring or null, [ 1 .. 255 ] characters(Contact person)

Person who is the point of contact for the enterprise

contact_numberstring or null, [ 1 .. 20 ] characters(Contact number)

Contact number of the enterprise

contact_emailstring, (email), [ 1 .. 254 ] characters(Contact email)

Contact email address of the enterprise

wifi_lte_toggle_flagboolean(Enable data saver mode)

Will only be available if feature is enabled

emmobject or null(Google EMM)read-only

This field will have details about emm enrollment if the enterprise is emm enrolled

created_onstring, (date-time)(Created on)read-only

Date and time of when this resource was created

updated_onstring, (date-time)(Updated on)read-only

Date and time of when this resource was updated

Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "short_code": "string",
  "registered_name": "string",
  "registered_address": "string",
  "location": "string",
  "zipcode": "string",
  "contact_person": "string",
  "contact_number": "string",
  "contact_email": "user@example.com",
  "wifi_lte_toggle_flag": true,
  "emm": {
    "google_enterprise_id": "string"
  },
  "created_on": "2019-08-24T14:15:22Z",
  "updated_on": "2019-08-24T14:15:22Z"
}