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

Replace the complete list of explicit teammate user-ID grants. [] removes explicit grants; also send shareWithAllWorkspaceUsers=false to remove whole-team sharing. This does not revoke managed-account administration or workspace API access. Non-owner callers cannot share a managed-account campaign.

shareWithAllWorkspaceUsers
boolean

Whole-team access flag, independent of explicit usersIds grants. Omit to retain the stored flag; false is required to revoke whole-team access.

Response

status
string
required

Response status

Allowed value: "success"
data
null
required

No response payload

message
string
required

Success message

Example:

"Operation completed successfully"