Upsert a record by remote ID

​
Path Parameters
  • remoteId
    Type: string
    required

    Remote ID of record to be synchronized

  • remoteApplication
    Type: string
    required

    Name of remote application

Body
required
application/json

Record data. Optionally you may provide 'rawPayload' (string JSON or object) to auto-map fields. Explicit fields override values from rawPayload.

    • spaceId
      Type: integer
      required

      ID of the space this record belongs to.

    • statusSystemId
      Type: integer
      required

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

    • customFieldsValues
      Type: array object[] ·

      Values for all custom fields defined in the module, keyed by field definition.

      A single custom field value attached to a record. The field is identified either by customFieldInputId, or by customFieldInputName + module. Values of computed fields (inputType calculation and rollup) are read-only: a calculation value is evaluated at read time from the field's inputCalculation formula and never stored, a rollup value is recomputed automatically from related records; writes to either are ignored.

    • featuredImageId
      Type: integer

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

    • labels
      Type: array integer[]

      IDs of labels assigned to this record.

    • rawPayload

      Whole source payload (JSON string or object) that will be auto-mapped to entity fields and customFieldsValues

      • Type: string

        Whole source payload (JSON string or object) that will be auto-mapped to entity fields and customFieldsValues

    • statusId
      Type: integer

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

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/record/remote/{remoteId}/{remoteApplication}
curl 'https://test.boost.space/api/record/remote/{remoteId}/{remoteApplication}' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "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": true,
      "ipAddress": "string",
      "translatable": true,
      "translations": {
        "en": {
          "field1": "translation1",
          "field2": "translation2"
        },
        "it": {
          "field1": "translation1",
          "field2": "translation2"
        },
        "cs": {
          "field1": "translation1",
          "field2": "translation2"
        }
      }
    }
  ],
  "rawPayload": ""
}'

{
  "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": true,
      "ipAddress": "string",
      "translatable": true,
      "translations": {
        "en": {
          "field1": "translation1",
          "field2": "translation2"
        },
        "it": {
          "field1": "translation1",
          "field2": "translation2"
        },
        "cs": {
          "field1": "translation1",
          "field2": "translation2"
        }
      }
    }
  ]
}

Record found & updated