POST
/
projects
/
{projectIdOrName}
/
integrations
/
{integrationId}
/
objects
/
{objectName}

Authorizations

X-Api-Key
string
headerrequired

Path Parameters

projectIdOrName
string
required
integrationId
string
required
objectName
string
required

Body

application/json
groupRef
string
required

The ID of the user group whose SaaS instance you'd like to write data to. This is the ID that was provided during installation creation.

type
enum<string>
required

The type of write operation. Synchronous mode only supports create and update. Bulk mode only supports upsert and delete.

Available options:
create,
update,
upsert,
delete
mode
enum<string>

The mode of write operation. Default is synchronous.

Available options:
synchronous,
bulk
record
object

The record to write in case of non-bulk writes.

recordsCSV
string

The records to write, in a CSV string. Max size limit of data is 10 MiB. For bulk writes, you must provide either recordsCSV or recordsURL.

recordsURL
string

Either a public URL to download the records in CSV format, or a reference returned by /generate-upload-url. Max size limit of CSV data is 150 MiB. You can provide either recordsCSV or recordsURL. For bulk writes, you must provide either recordsCSV or recordsURL.

primaryKey
string

The name of the primary key field for bulk write (required for upsert, update and delete)

Response

200 - application/json
result
object
required

Was this page helpful?

Access via API keyGenerate a signed URL to upload write data to.