Create persons

POST /api/2.0/crm/contact/person/quick

Request

Creates a list of persons with the first and last names specified in the request.

Note: Data has the following format: [{key: 'First name 1', value: 'Last name 1'}, {key: 'First name 2', value: 'Last name 2'}].

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

dataarray of object

Pairs: user first name, user last name

Examples

POST /api/2.0/crm/contact/person/quick HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request POST \
  --url https://example.com/api/2.0/crm/contact/person/quick \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

List of contacts

SmallFotoUrlstring
MediumFotoUrlstring
DisplayNamestring
IsCompanyboolean
AccessListarray of object
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
IsPrivateboolean
IsSharedboolean
ShareTypeenum of integerformat: int32

[0 - None, 1 - ReadWrite, 2 - Read]

Can be one of: None, ReadWrite, Read.

Currencyobject
Titlestring
Symbolstring
Abbreviationstring
CultureNamestring
IsConvertableboolean
IsBasicboolean
CanEditboolean
CanDeleteboolean
IDintegerformat: int32

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE Workspace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).