Add

[POST] .../v1/personaldoctype/add

Creates a new type personal document. Use this method to create a personal document type before attaching documents of that type to retail customers. The request requires name, accepts optional mask as a.NET regular expression used later to validate CustomerPersonalDocument value and returns new_id for the created type. The method checks the current request user and requires personal document type add permission; missing body, missing name, invalid regex mask, permission failures and storage errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
mask String Optional Personal document type mask.
name String Required Personal document type name.

Request Example

{
  "mask": "string",
  "name": "string"
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Insert Created record result.

Response Example

{
  "ok": true,
  "result": {
    "new_id": 1
  }
}