Skip to main content
POST
Share Campaign

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"