Learnifier

Adds an Organization Unit

POST

/orgunits

Organization Units

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://learnifier.com/orgunits' \
--header 'Content-Type: application/json' \
--data-raw '{
    "caller": "81590981-1e05-4fd5-aa15-15bc4b06cf7f",
    "clientNumber": "X-1234",
    "country": "se",
    "displayName": "Sample Corp",
    "externalId": "string",
    "parent": "1234"
}'

Response Example

200 - Example 1

{
    "ouId": "12"
}

Request

Body Params application/json

caller

string <uuid>

optional

The id of the user that initiated this operation

Example:

81590981-1e05-4fd5-aa15-15bc4b06cf7f

clientNumber

string

optional

A client number. Sometimes used when communicating with external system. Must be unique if specified.

Example:

X-1234

country

string <locale>

optional

The country code that best matches the organization unit. If unspecified the platform default will be set.

Example:

displayName

string

required

The name shown for the organization unit

Example:

Sample Corp

externalId

string

optional

The external id (foreign key). Must not exceed 255 characters.

parent

number

optional

A Organization Unit id of the parent Organization Unit (optional).

Example:

1234

Examples

Responses

🟢200Organization Unit was successfully added

application/json

Body

ouId

number <int64>

optional

The Organization Unit id

Example:

🟠409An organization with the same clientNumber or external id already existed.

🔴500Unexpected error

Organization Units

Get Organization Unit