PUT
/
v1
/
organizations
/
{organizationId}
/
groups
/
{groupId}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Path Parameters

organizationId
string
required

Fabric internal id of the record.

groupId
string
required

Fabric internal id of the record.

Body

application/json
userId
string

The unique string used to identify a user.

parentUserId
string

The unique string used to identify a parent user.

parentPartyId
string

The unique string used to identify a parent party.

parentGroupId
string

The unique string used to identify a parent group.

groupType
enum<string>
Available options:
Department,
Subsidiary,
Business Unit,
Team,
User,
Customer
name
string

Name of the group.

email
string

email for the group.

primaryPhone
string

primary phone for the group. If sent it has to contain 2 characters or more.

Minimum length: 2
additionalAttributes
object

Contains all additional attributes not captured in the schema.

Response

200 - application/json
_id
string

Fabric internal id of the record

parentUserId
string

Fabric internal id of the parent user record

userId
string

Fabric internal id of the user record

parentPartyId
string

Fabric internal id of the parent party record

partyId
string

Fabric internal id of the party record

parentGroupId
string

Fabric internal id of the group parent record

groupType
enum<string>

group type

Available options:
Department,
Subsidiary,
Business Unit,
Team,
User,
Customer
name
string

group3

email
string

email of the group

primaryPhone
string

primary phone of the group

additionalAttributes
object

Contains all additional attributes not captured in the schema.

isDeleted
boolean

flag that indicates if the record is deleted

createdAt
string

date of creation of the record

updatedAt
string

laste date of update of the record

Was this page helpful?

Create organization groupDelete orgaization group