Skip to content
campaiDeveloper
campai.com

Connect · Teams

POST/connect/organizations/{organizationId}/teams/{teamId}/memberships/{contactId}/role

Update membership role

Assigns, changes, or removes a contact’s role in a team without changing the membership. Supply the organization, team, and contact IDs and a role ID, or null to remove the assigned role. An assigned role replaces the team’s default member role for that team. The endpoint returns no response body.

Permissions

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

Who may call it

  • Requires organization access.
  • Requires team.edit.
  • Requires mandate.read.
  • The contact must have at least one type for which the caller has read access. Permitted mandate restrictions also apply.

Request

Path parameters

  • organizationIdidrequired
  • teamIdidrequired
  • contactIdidrequired

Body

Content-Type: application/json

  • roleIdidrequirednullable
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/memberships/YOUR_CONTACT_ID/role' \
  --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 contact’s role and role name for the team, or clears both when roleId is null.
  • When an existing role is assigned, increments its referenceRevision.
  • Increments the team’s membershipRevision as part of the update.
  • Clears the contact’s Connect user organizations cache after updating the membership.

Errors

Other errors

StatusErrorWhen
404The team was not foundIf the team is not found, returns HTTP 404 NOT_FOUND with key routes.connect.teams.notFound.
404The membership was not found or you do not have access to the contactIf the membership is not found or the contact is not accessible, returns HTTP 404 NOT_FOUND with key routes.connect.teams.membershipNotFound.
404The team role was not foundIf a non-null role ID is supplied and the role is not found, returns HTTP 404 NOT_FOUND with key routes.connect.teams.roles.notFound.

Errors nearly every request can meet are listed under Errors.