Manage assigned groups

Call template

All DataTable calls can be POST or GET.

https://{OrangeLogicURL}/API/DataTable/v2.1/ Contact.Group.Link:Create?{account identifier}&{group identifier}

Members of a group share settings that allow them to perform certain actions or access specific features in Orange Logic. When you add an account to a group, you give a user the Security Functions and Permissions assigned to that group. When you remove a user from a group, you take away from the user any privileges assigned to that group. Accounts can belong to multiple groups.

ℹ️
Note
When you move an account into or out of a group, you’ll specify the action and then use sub-calls to identify an account and a group in the database. Sub-calls are enclosed in square brackets.
For example, consider the following call:
/Contact.Group.Link:Create?Contact.CoreField.CG_RecordID:=[Datatable/v2.1/Contact.Group:Read?Contact.CoreField.Title_English=Staff]&Contact.CoreField.CT_RecordID:=[Datatable/v2.1/Contact.All:[email protected]]
In this call, the sub-calls are:

Datatable/v2.1/Contact.Group:Read?Contact.CoreField.Title_English=Staff

Datatable/v2.1/Contact.All:[email protected]

These sub-calls read the Contacts DataTable to find the group with the name “Staff” and the account with the email [email protected].

Create

Example 1: Add an account to the Staff group

This call creates a link between a group with the name “Staff” and an account that uses the email [[email protected]].

/API/DataTable/v2.1//Contact.Group.Link:Create?Contact.CoreField.CG_RecordID:=[Datatable/v2.1/Contact.Group:Read?Contact.CoreField.Title_English=Staff]&Contact.CoreField.CT_RecordID:=[Datatable/v2.1/Contact.All:[email protected]]

Example call

curl --location --globoff --request POST 'https://mangovations.com/API/DataTable/v2.1/Contact.Group.Link:Create?Contact.CoreField.CG_RecordID%3A=[Datatable%2Fv2.1%2FContact.Group%3ARead%3FContact.CoreField.Title_English%3DStaff]&Contact.CoreField.CT_RecordID%3A=[Datatable%2Fv2.1%2FContact.All%3ARead%3FContact.CoreField.Email1%3Dmelissa.collins%40mangovations.com]' \
--header 'Authorization: Bearer 0BTQt8wckTdLU2yg7NCOPC4m6RqO0kvMxNEsRd8PlCfArXcRuDHhPWPBpHYSmBl.b.CqhNhcX4e.Lx7CGzCiXC.ESdsoPAnuborQR9lf1ODU40HiiQTFDa8njqI65EjY' \
--header 'Cookie: AWSALB=n67dJCuuuLyiR/XsJC7VDV8a4i2oERnDdCXUBnCzZB2Ur0W/zWPaNnnyHxqFMC463Efvq1XiGcLDVOnUpZb1W7/EPyv5RJCiP2zsUX1xFkB8Qw/Mg7W8MpYZc5ql; AWSALBCORS=n67dJCuuuLyiR/XsJC7VDV8a4i2oERnDdCXUBnCzZB2Ur0W/zWPaNnnyHxqFMC463Efvq1XiGcLDVOnUpZb1W7/EPyv5RJCiP2zsUX1xFkB8Qw/Mg7W8MpYZc5ql; AWSALBTG=zOD+RpF5cysr85woyrvbfzT55L+3cT+K2B4iZevLF57U612bmT6HNCNK5mgDX3iDfrudgPDvmen28yZpNPQ9QFyeI/r1YEAaGK751E/6ARyrMBSUM//8AGhiseyRk3i/W2P1IFl7J743HTQB2TVXmbNsPtkvY62KQlPaz8gl+d1u; AWSALBTGCORS=zOD+RpF5cysr85woyrvbfzT55L+3cT+K2B4iZevLF57U612bmT6HNCNK5mgDX3iDfrudgPDvmen28yZpNPQ9QFyeI/r1YEAaGK751E/6ARyrMBSUM//8AGhiseyRk3i/W2P1IFl7J743HTQB2TVXmbNsPtkvY62KQlPaz8gl+d1u; CortexCID_ZZ1=NK2uiOOw0h7gcj0c; ZZ1-Session__1505=CfDJ8KSkO661hSREsDx7PGb48%2B1Vsa0d5Vv4k3OyzpNBYAOTk62D%2FLNX1wBrc1nfUjg%2F87Y67ZB3Hbq7kaK64rHWjNkPranU69hEGoZ0zfjtu0B9NItGAkGH3HugPM5s0cpWFomOJzAzfuROsGKuwwBl6cPZTz0KTGfHqWrEWgLEzZZH; ZZ1-Session__1505-Alt=CfDJ8KSkO661hSREsDx7PGb48%2B1Vsa0d5Vv4k3OyzpNBYAOTk62D%2FLNX1wBrc1nfUjg%2F87Y67ZB3Hbq7kaK64rHWjNkPranU69hEGoZ0zfjtu0B9NItGAkGH3HugPM5s0cpWFomOJzAzfuROsGKuwwBl6cPZTz0KTGfHqWrEWgLEzZZH'

Response

<Result>
  <APIRequestInfo>
    <ProviderVersion>KOBE.R2.2065G.216363</ProviderVersion>
    <ProviderIdentity>OLU-T-USW2-APP</ProviderIdentity>
    <ProviderID>44ddde3ac27a33c394335f249d4007d4</ProviderID>
    <Module>DataTable</Module>
    <APIVersion>v2.1</APIVersion>
    <Resource>Contact.Group.Link:Create</Resource>
    <IsLoggedIn type="Boolean">True</IsLoggedIn>
    <Status>LoggedIn</Status>
    <UserLogin>ZZ1CT12218</UserLogin>
    <Session>No session (production configuration)</Session>
    <TimeoutPeriodMinutes type="Numeric">120</TimeoutPeriodMinutes>
  </APIRequestInfo>
  <RequestInterpretation>
    <Updates type="List">
      <Update>
        <Field>Contact.CoreField.CG_RecordID</Field>
        <Operator>:=</Operator>
        <OperatorDescription>Assign a value to a single-value field</OperatorDescription>
        <Value>K9ITLS6_V</Value>
      </Update>
      <Update>
        <Field>Contact.CoreField.CT_RecordID</Field>
        <Operator>:=</Operator>
        <OperatorDescription>Assign a value to a single-value field</OperatorDescription>
        <Value>K8OEC0A4OM6</Value>
      </Update>
    </Updates>
  </RequestInterpretation>
  <Response>
    <RecordID>2QDTMVN3STE</RecordID>
    <Code>SUCCESS</Code>
  </Response>
</Result>

Delete

Example 2: Remove an account from the Staff group

This call removes the user with the email [[email protected]] from the Staff group.

/API/DataTable/v2.1//Contact.Group.Link:Delete?Contact.CoreField.CG_RecordID=[Datatable/v2.1/Contact.Group:Read?Contact.CoreField.Title_English=Staff]&Contact.CoreField.CT_RecordID=[Datatable/v2.1/Contact.All:[email protected]]