Skip to main content
POST
Create Language
A Language represents a supported language in the system. Languages are used for localising the user interface, email templates, and customer-facing content.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the Language-Create role.

Request Body

Required Fields

integer
required
ID of the business linked to this record.
string
required
The name value for this language.
string
required
The culture value for this language.
integer
required
The display order value for this language.

Optional Fields

boolean
Whether this language is currently active.

Code Examples

Response

200

integer
HTTP status code. 200 on success.
string
A human-readable message confirming the creation.
object
Contains the Id of the newly created record.
boolean
true if the language was created successfully.
array
null on success.
Example Response

400

string
A summary of the validation error(s), in the format PropertyName: error message.
any
null on validation failure.
object[]
Array of validation errors.
boolean
false when the request fails validation.
Example Response