API Reference

Create or update an account

Modify the information in an account

Call template

All DataTable calls can be POST or GET.

https://{OrangeLogicURL}/API/DataTable/v2.1 Contact.{ContactType}:CreateOrUpdate?Contact.CoreField.Email1={email address of the account}&{account metadata}

Identify an account by email address, and then specify new values for any of the account’s metadata fields.

Create or Update

If the email address is already in use in an account, a CreateorUpdate call updates that account. If the email address is not in use, this call creates a new account.

Example 1: Create a new user account with a name, country, company, and validation status

This call creates a new account with the following details:

  • Email: melissa.collins(at)mangovations.com
  • First name: Melissa
  • Last name: Collins
  • Country: United States of America
  • Organization: Mangovations
  • Status: Validated
  • Required password reset at login

https://mangovations.com/API/DataTable/v2.1/Contact.Client:CreateOrUpdate?Contact.CoreField.Email1=melissa.collins@mangovations.com&Contact.CoreField.First_Name:=Melissa&Contact.CoreField.Last_Name:=Collins&Contact.CoreField.Country:=United States of America&Contact.CoreField.OrganisationName:=Mangovations&Contact.CoreField.Status:=Validated&Contact.CoreField.MustResetPassword:=1

❗

Warning

We recommended including Contact.CoreField.MustResetPassword=1 in account calls, which requires a user to change their password when they next log in to their account. To maintain system security, you cannot set an account password via API. User-created passwords are encrypted in Orange Logic and cannot be accessed by anyone, including Orange Logic staff. Users must click Forgot your password? on the login screen to securely set or change a password.

Example call 
curl --location --request POST 'https://mangovations.com/API/DataTable/v2.1/Contact.Client:CreateOrUpdate?Contact.CoreField.Email1=melissa.collins%40mangovations.com&Contact.CoreField.First_Name%3A=Melissa&Contact.CoreField.Last_Name%3A=Collins&Contact.CoreField.Country%3A=United%20States%20of%20America&Contact.CoreField.OrganisationName%3A=Mangovations&Contact.CoreField.Status%3A=Validated&Contact.CoreField.MustResetPassword%3A=1' \
--header 'Authorization: Bearer pYXtK4jnyan9YEHVnlKDGgqEcmygK@gf@jP3kqK6Knj0YTZlmtDkUQCjgRn26RfrtqMsDFCEfNtO4CCinW2Kq0aYfvIBDJCrvjCIKIuteuuRqsZVRW5Ool5Men.M7Pc0' \
--header 'Cookie: AWSALB=NpbRWj8BF+2PN9sGJJFIOAxmIn+OLwmBvnaKi4gHKIRSawNeahhmSp8sXrbO2VSKae4mz68Tmp+eSe/OIPZ6/g4d26U3EvoQ1ON87e0mqEf3oegk1otyarSsS8IO; AWSALBCORS=NpbRWj8BF+2PN9sGJJFIOAxmIn+OLwmBvnaKi4gHKIRSawNeahhmSp8sXrbO2VSKae4mz68Tmp+eSe/OIPZ6/g4d26U3EvoQ1ON87e0mqEf3oegk1otyarSsS8IO; AWSALBTG=MobnXh/iESwLJoWW0Ap5ioYa/FRh1cwhNDTw5QcSEz+sAJVbMit5FrevI9dmw3KC310g6mq2JCCtph8sa0uG+KlhkFgn556QP4iwFLHb6z9UriZWCRGTuT+ynCnHuWPSSlApHCHOzf78tYyyKBybBTmINsoV+OlC9Ntw8eEg67l9; AWSALBTGCORS=MobnXh/iESwLJoWW0Ap5ioYa/FRh1cwhNDTw5QcSEz+sAJVbMit5FrevI9dmw3KC310g6mq2JCCtph8sa0uG+KlhkFgn556QP4iwFLHb6z9UriZWCRGTuT+ynCnHuWPSSlApHCHOzf78tYyyKBybBTmINsoV+OlC9Ntw8eEg67l9; CortexCID_ZZ1=NK2uiOOw0h7gcj0c; ZZ1-Session__1505=CfDJ8KSkO661hSREsDx7PGb48%2B0yJhd3VCpW8XbxPQRaBoiCxOSRwOxzdBhegM88c7i6YnuSczBOPX5830YwJ234doRTeA6G97KWAucn%2Bw9FeYfMESwQKB9NfOU8X1pz9kctI2Luohn3MksdhlF8UW4R6%2Bbl%2FhrxdrCqVHsJFuE78aos; ZZ1-Session__1505-Alt=CfDJ8KSkO661hSREsDx7PGb48%2B0yJhd3VCpW8XbxPQRaBoiCxOSRwOxzdBhegM88c7i6YnuSczBOPX5830YwJ234doRTeA6G97KWAucn%2Bw9FeYfMESwQKB9NfOU8X1pz9kctI2Luohn3MksdhlF8UW4R6%2Bbl%2FhrxdrCqVHsJFuE78aos'
Response 
<Result>
  <APIRequestInfo>
    <ProviderVersion>LONDON.R2.2131E.216729</ProviderVersion>
    <ProviderIdentity>OLU-T-USW2-APP</ProviderIdentity>
    <ProviderID>44ddde3ac27a33c394335f249d4007d4</ProviderID>
    <Module>DataTable</Module>
    <APIVersion>v2.1</APIVersion>
    <Resource>Contact.Client:CreateOrUpdate</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>
    <Filters type="List">
      <Filter>
        <Field>Contact.CoreField.Email1</Field>
        <Operator>=</Operator>
        <OperatorDescription>Field must be equal to value</OperatorDescription>
        <Value>[email protected]</Value>
      </Filter>
    </Filters>
    <Updates type="List">
      <Update>
        <Field>Contact.CoreField.Country</Field>
        <Operator>:=</Operator>
        <OperatorDescription>Assign a value to a single-value field</OperatorDescription>
        <Value>United States of America</Value>
      </Update>
      <Update>
        <Field>Contact.CoreField.First_Name</Field>
        <Operator>:=</Operator>
        <OperatorDescription>Assign a value to a single-value field</OperatorDescription>
        <Value>Melissa</Value>
      </Update>
      <Update>
        <Field>Contact.CoreField.Last_Name</Field>
        <Operator>:=</Operator>
        <OperatorDescription>Assign a value to a single-value field</OperatorDescription>
        <Value>Collins</Value>
      </Update>
      <Update>
        <Field>Contact.CoreField.MustResetPassword</Field>
        <Operator>:=</Operator>
        <OperatorDescription>Assign a value to a single-value field</OperatorDescription>
        <Value>1</Value>
      </Update>
      <Update>
        <Field>Contact.CoreField.OrganisationName</Field>
        <Operator>:=</Operator>
        <OperatorDescription>Assign a value to a single-value field</OperatorDescription>
        <Value>Mangovations</Value>
      </Update>
      <Update>
        <Field>Contact.CoreField.Status</Field>
        <Operator>:=</Operator>
        <OperatorDescription>Assign a value to a single-value field</OperatorDescription>
        <Value>Validated</Value>
      </Update>
    </Updates>
    <IgnoredParameters type="List" />
  </RequestInterpretation>
  <ResponseSummary>
    <NumberOfRecordsAffected type="Numeric">1</NumberOfRecordsAffected>
  </ResponseSummary>
  <Response>
    <RecordsAffected type="List">
      <Result>
        <RecordID>K8OEC0A4OM6</RecordID>
        <Code>SUCCESS</Code>
      </Result>
    </RecordsAffected>
  </Response>
</Result>

Update

Example 2: Change an account’s status

This call identifies the account that uses the email address melissa.collins(at)mangovations.com. The call then changes the status of the account to Pending and adds a note about the status change.

/API/DataTable/v2.1/Contact.Client:[email protected]&Contact.CoreField.Status:=Pending&Contact.CoreField.Note:=Account created, activation pending review. 31 January 2025.

Example call 
curl --location --request POST 'https://mangovations.com/API/DataTable/v2.1/Contact.Client:Update?Contact.CoreField.Email1=melissa.collins%40mangovations.com&Contact.CoreField.Status%3A=Pending&Contact.CoreField.Note%3A=Account%20created%2C%20activation%20pending%20review.%2031%20January%202025.' \
--header 'Authorization: Bearer fjRYx5GXxgKaSEC6iBosgwhO2xXod8R7jNHyhBECtjHTm.2FEvw7GHfdToDV289CIvq4vC42YCOtDV2XoLJqqI48JuO8fq0PknPtb0NSTB7VsElpO.Oys4M0PUuJlhq3' \
--header 'Cookie: AWSALB=Qh9JavwTvB9tASM94i/Q2rrtnyhbbU6+n2nrqEHOj/FySgwonpxbjGLY2MT+khZCsixb6Qj7GOGlB1s/tRAIu6zGscuAkYj6u+wazFrg+xAwAR6vVwp7RKKrHPpt; AWSALBCORS=Qh9JavwTvB9tASM94i/Q2rrtnyhbbU6+n2nrqEHOj/FySgwonpxbjGLY2MT+khZCsixb6Qj7GOGlB1s/tRAIu6zGscuAkYj6u+wazFrg+xAwAR6vVwp7RKKrHPpt; AWSALBTG=qVC+1R6FUC02tf8h7Rh40Odegb3prb/alnpI9rB5N6+j14BnejohmRU2E57OotMwXVCnSbn3bpk/EE1PaOk0DzOxilVuJMYAODt8BW7R8jt2p8Cxhq1DmphigH+M7z/SotLcSILt8WSpexwRU8Hyk/SS+jeJtqFyQzTebSKwcHjN; AWSALBTGCORS=qVC+1R6FUC02tf8h7Rh40Odegb3prb/alnpI9rB5N6+j14BnejohmRU2E57OotMwXVCnSbn3bpk/EE1PaOk0DzOxilVuJMYAODt8BW7R8jt2p8Cxhq1DmphigH+M7z/SotLcSILt8WSpexwRU8Hyk/SS+jeJtqFyQzTebSKwcHjN; CortexCID_ZZ1=NK2uiOOw0h7gcj0c; ZZ1-Session__1505=CfDJ8KSkO661hSREsDx7PGb48%2B1cvQTDVGoeIlYWA6ss9TlJXeihcWFsOIFz3rspr6KUGYd5dUI5FB04YmXw8ps3Hp6tfXNZAspDSupqg9Ezt%2FWjGBn64qEUnDhWux5LJ6tefLExZ%2F7H6beKjYpMN9OfvmX578mLn%2Bhp32RkId5P7mc%2B; ZZ1-Session__1505-Alt=CfDJ8KSkO661hSREsDx7PGb48%2B1cvQTDVGoeIlYWA6ss9TlJXeihcWFsOIFz3rspr6KUGYd5dUI5FB04YmXw8ps3Hp6tfXNZAspDSupqg9Ezt%2FWjGBn64qEUnDhWux5LJ6tefLExZ%2F7H6beKjYpMN9OfvmX578mLn%2Bhp32RkId5P7mc%2B'
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.Client:Update</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>
    <Filters type="List">
      <Filter>
        <Field>Contact.CoreField.Email1</Field>
        <Operator>=</Operator>
        <OperatorDescription>Field must be equal to value</OperatorDescription>
        <Value>[email protected]</Value>
      </Filter>
    </Filters>
    <Updates type="List">
      <Update>
        <Field>Contact.CoreField.Note</Field>
        <Operator>:=</Operator>
        <OperatorDescription>Assign a value to a single-value field</OperatorDescription>
        <Value>Account created, activation pending review. 31 January 2025.</Value>
      </Update>
      <Update>
        <Field>Contact.CoreField.Status</Field>
        <Operator>:=</Operator>
        <OperatorDescription>Assign a value to a single-value field</OperatorDescription>
        <Value>Pending</Value>
      </Update>
    </Updates>
    <IgnoredParameters type="List" />
  </RequestInterpretation>
  <ResponseSummary>
    <NumberOfRecordsAffected type="Numeric">1</NumberOfRecordsAffected>
  </ResponseSummary>
  <Response>
    <RecordsAffected type="List">
      <Result>
        <RecordID>K8OEC0A4OM6</RecordID>
        <Code>SUCCESS</Code>
      </Result>
    </RecordsAffected>
  </Response>
</Result>

Example 3: Update an account’s Administrator field

This call identifies an account that uses the email melissa.collins(at)mangovations.com and then populates the Administrator field in that account with the account that uses the email address jennifer.abbot(at)mangovations.com.

/API/DataTable/v2.2/Contacts.All:[email protected]&CoreField.CT_Administrator:=[API/DataTable/v2.2/Contacts.Staff.Default:[email protected]]

ℹ️

Note

The Administrator field is one of multiple linked fields included in account records. DataTable calls update linked fields by using a sub-call that locates another account record in the database. The sub-call is enclosed in square brackets.

For example, consider the following call:

/API/DataTable/v2.2/Contacts.All:[email protected]&CoreField.CT_Administrator:=[API/DataTable/v2.2/Contacts.Staff.Default:[email protected]]

In this call, the sub-call is: API/DataTable/v2.2/Contacts.Staff.Default:[email protected]

The sub-call is reading the Contacts DataTable to find the account with the email jennifer.abbot(at)mangovations.com.

Learn more about updating linked fields.

Example call 
curl --location --globoff --request POST 'https://mangovations.com/API/DataTable/v2.2/Contacts.All:Update?CoreField.Email1=melissa.collins%40mangovations.com&CoreField.CT_Administrator%3A=[API%2FDataTable%2Fv2.2%2FContacts.Staff.Default%3ARead%3FCoreField.Email1%3Djennifer.abbot%40mangovations.com]' \
--header 'Authorization: Bearer hfi2w6t6yMen5bzaFIKPx2OHiVT8ALrAz1aJnkjSCi.DSlIIejxoa2yj24BerW6Hqh2oY466ciy6SOgtHiui6rruTKCfZ452IOB38dr2fvtrgByydFQ9W.bypMU3UHF4' \
--header 'Cookie: AWSALB=B8d2dBFPWvu/Xc8WZO4zBD50Tcv+2VKiKTK7y9QEFAlVohWRnvNLzQtOgrZd4hTWnRa86POKrV+77xnVTHFkP3qws4cVAZWjFq09jQ2rtrfCskYXpiSW1yOlAkxn; AWSALBCORS=B8d2dBFPWvu/Xc8WZO4zBD50Tcv+2VKiKTK7y9QEFAlVohWRnvNLzQtOgrZd4hTWnRa86POKrV+77xnVTHFkP3qws4cVAZWjFq09jQ2rtrfCskYXpiSW1yOlAkxn; AWSALBTG=vitG3bBd7Y5DhlYmn4SfNemnhJRiG4kRNWJQI7drwwJyMEEJ2h7RnLKGq9OyMhxMwTW4VLOZCojFlYTMtRp9nYuiBxtFmoUnnF1Bdm/VpB0DSCp3Yk6ny0XBOBezBaumv/wmr/2WxdcxltXF4Mmr1/6wdzZ3y/twuBr2ggPriBas; AWSALBTGCORS=vitG3bBd7Y5DhlYmn4SfNemnhJRiG4kRNWJQI7drwwJyMEEJ2h7RnLKGq9OyMhxMwTW4VLOZCojFlYTMtRp9nYuiBxtFmoUnnF1Bdm/VpB0DSCp3Yk6ny0XBOBezBaumv/wmr/2WxdcxltXF4Mmr1/6wdzZ3y/twuBr2ggPriBas; CortexCID_ZZ1=NK2uiOOw0h7gcj0c; ZZ1-Session__1505=CfDJ8KSkO661hSREsDx7PGb48%2B3k03Tzifw1sGoP4jxEGnzqqCAbvh9UgIZQ0JYGt8eR%2FhXM%2F1vSNv2WL%2BqdVKTukmWZnw9mT4iR2XGEQas%2FhTQnQw83I0QQogelVKbB5Qel23%2FvfIFK9XdldTKM7WsfcNqrPZ4DZoAO6lK3zzd%2BwwIa; ZZ1-Session__1505-Alt=CfDJ8KSkO661hSREsDx7PGb48%2B3k03Tzifw1sGoP4jxEGnzqqCAbvh9UgIZQ0JYGt8eR%2FhXM%2F1vSNv2WL%2BqdVKTukmWZnw9mT4iR2XGEQas%2FhTQnQw83I0QQogelVKbB5Qel23%2FvfIFK9XdldTKM7WsfcNqrPZ4DZoAO6lK3zzd%2BwwIa'
Response 
<Result>
  <APIRequestInfo>
    <ProviderVersion>KOBE.R2.2065G.216363</ProviderVersion>
    <ProviderIdentity>OLU-T-USW2-APP</ProviderIdentity>
    <ProviderID>44ddde3ac27a33c394335f249d4007d4</ProviderID>
    <Module>DataTable</Module>
    <APIVersion>v2.2</APIVersion>
    <Resource>Contacts.All:Update</Resource>
    <IsLoggedIn type="Boolean">True</IsLoggedIn>
    <Status>LoggedIn</Status>
    <UserLogin>ZZ1CT12218</UserLogin>
    <Session>No session (production configuration)</Session>
    <TimeoutPeriodMinutes type="Numeric">20</TimeoutPeriodMinutes>
  </APIRequestInfo>
  <RequestInterpretation>
    <Filters type="List">
      <Filter>
        <Field>CoreField.Email1</Field>
        <Operator>=</Operator>
        <OperatorDescription>Field must be equal to value</OperatorDescription>
        <Value>[email protected]</Value>
      </Filter>
    </Filters>
    <Updates type="List">
      <Update>
        <Field>CoreField.CT_Administrator</Field>
        <Operator>:=</Operator>
        <OperatorDescription>Assign a value to a single-value field</OperatorDescription>
        <Value>[API/DataTable/v2.2/Contacts.Staff.Default:[email protected]]</Value>
      </Update>
    </Updates>
    <IgnoredParameters type="List" />
  </RequestInterpretation>
  <ResponseSummary>
    <NumberOfRecordsAffected type="Numeric">1</NumberOfRecordsAffected>
  </ResponseSummary>
  <Response>
    <RecordsAffected type="List">
      <Result>
        <RecordID>K8OEC0A4OM6</RecordID>
        <Code>SUCCESS</Code>
      </Result>
    </RecordsAffected>
  </Response>
</Result>