Skip to content
campaiDeveloper
campai.com

Organizations

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

Update public profile

Publishes or updates an organization's Community-App profile using its ID, introduction, about text and sites, with optional email, phone and cover. Omitted email, phone and cover retain their current values; site addresses are used to determine locations. The endpoint returns no response body.

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.
  • Child organizations cannot have their own Community-App profile.

Request

Path parameters

  • organizationIdidrequired

Body

Content-Type: application/json

  • introductionstringrequired

    1–140 characters

  • aboutstringrequired

    1–4000 characters

  • emailstring
  • phonestring | string · phone
  • coverobjectnullable
    2 properties
    • fileNamestring

      at most 128 characters

    • resourcestringrequired
  • sitesobject[]required

    1–64 items

    4 properties
    • namestringrequired

      1–24 characters

    • descriptionstringrequired

      at most 280 characters

    • addressobjectrequired
      7 properties
      • countrystringrequired
      • statestring
      • zipstringrequired

        at most 10 characters

      • citystringrequired

        at most 45 characters

      • addressLinestringrequired

        at most 45 characters

      • details1string

        at most 45 characters

      • details2string

        at most 45 characters

    • openingobjectrequirednullable
      2 properties
      • hoursobjectrequired
        2 properties
        • fromobjectrequired
          2 properties
          • hoursintegerrequired

            0–23

          • minutesintegerrequired

            0–59

        • toobjectrequired
          2 properties
          • hoursintegerrequired

            0–23

          • minutesintegerrequired

            0–59

      • daysstring[]required

        1–7 items

        mon tue wed thu fri sat sun
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' \
  --header 'X-API-Key: YOUR_API_KEY'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

No response body is specified.

What else happens

  • The organization's publicProfile is updated.
  • The organization is marked as having a public Connect profile.
  • The organization's checks.connectSetup is set to true.
  • When publishing a new profile, the endpoint clears the organization's Connect user organizations cache.
  • When cover is provided, the endpoint updates its storage resources and runs resource cleanup after saving.

Errors

Other errors

StatusErrorWhen
403No fixed messageIf the organization is a child organization, the endpoint returns HTTP 403 (FORBIDDEN).
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.