Product DocumentationConga Community
API Reference

Share a record

post
https://rls.congacloud.com/api/data/v1/objects///share

This bulk request API shares a record with users and user groups based on the provided object name and record ID and sends an email notification to the user or user group.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The name of the business object the record belongs to. For example, Agreement.

string
required

The unique ID of the record to be shared. For example, 6a2f9e0d-aef6-432f-998b-66cbc673c793.

Body Params

Record sharing details.

RecordShareInfo
array of objects | null
RecordShareInfo
boolean

Should we send an email to the user/usergroup the record is shared with.

string | null

Email message body to be sent to the user/usergroup when the record is shared.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

400

Bad Request

403

Forbidden

Updated 25 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 25 days ago