Enterprise

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

Get your enterprise information

Returns Enterprise instance

Request
Security:
path Parameters
enterprise_id
required
string <uuid>

A UUID string identifying this enterprise.

Responses
200

successful operation

get/v1/enterprise/{enterprise_id}/
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",
  • "emm": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Partial update enterprise information

Returns updated enterprise

Request
Security:
path Parameters
enterprise_id
required
string <uuid>

A UUID string identifying this enterprise.

Request Body schema: */*
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

Responses
200

successful operation

patch/v1/enterprise/{enterprise_id}/
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",
  • "emm": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}