Skip to content
campaiDeveloper
campai.com

Connect · Teams

POST/connect/organizations/{organizationId}/teams

Create team

Creates a main team or a one-level subteam in an organization. It takes the team’s name, description, member role, parent team and avatar, and returns the new team’s _id. The parent team cannot be changed after creation.

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 and the team.insert permission.

Request

Path parameters

  • organizationIdidrequired

Body

Content-Type: application/json

  • namestringrequired

    1–80 characters

  • descriptionstringrequired

    at most 256 characters

  • memberRoleidrequired
  • parentTeamidrequirednullable
  • avatarobjectrequirednullable
    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' \
  --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

Content-Type: application/json

  • _idid
Response200
{
  "_id": "000000000000000000000001"
}

What else happens

  • During creation, the member role’s referenceRevision is incremented.
  • For a subteam, the parent team’s membershipRevision is incremented.
  • The new team is inserted.
  • Cached teamsStorage usage is increased by the avatar’s stored bytes.
  • If the storage limit is exceeded, the new avatar resource is removed.

Errors

Other errors

StatusErrorWhen
400Choose a main team from this organization. Subteams cannot contain further subteams.If the supplied parent is not a main team in the organization, the request fails with HTTP 400 and routes.connect.teams.invalidParent.
400The member role does not belong to this organizationIf the member role does not belong to the organization, the request fails with HTTP 400 and connect.team.invalidMemberRole.

Errors nearly every request can meet are listed under Errors.