Logo

Enterprise

The Esper Enterprise APIs manage the account information set up for your company account.

Find out more about enterprise settings

Get your enterprise information

Returns Enterprise instance

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

A UUID string identifying this enterprise.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/v1/enterprise/{enterprise_id}/
Request samples 
Response samples 
application/json
{
  • "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": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}
Partial update enterprise information
Returns updated enterprise


SecurityapiKey 
Request 
path Parameters
enterprise_id
required
string <uuid> 
A UUID string identifying this enterprise.


 
Request Body schema: */*
required
name
string (Enterprise Name)   [ 1 .. 255 ] characters 
Name of the enterprise


 
registered_name
string (Registered name)   [ 1 .. 255 ] characters 
Registered Name of the enterprise


 
registered_address
string (Registered address)   [ 1 .. 255 ] characters 
Registered address of the enterprise.


 
location
string (Enterprise location)   [ 1 .. 255 ] characters 
City, State, Country location of the enterprise


 
zipcode
string (Enterprise zipcode)   [ 1 .. 8 ] characters 
Description of the enterprise


 
contact_person
string or null (Contact person)   [ 1 .. 255 ] characters 
Person who is the point of contact for the enterprise


 
contact_number
string or null (Contact number)   [ 1 .. 20 ] characters 
Contact number of the enterprise


 
contact_email
string <email>  (Contact email)   [ 1 .. 254 ] characters 
Contact email address of the enterprise


 
wifi_lte_toggle_flag
boolean (Enable data saver mode) 
Will only be available if feature is enabled


 
Responses 
200
successful operation


400
Invalid request.


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


patch/v1/enterprise/{enterprise_id}/
Request samples 
Response samples 
application/json
{
  • "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": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}
➔ Next to Application