Navigation Menu

Set opportunity access rights

PUT /api/2.0/crm/opportunity/{opportunityid:[0-9]+}/access

Request

Sets access rights to the selected opportunity with the parameters 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

opportunityidinteger

Opportunity ID

isPrivateboolean

Opportunity privacy: private or not

accessListarray of string

List of users with access rights

Examples

PUT /api/2.0/crm/opportunity/%7Bopportunityid:[0-9]+%7D/access HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request PUT \
  --url 'https://example.com/api/2.0/crm/opportunity/%7Bopportunityid:[0-9]+%7D/access' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Opportunity

CreateByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
Createdstring
Membersarray of object
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
Contactobject
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
Titlestring
Descriptionstring
Responsibleobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
BidTypeenum of integerformat: int32

[0 - FixedBid, 1 - PerHour, 2 - PerDay, 3 - PerWeek, 4 - PerMonth, 5 - PerYear]

Can be one of: FixedBid, PerHour, PerDay, PerWeek, PerMonth, PerYear.

BidValuenumberformat: double
BidCurrencyobject
Titlestring
Symbolstring
Abbreviationstring
CultureNamestring
IsConvertableboolean
IsBasicboolean
PerPeriodValueintegerformat: int32
Stageobject
SuccessProbabilityintegerformat: int32
StageTypeenum of integerformat: int32

[0 - Open, 1 - ClosedAndWon, 2 - ClosedAndLost]

Can be one of: Open, ClosedAndWon, ClosedAndLost.

Titlestring
Descriptionstring
Colorstring
SortOrderintegerformat: int32
IDintegerformat: int32
SuccessProbabilityintegerformat: int32
ActualCloseDatestring
ExpectedCloseDatestring
IsPrivateboolean
AccessListarray of object
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
CanEditboolean
CustomFieldsarray of object
EntityIdintegerformat: int32
Labelstring
FieldValuestring
FieldTypeenum of integerformat: int32

[0 - TextField, 1 - TextArea, 2 - SelectBox, 3 - CheckBox, 4 - Heading, 5 - Date]

Can be one of: TextField, TextArea, SelectBox, CheckBox, Heading, Date.

Positionintegerformat: int32
Maskstring
IDintegerformat: int32
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).