CreateOrganization

POST 
/orgs

CreateOrganization

Request

Query Parameters

presentation PresentationModes

Possible values: [compact, full]

Header Parameters

X-LP-Client-Identifier stringrequired
ClientIdentifier
Example: 7f892282-1c4b-4701-bdb8-cd997ccb5208
X-LP-Client-Type stringrequired
Possible values: [Unknown, App, WebApp, Service]
ClientType
Example: App
X-LP-Client-Name string
ClientName
Example: Swagger
X-LP-Client-OS-Name string
ClientOSName
Example: SwaggerDoc
X-LP-Client-OS-Version string
ClientOSVersion
Example: 1.0
X-LP-Client-Screen-Resolution string
ClientScreenResolution
Example: 1280x0900
X-LP-Client-Model string
ClientModel
Example: Chrome 75
X-LP-Organization-Alias string

OrganizationAlias

X-LP-Client-Extensions csv

ClientExtensions

Accept-Language stringrequired
Language
Example: en-US

application/json-patch+json

Body

name stringrequired

Possible values: >= 2 characters and <= 24 characters

name

alias stringrequired

Possible values: >= 2 characters and <= 24 characters, Value must match regular expression ^[a-zA-Z0-9_-]{2,24}$

alias

owner

object

guid uuid

guid

type_of string

type_of

support

object

line stringrequired

Possible values: >= 2 characters and <= 24 characters

line

responsibility stringrequired

Possible values: >= 2 characters and <= 128 characters

responsibility

phone stringnullable

Possible values: >= 10 characters and <= 18 characters, Value must match regular expression ((8|\+7)-?)?\(?\d{3,5}\)?-?\d{1}-?\d{1}-?\d{1}-?\d{1}-?\d{1}((-?\d{1})?-?\d{1})?

phone

email stringnullable

Possible values: >= 6 characters and <= 64 characters, Value must match regular expression ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

email

opening_hours stringnullable

Possible values: >= 2 characters and <= 128 characters

opening_hours

whatsapp stringnullable

Possible values: >= 2 characters and <= 64 characters

whatsapp

viber stringnullable

Possible values: >= 2 characters and <= 64 characters

viber

telegram stringnullable

Possible values: >= 2 characters and <= 64 characters

telegram

type_of string

type_of

extensions

OrganizationExtensions

Расширения

notification_service

object

turned_on booleanrequired

turned_on

primary_url_for_notifications urirequired

Possible values: non-empty

primary_url_for_notifications

secondary_url_for_notifications urinullable

secondary_url_for_notifications

version stringrequired

Possible values: non-empty and <= 8 characters

version

lifepay_auth

object

signature stringrequired

Possible values: >= 8 characters and <= 128 characters

signature

version stringrequired

Possible values: non-empty and <= 8 characters

version

unified_personal_account

object

turned_on boolean

turned_on

version stringrequired

Possible values: non-empty and <= 8 characters

version

created_at date-time

created_at

updated_at date-time

updated_at

deleted_at date-timenullable

deleted_at

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string
guid uuid

guid

type_of string

type_of

application/json

Body

name stringrequired

Possible values: >= 2 characters and <= 24 characters

name

alias stringrequired

Possible values: >= 2 characters and <= 24 characters, Value must match regular expression ^[a-zA-Z0-9_-]{2,24}$

alias

owner

object

guid uuid

guid

type_of string

type_of

support

object

line stringrequired

Possible values: >= 2 characters and <= 24 characters

line

responsibility stringrequired

Possible values: >= 2 characters and <= 128 characters

responsibility

phone stringnullable

Possible values: >= 10 characters and <= 18 characters, Value must match regular expression ((8|\+7)-?)?\(?\d{3,5}\)?-?\d{1}-?\d{1}-?\d{1}-?\d{1}-?\d{1}((-?\d{1})?-?\d{1})?

phone

email stringnullable

Possible values: >= 6 characters and <= 64 characters, Value must match regular expression ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

email

opening_hours stringnullable

Possible values: >= 2 characters and <= 128 characters

opening_hours

whatsapp stringnullable

Possible values: >= 2 characters and <= 64 characters

whatsapp

viber stringnullable

Possible values: >= 2 characters and <= 64 characters

viber

telegram stringnullable

Possible values: >= 2 characters and <= 64 characters

telegram

type_of string

type_of

extensions

OrganizationExtensions

Расширения

notification_service

object

turned_on booleanrequired

turned_on

primary_url_for_notifications urirequired

Possible values: non-empty

primary_url_for_notifications

secondary_url_for_notifications urinullable

secondary_url_for_notifications

version stringrequired

Possible values: non-empty and <= 8 characters

version

lifepay_auth

object

signature stringrequired

Possible values: >= 8 characters and <= 128 characters

signature

version stringrequired

Possible values: non-empty and <= 8 characters

version

unified_personal_account

object

turned_on boolean

turned_on

version stringrequired

Possible values: non-empty and <= 8 characters

version

created_at date-time

created_at

updated_at date-time

updated_at

deleted_at date-timenullable

deleted_at

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string
guid uuid

guid

type_of string

type_of

text/json

Body

name stringrequired

Possible values: >= 2 characters and <= 24 characters

name

alias stringrequired

Possible values: >= 2 characters and <= 24 characters, Value must match regular expression ^[a-zA-Z0-9_-]{2,24}$

alias

owner

object

guid uuid

guid

type_of string

type_of

support

object

line stringrequired

Possible values: >= 2 characters and <= 24 characters

line

responsibility stringrequired

Possible values: >= 2 characters and <= 128 characters

responsibility

phone stringnullable

Possible values: >= 10 characters and <= 18 characters, Value must match regular expression ((8|\+7)-?)?\(?\d{3,5}\)?-?\d{1}-?\d{1}-?\d{1}-?\d{1}-?\d{1}((-?\d{1})?-?\d{1})?

phone

email stringnullable

Possible values: >= 6 characters and <= 64 characters, Value must match regular expression ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

email

opening_hours stringnullable

Possible values: >= 2 characters and <= 128 characters

opening_hours

whatsapp stringnullable

Possible values: >= 2 characters and <= 64 characters

whatsapp

viber stringnullable

Possible values: >= 2 characters and <= 64 characters

viber

telegram stringnullable

Possible values: >= 2 characters and <= 64 characters

telegram

type_of string

type_of

extensions

OrganizationExtensions

Расширения

notification_service

object

turned_on booleanrequired

turned_on

primary_url_for_notifications urirequired

Possible values: non-empty

primary_url_for_notifications

secondary_url_for_notifications urinullable

secondary_url_for_notifications

version stringrequired

Possible values: non-empty and <= 8 characters

version

lifepay_auth

object

signature stringrequired

Possible values: >= 8 characters and <= 128 characters

signature

version stringrequired

Possible values: non-empty and <= 8 characters

version

unified_personal_account

object

turned_on boolean

turned_on

version stringrequired

Possible values: non-empty and <= 8 characters

version

created_at date-time

created_at

updated_at date-time

updated_at

deleted_at date-timenullable

deleted_at

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string
guid uuid

guid

type_of string

type_of

application/*+json

Body

name stringrequired

Possible values: >= 2 characters and <= 24 characters

name

alias stringrequired

Possible values: >= 2 characters and <= 24 characters, Value must match regular expression ^[a-zA-Z0-9_-]{2,24}$

alias

owner

object

guid uuid

guid

type_of string

type_of

support

object

line stringrequired

Possible values: >= 2 characters and <= 24 characters

line

responsibility stringrequired

Possible values: >= 2 characters and <= 128 characters

responsibility

phone stringnullable

Possible values: >= 10 characters and <= 18 characters, Value must match regular expression ((8|\+7)-?)?\(?\d{3,5}\)?-?\d{1}-?\d{1}-?\d{1}-?\d{1}-?\d{1}((-?\d{1})?-?\d{1})?

phone

email stringnullable

Possible values: >= 6 characters and <= 64 characters, Value must match regular expression ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

email

opening_hours stringnullable

Possible values: >= 2 characters and <= 128 characters

opening_hours

whatsapp stringnullable

Possible values: >= 2 characters and <= 64 characters

whatsapp

viber stringnullable

Possible values: >= 2 characters and <= 64 characters

viber

telegram stringnullable

Possible values: >= 2 characters and <= 64 characters

telegram

type_of string

type_of

extensions

OrganizationExtensions

Расширения

notification_service

object

turned_on booleanrequired

turned_on

primary_url_for_notifications urirequired

Possible values: non-empty

primary_url_for_notifications

secondary_url_for_notifications urinullable

secondary_url_for_notifications

version stringrequired

Possible values: non-empty and <= 8 characters

version

lifepay_auth

object

signature stringrequired

Possible values: >= 8 characters and <= 128 characters

signature

version stringrequired

Possible values: non-empty and <= 8 characters

version

unified_personal_account

object

turned_on boolean

turned_on

version stringrequired

Possible values: non-empty and <= 8 characters

version

created_at date-time

created_at

updated_at date-time

updated_at

deleted_at date-timenullable

deleted_at

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string
guid uuid

guid

type_of string

type_of

Responses

201

Created

application/json

Schema

Schema

name stringrequired

Possible values: >= 2 characters and <= 24 characters

name

alias stringrequired

Possible values: >= 2 characters and <= 24 characters, Value must match regular expression ^[a-zA-Z0-9_-]{2,24}$

alias

owner

object

guid uuid

guid

type_of string

type_of

support

object

line stringrequired

Possible values: >= 2 characters and <= 24 characters

line

responsibility stringrequired

Possible values: >= 2 characters and <= 128 characters

responsibility

phone stringnullable

Possible values: >= 10 characters and <= 18 characters, Value must match regular expression ((8|\+7)-?)?\(?\d{3,5}\)?-?\d{1}-?\d{1}-?\d{1}-?\d{1}-?\d{1}((-?\d{1})?-?\d{1})?

phone

email stringnullable

Possible values: >= 6 characters and <= 64 characters, Value must match regular expression ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

email

opening_hours stringnullable

Possible values: >= 2 characters and <= 128 characters

opening_hours

whatsapp stringnullable

Possible values: >= 2 characters and <= 64 characters

whatsapp

viber stringnullable

Possible values: >= 2 characters and <= 64 characters

viber

telegram stringnullable

Possible values: >= 2 characters and <= 64 characters

telegram

type_of string

type_of

extensions

OrganizationExtensions

Расширения

notification_service

object

turned_on booleanrequired

turned_on

primary_url_for_notifications urirequired

Possible values: non-empty

primary_url_for_notifications

secondary_url_for_notifications urinullable

secondary_url_for_notifications

version stringrequired

Possible values: non-empty and <= 8 characters

version

lifepay_auth

object

signature stringrequired

Possible values: >= 8 characters and <= 128 characters

signature

version stringrequired

Possible values: non-empty and <= 8 characters

version

unified_personal_account

object

turned_on boolean

turned_on

version stringrequired

Possible values: non-empty and <= 8 characters

version

created_at date-time

created_at

updated_at date-time

updated_at

deleted_at date-timenullable

deleted_at

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string
guid uuid

guid

type_of string

type_of

Example (from schema)

{
  "name": "string",
  "alias": "string",
  "owner": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type_of": "string"
  },
  "support": {
    "line": "string",
    "responsibility": "string",
    "phone": "string",
    "email": "string",
    "opening_hours": "string",
    "whatsapp": "string",
    "viber": "string",
    "telegram": "string",
    "type_of": "string"
  },
  "extensions": {
    "notification_service": {
      "turned_on": true,
      "primary_url_for_notifications": "string",
      "secondary_url_for_notifications": "string",
      "version": "string"
    },
    "lifepay_auth": {
      "signature": "string",
      "version": "string"
    },
    "unified_personal_account": {
      "turned_on": true,
      "version": "string"
    }
  },
  "created_at": "2024-11-18T08:30:46.530Z",
  "updated_at": "2024-11-18T08:30:46.530Z",
  "deleted_at": "2024-11-18T08:30:46.530Z",
  "meta": "string",
  "meta_data": {},
  "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type_of": "string"
}

Example

{
  "name": "my_name",
  "alias": "my_organization",
  "created_at": "0001-01-01T00:00:00Z",
  "updated_at": "0001-01-01T00:00:00Z",
  "guid": "ad8e8a45-018c-42a3-9fa5-b741e6b19737",
  "type_of": "Organization"
}

401

Unauthorized

application/json

Schema

Schema

code ErrorCodes (string)

Possible values: [InternalServerError, TooManyRequests, RequestIsNotValid, BadRequest, NoPermissions, Unauthorized, NotFound, ReferenceNotFound, Duplicate, NotUnique, NotNullOrUnique, NotAllowed, NotAllowedForArchived, TryLater, OperationCannotBePerformed, NotificationsAreOutOfService, TrySendCodeLater, UsernameIsAlreadyTaken, PhoneIsNotFound, PhoneIsNotFoundInOrganization, PhoneIsAlreadyTaken, InvalidConfirmationCode, ConfirmationCodeWasCanceled, ConfirmationCodeWasNotSend, UsernameDoesNotExist, WrongUsernameOrPassword, WrongActivationCode, TryActivateLater, AliasIsNotFound, AliasIsAlreadyTaken, NotAllowedForOwner, DealPositionHasInvalidQuantity, CheckMarkingCodeMustBeDisabled, LegalEntityCrptTokenNotSpecified]

message stringnullable

message

info stringnullable

info

Example (from schema)

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

403

Forbidden

application/json

Schema

Schema

code ErrorCodes (string)

Possible values: [InternalServerError, TooManyRequests, RequestIsNotValid, BadRequest, NoPermissions, Unauthorized, NotFound, ReferenceNotFound, Duplicate, NotUnique, NotNullOrUnique, NotAllowed, NotAllowedForArchived, TryLater, OperationCannotBePerformed, NotificationsAreOutOfService, TrySendCodeLater, UsernameIsAlreadyTaken, PhoneIsNotFound, PhoneIsNotFoundInOrganization, PhoneIsAlreadyTaken, InvalidConfirmationCode, ConfirmationCodeWasCanceled, ConfirmationCodeWasNotSend, UsernameDoesNotExist, WrongUsernameOrPassword, WrongActivationCode, TryActivateLater, AliasIsNotFound, AliasIsAlreadyTaken, NotAllowedForOwner, DealPositionHasInvalidQuantity, CheckMarkingCodeMustBeDisabled, LegalEntityCrptTokenNotSpecified]

message stringnullable

message

info stringnullable

info

Example (from schema)

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

422

Client Error

application/json

Schema

Schema

code ErrorCodes (string)

Possible values: [InternalServerError, TooManyRequests, RequestIsNotValid, BadRequest, NoPermissions, Unauthorized, NotFound, ReferenceNotFound, Duplicate, NotUnique, NotNullOrUnique, NotAllowed, NotAllowedForArchived, TryLater, OperationCannotBePerformed, NotificationsAreOutOfService, TrySendCodeLater, UsernameIsAlreadyTaken, PhoneIsNotFound, PhoneIsNotFoundInOrganization, PhoneIsAlreadyTaken, InvalidConfirmationCode, ConfirmationCodeWasCanceled, ConfirmationCodeWasNotSend, UsernameDoesNotExist, WrongUsernameOrPassword, WrongActivationCode, TryActivateLater, AliasIsNotFound, AliasIsAlreadyTaken, NotAllowedForOwner, DealPositionHasInvalidQuantity, CheckMarkingCodeMustBeDisabled, LegalEntityCrptTokenNotSpecified]

message stringnullable

message

info stringnullable

info

Example (from schema)

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

429

Too Many Requests

application/json

Schema

Schema

code ErrorCodes (string)

Possible values: [InternalServerError, TooManyRequests, RequestIsNotValid, BadRequest, NoPermissions, Unauthorized, NotFound, ReferenceNotFound, Duplicate, NotUnique, NotNullOrUnique, NotAllowed, NotAllowedForArchived, TryLater, OperationCannotBePerformed, NotificationsAreOutOfService, TrySendCodeLater, UsernameIsAlreadyTaken, PhoneIsNotFound, PhoneIsNotFoundInOrganization, PhoneIsAlreadyTaken, InvalidConfirmationCode, ConfirmationCodeWasCanceled, ConfirmationCodeWasNotSend, UsernameDoesNotExist, WrongUsernameOrPassword, WrongActivationCode, TryActivateLater, AliasIsNotFound, AliasIsAlreadyTaken, NotAllowedForOwner, DealPositionHasInvalidQuantity, CheckMarkingCodeMustBeDisabled, LegalEntityCrptTokenNotSpecified]

message stringnullable

message

info stringnullable

info

Example (from schema)

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

500

Server Error

application/json

Schema

Schema

code ErrorCodes (string)

Possible values: [InternalServerError, TooManyRequests, RequestIsNotValid, BadRequest, NoPermissions, Unauthorized, NotFound, ReferenceNotFound, Duplicate, NotUnique, NotNullOrUnique, NotAllowed, NotAllowedForArchived, TryLater, OperationCannotBePerformed, NotificationsAreOutOfService, TrySendCodeLater, UsernameIsAlreadyTaken, PhoneIsNotFound, PhoneIsNotFoundInOrganization, PhoneIsAlreadyTaken, InvalidConfirmationCode, ConfirmationCodeWasCanceled, ConfirmationCodeWasNotSend, UsernameDoesNotExist, WrongUsernameOrPassword, WrongActivationCode, TryActivateLater, AliasIsNotFound, AliasIsAlreadyTaken, NotAllowedForOwner, DealPositionHasInvalidQuantity, CheckMarkingCodeMustBeDisabled, LegalEntityCrptTokenNotSpecified]

message stringnullable

message

info stringnullable

info

Example (from schema)

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Loading...