Skip to content

Create a new company

POST
/companies

Create a new company

object
company_name
required

Name of the company to create

string
>= 1 characters

Company created successfully

object
success
required

Indicates if the request was successful

boolean
message
required

Response message

string
success
boolean
message
string
Allowed values: CREATED
data
Array<object>
object
company_id
required

Unique identifier for the company

integer format: int64
company_name
required

Name of the company

string
industry

Industry sector of the company

string
nullable
created_at
required

Timestamp when the company was created

string format: date-time

Bad request - invalid input

object
success
required

Indicates if the request was successful

boolean
message
required

Response message

string
success
boolean
message
string
Allowed values: BAD_REQUEST

Unauthorized - authentication required

object
success
required

Indicates if the request was successful

boolean
message
required

Response message

string
success
boolean
message
string
Allowed values: UNAUTHORIZED

Conflict - resource already exists

object
success
required

Indicates if the request was successful

boolean
message
required

Response message

string
success
boolean
message
string
Allowed values: CONFLICT

Internal server error

object
success
required

Indicates if the request was successful

boolean
message
required

Response message

string
success
boolean
message
string
Allowed values: INTERNAL_SERVER_ERROR