Skip to content
campaiDeveloper
campai.com

Connect ยท Teams

POST/connect/organizations/{organizationId}/teams/{teamId}/chat-style

Update team chat appearance

Updates a team's chat appearance using organizationId, teamId, and style. Null settings inherit the organization's Community-App appearance. The endpoint returns no content.

Permissions

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

Who may call it

  • Requires organization access and the team.edit permission.

Request

Path parameters

  • organizationIdidrequired
  • teamIdidrequired

Body

Content-Type: application/json

  • styleobjectrequired
    2 properties
    • lightobjectrequirednullable
      4 properties
      • backgroundobjectrequired
      • incomingobjectrequired
        2 properties
        • backgroundColorstringrequired

          pattern ^#[0-9a-fA-F]{6}$

        • textColorstringrequired

          pattern ^#[0-9a-fA-F]{6}$

      • outgoingobjectrequired
        2 properties
        • backgroundColorstringrequired

          pattern ^#[0-9a-fA-F]{6}$

        • textColorstringrequired

          pattern ^#[0-9a-fA-F]{6}$

      • accentobjectrequired
        3 properties
        • backgroundColorstringrequired

          pattern ^#[0-9a-fA-F]{6}$

        • textColorstringrequired

          pattern ^#[0-9a-fA-F]{6}$

        • foregroundColorstringrequired

          pattern ^#[0-9a-fA-F]{6}$

    • darkobjectrequirednullable
      4 properties
      • backgroundobjectrequired
      • incomingobjectrequired
        2 properties
        • backgroundColorstringrequired

          pattern ^#[0-9a-fA-F]{6}$

        • textColorstringrequired

          pattern ^#[0-9a-fA-F]{6}$

      • outgoingobjectrequired
        2 properties
        • backgroundColorstringrequired

          pattern ^#[0-9a-fA-F]{6}$

        • textColorstringrequired

          pattern ^#[0-9a-fA-F]{6}$

      • accentobjectrequired
        3 properties
        • backgroundColorstringrequired

          pattern ^#[0-9a-fA-F]{6}$

        • textColorstringrequired

          pattern ^#[0-9a-fA-F]{6}$

        • foregroundColorstringrequired

          pattern ^#[0-9a-fA-F]{6}$

Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/teams/YOUR_TEAM_ID/chat-style' \
  --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

  • Increments the team's membershipRevision.
  • If the team chat conversation exists, updates its style and increments its revision.
  • If no team chat conversation exists, creates one with the supplied style.
  • Records a user watch counter change for the team's content.

Errors

Other errors

StatusErrorWhen
404The team was not foundReturns 404 when the team is not found in the organization.
404No fixed messageReturns 404 if the team's chat conversation is being deleted. No message key is specified.

Errors nearly every request can meet are listed under Errors.