IRironcladapp
Records

Upload a Smart Import Record to an existing Import

Upload a file to an existing import and create a record with smart import and predictions. Provide none of recordType, newRecordTypeId, or newRecordTypeDisplayName to default to Imported type.

OAuth Scope required: public.records.createSmartImportRecords

post/records/smart-import/{importId}

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/records/smart-import/{importId}
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.records.createSmartImportRecords

Path parameters

importIdstring required

The Import Id. You can upload a record to an existing import in the repository.

Headers

x-as-user-emailstring
Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

x-as-user-idstring
Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

Request body multipart/form-data

attachmentstring binary required

Must be a binary. Base64 is not accepted at this time.

recordTypestring required

Upload a smart import record as an existing record type. Cannot provide alongside newRecordTypeId and newRecordTypeDisplayName. Defaults to Imported.

newRecordTypeIdstring

The record type ID for a not-yet-existing record type. Must be provided along with a newRecordTypeDisplayName

newRecordTypeDisplayNamestring

The display name of the new record type to create.

Response

200

recordIdstring

Record ID of the new created record

importIdstring
remainingCreditsnumber

Example response

{
  "recordId": "17fe582d-e1e0-4000-bf65-3d2ec2c500a4",
  "importId": "55ez635d-f2g9-5419-gs34-8h1jx4s733q9",
  "remainingCredits": 50
}

Changes

No recorded changes to this operation across all 2 revisions of this API.