Records

Upsert a record by remote ID

post/record/remote/{remoteId}/{remoteApplication}

Request

  • Base URL: https://test.boost.space/api
  • URL: https://test.boost.space/api/record/remote/{remoteId}/{remoteApplication}
  • Auth: HTTP bearer

Path parameters

remoteIdstring required

Remote ID of record to be synchronized

remoteApplicationstring required

Name of remote application

Request body

idinteger

Unique identifier - primary key

createdstring date-time

Creation timestamp

createdUserIdinteger

ID of user who created this record

statusSystemIdinteger required

ID of the system-level status (pipeline stage) this record belongs to; must be valid for the module.

statusIdinteger

ID of the user-defined sub-status within the system status.

spaceIdinteger required

ID of the space this record belongs to.

featuredImageIdinteger

ID of the File used as the default image for this record.

filesinteger[]

IDs of files attached to this record.

labelsinteger[]

IDs of labels assigned to this record.

boostIdstring

Globally unique cross-system identifier for this record (used for integrations and deduplication).

Example request

{
  "id": 42,
  "created": "2026-01-15T09:30:00Z",
  "createdUserId": 42,
  "statusSystemId": 42,
  "statusId": 42,
  "spaceId": 42,
  "featuredImageId": 42,
  "files": [
    1
  ],
  "labels": [
    1
  ],
  "boostId": "string",
  "customFieldsValues": [
    {
      "id": 42,
      "created": "2026-01-15T09:30:00Z",
      "valueWysiwyg": "string",
      "valueInt": 1,
      "valueFloat": 1.5,
      "valueDatetime": "2026-01-15T09:30:00Z",
      "valueModule": "string",
      "value": "string",
      "fileId": 42,
      "customFieldInputId": 42,
      "module": "activities",
      "table": "string",
      "entityId": 42,
      "customFieldInputName": "Sample customFieldInputName",
      "selected": "string",
      "ipAddress": "string",
      "translatable": true,
      "translations": {
        "en": {
          "field1": "translation1",
          "field2": "translation2"
        },
        "it": {
          "field1": "translation1",
          "field2": "translation2"
        },
        "cs": {
          "field1": "translation1",
          "field2": "translation2"
        }
      }
    }
  ]
}

Response

Record found & updated

idinteger

Unique identifier - primary key

createdstring date-time

Creation timestamp

createdUserIdinteger

ID of user who created this record

statusSystemIdinteger required

ID of the system-level status (pipeline stage) this record belongs to; must be valid for the module.

statusIdinteger

ID of the user-defined sub-status within the system status.

spaceIdinteger required

ID of the space this record belongs to.

featuredImageIdinteger

ID of the File used as the default image for this record.

filesinteger[]

IDs of files attached to this record.

labelsinteger[]

IDs of labels assigned to this record.

boostIdstring

Globally unique cross-system identifier for this record (used for integrations and deduplication).

Example response

{
  "id": 42,
  "created": "2026-01-15T09:30:00Z",
  "createdUserId": 42,
  "statusSystemId": 42,
  "statusId": 42,
  "spaceId": 42,
  "featuredImageId": 42,
  "files": [
    1
  ],
  "labels": [
    1
  ],
  "boostId": "string",
  "customFieldsValues": [
    {
      "id": 42,
      "created": "2026-01-15T09:30:00Z",
      "valueWysiwyg": "string",
      "valueInt": 1,
      "valueFloat": 1.5,
      "valueDatetime": "2026-01-15T09:30:00Z",
      "valueModule": "string",
      "value": "string",
      "fileId": 42,
      "customFieldInputId": 42,
      "module": "activities",
      "table": "string",
      "entityId": 42,
      "customFieldInputName": "Sample customFieldInputName",
      "selected": "string",
      "ipAddress": "string",
      "translatable": true,
      "translations": {
        "en": {
          "field1": "translation1",
          "field2": "translation2"
        },
        "it": {
          "field1": "translation1",
          "field2": "translation2"
        },
        "cs": {
          "field1": "translation1",
          "field2": "translation2"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.