Guest Import

post

https://sandbox-api.softpoint.io/interface/v1/locations/YOUR_LOCATION_ID/guests/import

Imports guest records in bulk from an uploaded file. Use this endpoint to migrate an existing customer list into Softpoint avoiding the need to create each guest individually.

Request Headers

Header	Required	Description
Authorization	Yes	Bearer YOUR_ACCESS_TOKEN
Content-Type	Yes	`multipart/form-data`. Set automatically by most HTTP clients when uploading a file.

Request Parameters

Path Parameters

Parameter	Type	Required	Description
location_id	string	Yes	Identifier of the location the guests are imported to.

Form Data Fields

Field	Type	Required	Description
import_file	file	Yes	The file containing guest records to import.
user_id	text	Yes	Identifier of the user performing the import.

Request Example

The request is sent as multipart form data. The import_file field carries the file, and user_id identifies the acting user.

import_file: guests.csv
user_id: 226

cURL Example

curl --request POST \
  --url https://sandbox-api.softpoint.io/interface/v1/locations/YOUR_LOCATION_ID/guests/import \
  --header "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  --form [email protected] \
  --form user_id=226

Success Response

Status: 200 OK

{
  "status": "success",
  "message": "Guest data imported successfully!",
  "processed_records": 8
}

Response Fields

Field	Type	Description
status	string	Indicates whether the import completed successfully. Returns `"success"` on successful import.
message	string	Confirmation that the guest data was imported successfully.
processed_records	integer	Number of guest records successfully processed during the import.

Error Responses

The endpoint follows the standard API error envelope.

Missing Required Parameters

Status: 400 Bad Request

{
  "error": {
    "code": 10109,
    "message": "The request is missing one or more required parameter(s).",
    "details": {
      "import_file": [
        "missing_required_parameters"
      ]
    }
  }
}

Status Codes

Code	Description
200	Guest data imported successfully.
400	Missing file or invalid request parameters.
401	Missing or invalid access token.

Workflow Placement

Guest import is part of location onboarding and ongoing data synchronization:

Generate an interface access token.
Prepare a guest file in the format expected by the location.
Upload the file through this endpoint.
Use the imported guests in ordering and reporting workflows.

Notes

The request must be sent as multipart/form-data, not JSON.
The structure and required columns of the import file are not specified in the collection. Confirm the expected format with Softpoint before importing.
A successful response includes the number of records processed in the processed_records field.
The API documentation does not specify whether partially successful imports are possible or how skipped or invalid records are reported. Verify this behavior in the live environment if your integration depends on it.
Run a trial import in the sandbox environment to confirm formatting before importing into production.

Common Mistakes

Sending the request as JSON instead of multipart/form-data.
Omitting the import_file or user_id field.
Assuming the import file format without validating the required columns.
Importing an unvalidated file directly into production without first testing in the sandbox.

Response

200Successful response