Skip to main content
POST
/
api
/
client
/
v2
/
campaign
/
{campaignId}
/
share
Share Campaign
curl --request POST \
  --url https://prod-nginx-v2.goextrovert.com/webgateway/api/client/v2/campaign/{campaignId}/share \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "usersIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "shareWithAllWorkspaceUsers": true
}
'
{
  "status": "success",
  "data": null,
  "message": "Operation completed successfully"
}

Authorizations

​
X-API-Key
string
header
required

API Key for authentication

Path Parameters

​
campaignId
string
required

Body

application/json
​
campaignId
string<uuid>
required

Campaign id whose sharing settings should be updated.

​
usersIds
string<uuid>[]
required

Team member ids that should have access to the campaign. Pass an empty array when shareWithAllWorkspaceUsers=true.

​
shareWithAllWorkspaceUsers
boolean

Whether to share the campaign with all members of the team.

Response

​
status
enum<string>
required

Response status

Available options:
success
​
data
any | null
required

No response payload

Available options:
null
Example:

null

​
message
string
required

Success message

Example:

"Operation completed successfully"