Skip to content
campaiDeveloper
campai.com

Organizations

POST/connect/organizations/{organizationId}/public-profile/remove

Remove public profile

Removes an organization's Community-App public profile, including its cover and locations, so the organization is no longer discoverable. It takes an organizationId and returns no content.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Who may call it

  • The caller must have organization access.
  • The caller needs the organization.edit permission.

Request

Path parameters

  • organizationIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/public-profile/remove' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

No response body is specified.

What else happens

  • Sets the organization's publicProfile to null.
  • Sets the organization's hasPublicConnectProfile to false.
  • If the organization previously had a public Connect profile, clears its Connect user organizations cache.
  • Cleans up storage resources after the update.

Errors

Other errors

StatusErrorWhen
404No fixed messageIf the organization is not found, the endpoint returns HTTP 404 (NOT_FOUND).

Errors nearly every request can meet are listed under Errors.