Skip to content
campai
Book a consultationTry for free
POST/{organizationId}/portal/settings/synchronization/preview

Estimate update sync impact

Returns an estimate of the impact of the new portal synchronization settings

Required permissions:

  • portalSettings.edit

Path Parameters

organizationIdstringrequired

Request Body required

Content-Type: application/json

synchEnabledbooleanrequired

Authentication: X-API-Key

Request

POST/{organizationId}/portal/settings/synchronization/preview
curl --request POST 'https://cloud.campai.com/api/{organizationId}/portal/settings/synchronization/preview' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "contactSegments": [
    "string"
  ],
  "synchEnabled": true
}'

Responses

This endpoint returns different response codes based on the request outcome.

200Successful response

Content-Type: application/json

contactsAddedintegerrequired

minimum: 0

maximum: 9007199254740991

contactsRemovedintegerrequired

minimum: 0

maximum: 9007199254740991

Response

200
{
  "contactsAdded": 0,
  "contactsRemoved": 0
}

400Invalid input data

Content-Type: application/json

The error information

messagestringrequired

The error message

codestringrequired

The error code

An array of issues that were responsible for the error

Response

400
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

401Authorization not provided

Content-Type: application/json

The error information

messagestringrequired

The error message

codestringrequired

The error code

An array of issues that were responsible for the error

Response

401
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

403Insufficient access

Content-Type: application/json

The error information

messagestringrequired

The error message

codestringrequired

The error code

An array of issues that were responsible for the error

Response

403
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

500Internal server error

Content-Type: application/json

The error information

messagestringrequired

The error message

codestringrequired

The error code

An array of issues that were responsible for the error

Response

500
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}