Skip to content
campaiDeveloper
campai.com

Connect · Team roles

POST/connect/organizations/{organizationId}/team-roles

Create team role

Creates a team role for an organization using organizationId, name, description, and permissions. Returns the new role’s _id.

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

Request

Path parameters

  • organizationIdidrequired

Body

Content-Type: application/json

  • namestringrequired

    1–32 characters

  • descriptionstringrequired

    at most 256 characters

  • permissionsobjectrequired
    5 properties
    • contactobject
      10 properties
      • readobject of boolean
        Keys: one of 7 values
        member address customer sponsor contributor employee supplier
      • communicationboolean
      • personalboolean
      • departmentsboolean
      • groupsboolean
      • billingboolean
      • contractsboolean
      • notesboolean
      • proofsCertificatesboolean
      • tagsboolean
    • userobject of boolean
      Keys: one of 3 values
      list read chat
    • chatobject
      22 properties
      • createActivityboolean
      • createPollboolean
      • createAvailabilityboolean
      • createSignupboolean
      • createChecklistboolean
      • createFormboolean
      • createChallengeboolean
      • participatePollboolean
      • participateAvailabilityboolean
      • participateSignupboolean
      • participateChecklistboolean
      • participateFormboolean
      • participateChallengeboolean
      • manageActivitiesboolean
      • replyboolean
      • reactboolean
      • mentionboolean
      • mentionEveryoneboolean
      • manageboolean
      • changeAppearanceboolean
      • pinboolean
      • viewContactNameboolean
    • todoobject of boolean
      Keys: one of 2 values
      read manage
    • fileobject of boolean
      Keys: one of 4 values
      view manageFolders manageOwnFiles manageAllFiles
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/team-roles' \
  --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

  • Creates a record in teamRoles.

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.