API Reference

CREATE calls

The Create action creates a new object (asset, contact, tag, etc.).

  • If the call is successful, the RecordID of the newly-created object is returned.
  • If the operation fails, the response will include details of the fields with unexpected or required values.

📘

Note

If you create a user account, your changes might trigger an email to notify that user of their new account. You can control email notifications with the &AllowNotifications parameter.

Asset example

This call creates a new Standard Image record in the Library folder titled “Marketing image.”

POST or GET /API/DataTable/V2.2/Documents.Image.Default:Create?CoreField.Title:=Marketing image

Response 
  
<Result>
<APIRequestInfo>
<ProviderVersion>KOBE.R2.2065G.216363</ProviderVersion>
<ProviderIdentity>OLU-T-USW2</ProviderIdentity>
<ProviderID>44ddde3ac27a33c394335f249d4007d4</ProviderID>
<Module>DataTable</Module>
<APIVersion>V2.2</APIVersion>
<Resource>Documents.Image.Default:Create</Resource>
<IsLoggedIn type="Boolean">True</IsLoggedIn>
<Status>LoggedIn</Status>
<UserLogin>[email protected]</UserLogin>
<Session>Jen Demo</Session>
<TimeoutPeriodMinutes type="Numeric">120</TimeoutPeriodMinutes>
</APIRequestInfo>
<RequestInterpretation>
<Updates type="List">
<Update>
<Field>CoreField.Title</Field>
<Operator>:=</Operator>
<OperatorDescription>Assign a value to a single-value field</OperatorDescription>
<Value>Marketing image</Value>
</Update>
</Updates>
</RequestInterpretation>
<Response>
<RecordID>2QDTWAOWRKD</RecordID>
<Code>SUCCESS</Code>
</Response>
</Result>

Contact example

This call creates a new user account with these details:

  • First name: Kristen
  • Last name: Harrison
  • Country: United States of America
  • Email address: [[email protected]]

POST or GET /API/DataTable/V2.2/Contacts.Client.Default:Create?CoreField.First_Name:=Kristen&CoreField.Last_Name:=Harrison&CoreField.Counry:=United States of America&CoreField.Email1:=[[email protected]](mailto:[email protected])

Response 
  
<Result>
<APIRequestInfo>
<ProviderVersion>KOBE.R2.2065G.216363</ProviderVersion>
<ProviderIdentity>OLU-T-USW2</ProviderIdentity>
<ProviderID>44ddde3ac27a33c394335f249d4007d4</ProviderID>
<Module>DataTable</Module>
<APIVersion>V2.2</APIVersion>
<Resource>Contacts.Client.Default:Create</Resource>
<IsLoggedIn type="Boolean">True</IsLoggedIn>
<Status>LoggedIn</Status>
<UserLogin>[email protected]</UserLogin>
<Session>Jen Demo</Session>
<TimeoutPeriodMinutes type="Numeric">20</TimeoutPeriodMinutes>
</APIRequestInfo>
<RequestInterpretation>
<Updates type="List">
<Update>
<Field>CoreField.Country</Field>
<Operator>:=</Operator>
<OperatorDescription>Assign a value to a single-value field</OperatorDescription>
<Value>United States of America</Value>
</Update>
<Update>
<Field>CoreField.Email1</Field>
<Operator>:=</Operator>
<OperatorDescription>Assign a value to a single-value field</OperatorDescription>
<Value>[email protected]</Value>
</Update>
<Update>
<Field>CoreField.First_Name</Field>
<Operator>:=</Operator>
<OperatorDescription>Assign a value to a single-value field</OperatorDescription>
<Value>Kristen</Value>
</Update>
<Update>
<Field>CoreField.Last_Name</Field>
<Operator>:=</Operator>
<OperatorDescription>Assign a value to a single-value field</OperatorDescription>
<Value>Harrison</Value>
</Update>
</Updates>
</RequestInterpretation>
<Response>
<RecordID>K8OEC0A793N</RecordID>
<Code>SUCCESS</Code>
</Response>
</Result>