Creates (or updates) a user account that can only create one Inspection. Returns a URL that, when opened on the users device, will download and launch the Record360 application, with a default reference number (if specified). Users can be invited via email or phone number. If phone number is present and notify_user is true, a text message will be sent instead of an email.

Errors

Code Description
402 Sending messages by SMS is a paid feature. Your account does not have this feature enabled.
429 This API is rate limited. If you exceed the allowed limits the request will not be processed.

Examples

$ curl -i \
  -H "Accept: application/json; version=1" \
  -X POST \
  -H 'Content-type: application/json' \
  -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjQyLCJpYXQiOjE0NjM2OTQ4MjN9.k48v-R-un93KdIXqp9Zi12JOGJCu8uibtrWjscFCTqc" \
  -d '{"user": { "email": "[email protected]", "phone_number": "+12345678900", location_id": "1000001447", "external_id": "J. Random", "transaction_limit": 1 }, "reference_number": "12345", "notify_user": true}' \
  https://api.record360.com/api/users/one_time_user

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate

{
  "user": {
    "id": "42",
    "username": "[email protected]",
    "email": "[email protected]"
    "phone_number": "+12345678900",
    "transaction_limit": 1
  },
  "url":"https://launch.record360.com/tMoS/29QIKDx6lK"
}

Notes:
Notification by phone number is a paid feature.
Phone number will only be returned if it is sent in the request.

Params

Param name Description
user
required

User attributes

Validations:

  • Must be a Hash

user[email]
required

Username or email address, must be globally unique

Validations:

  • Must be a String

user[phone_number]
optional

Phone number with country code to send SMS text message. Example: +12345678900

Validations:

  • Must be a String

user[location_id]
required

Location ID

Validations:

  • Must be a String

user[external_id]
optional

External ID (integrator-assigned user identifier)

Validations:

  • Must be a String

user[transaction_limit]
optional

Transaction Limit (5 max)

Validations:

  • Must be a Integer

reference_number
optional

Default Reference Number for this user’s next Inspection

Validations:

  • Must be a String

notify_user
optional

Notify new user via email or phone. Default to false.

Validations:

  • Must be one of: true, false, 1, 0.