Skip to navigation
Sigma REST APISource swap policies

Create a source swap policy

View as Markdown

Create a source swap policy.

Beta: Creating a Connection source swap policy is in private beta and must be enabled for your organization. This documentation is subject to the Beta features disclaimer.

Usage notes

  • Retrieve the connectionId to use as the fromConnectionId by calling the /v2/connections endpoint.
  • Retrieve the userAttributeId to use in the swaps object by calling the /v2/user-attributes endpoint.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

The request body.
Connection swapobjectRequired
OR
Deployment swapobjectRequired

Response

Source Swap Policy Response
policyIdstring
Unique identifier of the source swap policy.