Users

Upsert record by remote ID (create or update)

Upsert by remote ID: updates the existing user if a mapping is found (200), otherwise creates a new one and stores the mapping (201).

post/user/remote/{remoteId}/{remoteApplication}

Request

  • Base URL: https://test.boost.space/api
  • URL: https://test.boost.space/api/user/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

updatedstring date-time

Last updated timestamp

updatedUserIdinteger

ID of user who last updated this record

labelsinteger[]

Connected labels IDs

Example request

{
  "id": 42,
  "created": "2026-01-15T09:30:00Z",
  "createdUserId": 42,
  "updated": "2026-01-15T09:30:00Z",
  "updatedUserId": 42,
  "labels": [
    1
  ]
}

Response

Record found & updated

idinteger

Unique identifier - primary key

createdstring date-time

Creation timestamp

createdUserIdinteger

ID of user who created this record

updatedstring date-time

Last updated timestamp

updatedUserIdinteger

ID of user who last updated this record

labelsinteger[]

Connected labels IDs

Example response

{
  "id": 42,
  "created": "2026-01-15T09:30:00Z",
  "createdUserId": 42,
  "updated": "2026-01-15T09:30:00Z",
  "updatedUserId": 42,
  "labels": [
    1
  ]
}

Changes

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