Skip to content
campaiDeveloper
campai.com

Connect · Teams

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

Update team access

Updates automatic membership criteria and the default member role, rejects stale settings, and retries unfinished synchronization when saved unchanged

Permissions

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

Permission checks in detail
Required permissions
  • team.edit

Request

Path parameters

  • organizationIdidrequired
  • teamIdidrequired

Body

Content-Type: application/json

  • membershipobjectrequired
    4 properties
    • contactTypesstring[]required
      member address customer sponsor contributor employee supplier
    • segmentsstring[]required

      each 1–30 characters

    • departmentsid[]required
    • tagsstring[]required

      at most 20 items · each 1–40 characters

  • memberRoleidrequired
  • expectedobjectrequired
    2 properties
    • membershipobjectrequired
      4 properties
      • contactTypesstring[]required
        member address customer sponsor contributor employee supplier
      • segmentsstring[]required

        each 1–30 characters

      • departmentsid[]required
      • tagsstring[]required

        at most 20 items · each 1–40 characters

    • memberRoleidrequired
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/access' \
  --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.

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.