Share an Opportunity

Lets you share an opportunity with a sales user for a specific duration. You can also configure the type of opportunity access (read, edit) you want to give the user.

Note:

  • Entity Sharing must be enabled for your account for this API to work. Contact support@leadsquared.com to get it enabled.
  • Before you call this API, from the Advanced Configuration page, you must Enable Opportunity Sharing.
  • To share an opportunity, you must first create an opportunity, where the opportunity owner is different from the sales user you want to share the opportunity with.
  • All parameters, except DurationInMinutes, are mandatory. If you don’t pass DurationInMinutes, the default value will be 90 days. You can contact support@leadsquared.com to change the default value. 

API URL

POST
https://{host}/v2/EntityAccess.svc/Share?accessKey=AccessKey&secretKey=SecretKey
Copy URL

Request

JSON Body/Payload

Content-Type: application/json

[
   {
      "UserId":"96105aa0-61f2-11ea-8109-022edb41208c",
      "Entity":5,
      "EntityType":3,
      "EntityId":"f85f3b60-bec7-47c8-8fcd-ae5d9df2d0e5",
      "AccessType":2,
      "DurationInMinutes":30
   }
]

JSON Properties

Parameter Description
UserId

Id of the sales user with whom you want to share the opportunity.

You can use the Get Users API to retrieve user Ids.

Entity

Currently the only entity you can share is 5 = opportunity. Pass 5 here.

EntityType

This is the entity the opportunity is being shared with. Currently, you can only share an opportunity with 3 = user. Pass 3 here.

EntityId

Pass the OpportunityId here. You can get it using the Get Opportunities by Lead Id API.

AccessType

Defines if you want to give the user read or write access to the opportunity.

  • Pass 1 for read-only access
  • Pass 2 for read and write access
DurationInMinutes

The duration (in minutes) you want to grant the user access to the lead for. This field is optional.

Response

200 OK

Content-Type: application/json

{
   "Status":"Success",
   "Message":{
      "Id":"a26bd0fa283a4b44a287a1a23082d529"
   }
}

HTTP Response Code

Code Description
200 OK

This is the status code for successful API call.

401 Unauthorized

The API call was made with invalid access credentials. Check your AccessKey and SecretKey.

400 Bad Request

The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.

404 Not Found

The API could not be found. Please check the API signature.

429 Too Many Requests

API calls exceeded the limit of 25 in 5 second(s)

500 Internal Server Error

The API called failed. There could be many reasons for it. Check the exception message to get more details.