Favicon

You are here: Home > API Reference > Organization > Add new organization

Add new organization

Add new organization

POST
/v1/organizations/
Copy to clipboard

Add new organization

Add new organization

Request

Add parameter in header authorization
Example: Authorization: Bearer <token>
Body Params application/json
name string required
≤ 128 characters
slug string optional
Slug
≤ 128 characters · ≥ 3 characters · Match pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$
configuration object optional
notificationLanguage string optional
es en fr de it zh pt ru
required2FADashboard boolean optional
required2FAStore boolean optional 
{
    "name": "string",
    "slug": "string",
    "configuration": {
        "notificationLanguage": "es",
        "required2FADashboard": true,
        "required2FAStore": true
    }
}

Responses

200 Response application/json
status boolean optional
data object optional
id string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 128 characters
slug string optional
Slug
≤ 128 characters · ≥ 3 characters · Match pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$
webSiteUrl string optional
≤ 256 characters
type string optional
personal company
subscriptions array [object] optional
plan string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
planCode string optional
≤ 256 characters
iniDate string optional
Format: date-time
endDate string optional
Format: date-time
endedAt string optional
Format: date-time
status string optional
active canceled past_due expired
metadata object optional
limits object optional
apps integer optional
≥ 0
builds integer optional
≥ 0
downloads integer optional
≥ 0
collaborators integer optional
≥ 0
employees integer optional
≥ 0
mdmDevices integer optional
≥ 0
locationTrackingTime integer optional
≥ 0
mdmAssetsStorageSize integer optional
≥ 0
maxBuildRetentionDays integer optional
≥ 0
maxBuildsRetainedPerPublication integer optional
≥ 0
maxPublicationsPerApp integer optional
≥ 0
mdmAutomationRules integer optional
≥ 0
deviceAudiences integer optional
≥ 0
userAudiences integer optional
≥ 0
allows object optional
passwordApps boolean optional
loggedApps boolean optional
unlistedApps boolean optional
loggedStores boolean optional
nativeSDK boolean optional
customBranding boolean optional
customDomain boolean optional
ssoLogin boolean optional
changeS3Bucket boolean optional
customS3Bucket boolean optional
appleIpad boolean optional
appleMac boolean optional
appleWatch boolean optional
appleTv boolean optional
androidZeroTouch boolean optional
appleDEP boolean optional
appleVPP boolean optional
serviceAccounts boolean optional
duplicatePolicy boolean optional
mdmAssets boolean optional
advancedLauncher boolean optional
androidAgent boolean optional
iosAgent boolean optional
macosAgent boolean optional
macosScripts boolean optional
androidManagedConfigurations boolean optional
appleManagedConfigurations boolean optional
androidRemoteSupport boolean optional
appleRemoteSupport boolean optional
inventory boolean optional
windowsMdm boolean optional
windowsAgent boolean optional
windowsScripts boolean optional
countryAccessControl boolean optional
assistant boolean optional
userAudiences boolean optional
unlimitedBuildRetention boolean optional
policyComposition boolean optional
deviceAudiences boolean optional
certificateProviders boolean optional
target string optional
company personal unknown
type string optional
standard default unknown mdm custom enterprise
periodicity string optional
m y d -
price integer optional
≥ 0
packagePrice integer optional
≥ 0
packageLength integer optional
≥ 0
packageTarget string optional
≤ 128 characters
chargeType string optional
≤ 128 characters
customer string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
id string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
planDescription string optional
≤ 128 characters
type string optional
standard default unknown mdm custom enterprise
description string optional
≤ 256 characters
paymentIntent object optional
id string optional
≤ 128 characters
secret string optional
≤ 500 characters
status string optional
≤ 500 characters
error object optional
message string optional
≤ 500 characters
code string optional
≤ 500 characters
declineCode string optional
≤ 500 characters
loginProviders object optional
dashboard array [string] optional
store array [string] optional
mdm array [string] optional
limits object optional
apps integer optional
≥ 0
builds integer optional
≥ 0
downloads integer optional
≥ 0
collaborators integer optional
≥ 0
employees integer optional
≥ 0
mdmDevices integer optional
≥ 0
locationTrackingTime integer optional
≥ 0
mdmAssetsStorageSize integer optional
≥ 0
maxBuildRetentionDays integer optional
≥ 0
maxBuildsRetainedPerPublication integer optional
≥ 0
maxPublicationsPerApp integer optional
≥ 0
mdmAutomationRules integer optional
≥ 0
deviceAudiences integer optional
≥ 0
userAudiences integer optional
≥ 0
allows object optional
passwordApps boolean optional
loggedApps boolean optional
unlistedApps boolean optional
loggedStores boolean optional
nativeSDK boolean optional
customBranding boolean optional
customDomain boolean optional
ssoLogin boolean optional
changeS3Bucket boolean optional
customS3Bucket boolean optional
appleIpad boolean optional
appleMac boolean optional
appleWatch boolean optional
appleTv boolean optional
androidZeroTouch boolean optional
appleDEP boolean optional
appleVPP boolean optional
serviceAccounts boolean optional
duplicatePolicy boolean optional
mdmAssets boolean optional
advancedLauncher boolean optional
androidAgent boolean optional
iosAgent boolean optional
macosAgent boolean optional
macosScripts boolean optional
androidManagedConfigurations boolean optional
appleManagedConfigurations boolean optional
androidRemoteSupport boolean optional
appleRemoteSupport boolean optional
inventory boolean optional
windowsMdm boolean optional
windowsAgent boolean optional
windowsScripts boolean optional
countryAccessControl boolean optional
assistant boolean optional
userAudiences boolean optional
unlimitedBuildRetention boolean optional
policyComposition boolean optional
deviceAudiences boolean optional
certificateProviders boolean optional
counts object optional
contactInfo object optional
email string optional
Email
≤ 256 characters · Format: email
phoneNumber string optional
≤ 128 characters
store object optional
customDomain string optional
≤ 256 characters
branding object optional
logo string optional
≤ 256 characters
picture string optional
primaryColor string optional
Match pattern: ^#[a-zA-Z0-9]{6}$
security object optional
role string optional
org.owner org.admin org.editor org.viewer app.owner app.admin app.editor app.viewer unknown
configuration object optional
storageProvider object optional
id string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 128 characters
region string optional
≤ 128 characters
config string optional
≤ 128 characters
provider string optional
≤ 128 characters
notificationLanguage string optional
es en fr de it zh pt ru
required2FADashboard boolean optional
required2FAStore boolean optional
noReplyAlias string optional
Email
≤ 256 characters · Format: email
buildPlatforms array [string] optional
sdkExtraBuildPlatforms array [string] optional
denyTraditionalAccess boolean optional
buildRetentionDays number optional
Format: float · ≥ -1
buildsRetainedPerPublication number optional
Format: float · ≥ 0
showDeviceNetworkLocation boolean optional
blocked boolean optional
blockedReason string optional
≤ 256 characters
trialIniDate string optional
Format: date-time
trialEndDate string optional
Format: date-time
lastPlan string optional
≤ 128 characters
billingReason string optional
noBilling noSubs subscribe
lastActivityDate string optional
Format: date-time
createdBy string optional
Match pattern: ^[a-fA-F0-9]{24}$
updatedAt string optional
Format: date-time
createdAt string optional
Format: date-time
{
    "status": true,
    "data": {
        "id": "string",
        "name": "string",
        "slug": "string",
        "webSiteUrl": "string",
        "type": "personal",
        "subscriptions": [
            {
                "plan": "string",
                "planCode": "string",
                "iniDate": "2024-01-01T00: 00:00Z",
                "endDate": "2024-01-01T00: 00:00Z",
                "endedAt": "2024-01-01T00: 00:00Z",
                "status": "active",
                "metadata": {
                    "limits": {
                        "apps": 0,
                        "builds": 0,
                        "downloads": 0,
                        "collaborators": 0,
                        "employees": 0,
                        "mdmDevices": 0,
                        "locationTrackingTime": 0,
                        "mdmAssetsStorageSize": 0,
                        "maxBuildRetentionDays": 0,
                        "maxBuildsRetainedPerPublication": 0,
                        "maxPublicationsPerApp": 0,
                        "mdmAutomationRules": 0,
                        "deviceAudiences": 0,
                        "userAudiences": 0
                    },
                    "allows": {
                        "passwordApps": true,
                        "loggedApps": true,
                        "unlistedApps": true,
                        "loggedStores": true,
                        "nativeSDK": true,
                        "customBranding": true,
                        "customDomain": true,
                        "ssoLogin": true,
                        "changeS3Bucket": true,
                        "customS3Bucket": true,
                        "appleIpad": true,
                        "appleMac": true,
                        "appleWatch": true,
                        "appleTv": true,
                        "androidZeroTouch": true,
                        "appleDEP": true,
                        "appleVPP": true,
                        "serviceAccounts": true,
                        "duplicatePolicy": true,
                        "mdmAssets": true,
                        "advancedLauncher": true,
                        "androidAgent": true,
                        "iosAgent": true,
                        "macosAgent": true,
                        "macosScripts": true,
                        "androidManagedConfigurations": true,
                        "appleManagedConfigurations": true,
                        "androidRemoteSupport": true,
                        "appleRemoteSupport": true,
                        "inventory": true,
                        "windowsMdm": true,
                        "windowsAgent": true,
                        "windowsScripts": true,
                        "countryAccessControl": true,
                        "assistant": true,
                        "userAudiences": true,
                        "unlimitedBuildRetention": true,
                        "policyComposition": true,
                        "deviceAudiences": true,
                        "certificateProviders": true
                    },
                    "target": "company",
                    "type": "standard",
                    "periodicity": "m",
                    "price": 0,
                    "packagePrice": 0,
                    "packageLength": 0,
                    "packageTarget": "string",
                    "chargeType": "string"
                },
                "customer": "string",
                "id": "string",
                "planDescription": "string",
                "type": "standard",
                "description": "string",
                "paymentIntent": {
                    "id": "string",
                    "secret": "string",
                    "status": "string",
                    "error": {
                        "message": "string",
                        "code": "string",
                        "declineCode": "string"
                    }
                }
            }
        ],
        "loginProviders": {
            "dashboard": [
                "traditional"
            ],
            "store": [
                "traditional"
            ],
            "mdm": [
                "traditional"
            ]
        },
        "limits": {
            "apps": 0,
            "builds": 0,
            "downloads": 0,
            "collaborators": 0,
            "employees": 0,
            "mdmDevices": 0,
            "locationTrackingTime": 0,
            "mdmAssetsStorageSize": 0,
            "maxBuildRetentionDays": 0,
            "maxBuildsRetainedPerPublication": 0,
            "maxPublicationsPerApp": 0,
            "mdmAutomationRules": 0,
            "deviceAudiences": 0,
            "userAudiences": 0
        },
        "allows": {
            "passwordApps": true,
            "loggedApps": true,
            "unlistedApps": true,
            "loggedStores": true,
            "nativeSDK": true,
            "customBranding": true,
            "customDomain": true,
            "ssoLogin": true,
            "changeS3Bucket": true,
            "customS3Bucket": true,
            "appleIpad": true,
            "appleMac": true,
            "appleWatch": true,
            "appleTv": true,
            "androidZeroTouch": true,
            "appleDEP": true,
            "appleVPP": true,
            "serviceAccounts": true,
            "duplicatePolicy": true,
            "mdmAssets": true,
            "advancedLauncher": true,
            "androidAgent": true,
            "iosAgent": true,
            "macosAgent": true,
            "macosScripts": true,
            "androidManagedConfigurations": true,
            "appleManagedConfigurations": true,
            "androidRemoteSupport": true,
            "appleRemoteSupport": true,
            "inventory": true,
            "windowsMdm": true,
            "windowsAgent": true,
            "windowsScripts": true,
            "countryAccessControl": true,
            "assistant": true,
            "userAudiences": true,
            "unlimitedBuildRetention": true,
            "policyComposition": true,
            "deviceAudiences": true,
            "certificateProviders": true
        },
        "counts": {},
        "contactInfo": {
            "email": "user@example.com",
            "phoneNumber": "string"
        },
        "store": {
            "customDomain": "string"
        },
        "branding": {
            "logo": "string",
            "picture": "string",
            "primaryColor": "string"
        },
        "security": {
            "role": "org.owner"
        },
        "configuration": {
            "storageProvider": {
                "id": "string",
                "name": "string",
                "region": "string",
                "config": "string",
                "provider": "string"
            },
            "notificationLanguage": "es",
            "required2FADashboard": true,
            "required2FAStore": true,
            "noReplyAlias": "user@example.com",
            "buildPlatforms": [
                "string"
            ],
            "sdkExtraBuildPlatforms": [
                "string"
            ],
            "denyTraditionalAccess": true,
            "buildRetentionDays": 0,
            "buildsRetainedPerPublication": 0,
            "showDeviceNetworkLocation": true
        },
        "blocked": true,
        "blockedReason": "string",
        "trialIniDate": "2024-01-01T00: 00:00Z",
        "trialEndDate": "2024-01-01T00: 00:00Z",
        "lastPlan": "string",
        "billingReason": "noBilling",
        "lastActivityDate": "2024-01-01T00: 00:00Z",
        "createdBy": "string",
        "updatedAt": "2024-01-01T00: 00:00Z",
        "createdAt": "2024-01-01T00: 00:00Z"
    }
}
400 Response application/json
status boolean optional
false
error object optional
code number optional
5005
message string optional
Can not brand personal organization
{
    "status": false,
    "error": {
        "code": 5001,
        "message": "User already have one personal organization"
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}