Update a mail contact

PUT /api/2.0/mail/contact/update

Request

Updates a mail contact with the ID specified in the request.

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

idinteger

Mail contact ID

namestring

New contact name

descriptionstring

New contact description

emailsarray of string

New list of contact emails

phoneNumbersarray of string

New list of contact phone numbers

Examples

PUT /api/2.0/mail/contact/update HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request PUT \
  --url https://example.com/api/2.0/mail/contact/update \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Information about updated contact

ContactIdintegerformat: int32
Namestring
Descriptionstring
Emailsarray of object
Idintegerformat: int32
Valuestring
IsPrimaryboolean
PhoneNumbersarray of object
Idintegerformat: int32
Valuestring
IsPrimaryboolean
Typeintegerformat: int32
SmallFotoUrlstring
MediumFotoUrlstring

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).