Skip to content
campaiDeveloper
campai.com

Connect · Teams

POST/connect/organizations/{organizationId}/teams/{teamId}

Update team

Updates a team's name, description and avatar for an organization. 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

  • The caller must have access to the organization.
  • The caller must have the team.edit permission.

Request

Path parameters

  • organizationIdidrequired
  • teamIdidrequired

Body

Content-Type: application/json

  • namestringrequired

    1–80 characters

  • descriptionstringrequired

    at most 256 characters

  • avatarobjectnullable
    2 properties
    • fileNamestring

      at most 128 characters

    • resourcestringrequired
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' \
  --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

  • Updates the team's supplied data and, if changed, its avatar.
  • Updates the team context name on matching todo items in the organization.
  • Records the avatar storage change for a cached teamsStorage usage adjustment after the transaction.
  • If an avatar resource update was made, its resources are cleaned up after the transaction.
  • If the storage limit is exceeded, the new avatar resource is removed if it differs from the existing one.

Errors

Other errors

StatusErrorWhen
404The team was not foundIf the team is not found in the organization, the endpoint returns HTTP 404 with key routes.connect.teams.notFound.
404The team was not foundIf the team is no longer found when the update is applied, the endpoint returns HTTP 404 with key routes.connect.teams.notFound.

Errors nearly every request can meet are listed under Errors.