Skip to main content
POST
Create a new Enterprise Child Organization (Account)

Authorizations

Authorization
string
header
required

The primary authentication method for the Mezmo API.

Pass the key in the Authorization header in the format Token <ACCESS TOKEN>. For example:

This key is used for all APIs with the exception of ingest.

Body

application/json

Represents a platform level account registration, authentication and authorization.

Represents a platform level account registration, authentication and authorization.

company
string

Name of the company which owns the account

Maximum string length: 250
Example:

"Snippet Factory"

owneremail
string<email>

Email address of account owner

Maximum string length: 320
Example:

"admin@snippetfactory.com"

external_id
string | null

And identifier that can be used to reference and id from a different system

Maximum string length: 255
Example:

"d615396c40"

plan
object

Billing plan and associated feature information pertaining

retention
integer<int32>

Data retention policy information pertaining to the account

Required range: 0 <= x <= 90
enable_syslog
boolean
default:false

Enables syslog ingestion for the new account via custom ports.

include_admins
boolean
default:false

If true, all enterprise admins will be added as members of the child account

Response

Response format containing the newly created account, in addition to the standard metadata object.

Response format containing the newly created account, in addition to the standard metadata object.

meta
object
required

Contains additional contextual information about the api response.

data
Account · object
required

Represents a platform level account registration, authentication and authorization.