Create Batch Import

Creates a batch user import job with the given list of users' information.

Users are upserted (created if they do not exist or updated if they do exist). This is the first step in an asynchronous workflow. This request can be made idempotent.

Payload Limits

The number of request objects that can be included in a single batch request is 50,000.

Header Parameters

Idempotency-Key string optional

Optional header for making the request idempotent

Request Body required

requests object[] required
The list of users and their information that should be imported in this batch request
Array [
id string optional
The Fullstory assigned user ID
uid string optional
Possible values: <= 256 characters
The application-specific ID you've given to the user
display_name string optional
Possible values: <= 256 characters
The nice-looking name for this user
email string optional
Possible values: <= 128 characters
The email address associated with this user
properties object optional
Properties that provide additional information about your user.
• Up to 500 unique properties are allowed.
• Property names must be a sequence of alphanumeric characters A-Z, a-z, or 0-9 and underscores ("_").
• Property names must start with an alphabetic character (A-Z or a-z).
• The maximum property name length is 512 characters.
• Property values may also contain nested objects. Properties within nested objects must still conform to the naming requirements. For nested objects, the property name including the dotted concatenation of all its parent properties must still be under the length limit of 512 characters.
• Property values have a maximum size of 8192 bytes. If the value for the property is larger than this limit, the property will be rejected.
schema object optional
Optional schema declaration, to define the structure of the data and override Fullstory's default type inference.
properties object optional
A mapping of field names to their corresponding types.
]

Responses

200

---

A successful response.

Schema

Example

---

Schema

job object required

Information about the job that was initiated to import the list of users submitted

id string required

ID of the job.

status string required

Possible values: [PROCESSING, COMPLETED, FAILED]

Status of the job.

created date-time required

Time the job was accepted.

finished date-time optional

Time the job was finished, either successfully or unsuccessfully.

{
  "job": {
    "id": "abc123",
    "status": "PROCESSING",
    "created": "2017-01-15T01:30:15.01Z"
  }
}

Returned when invalid input has been provided. Fix the issue and retry.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "uid is required",
  "code": "required_field"
}

Returned when access to the resource is unauthorized.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "access is unauthorized",
  "code": "unauthorized"
}

Returned when access is not allowed due to insufficient permissions.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "insufficient permissions",
  "code": "forbidden"
}

Returned when the resource does not exist.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "Requested resource does not exist",
  "code": "resource_not_found"
}

Returned when the client has exceeded the rate limit for this endpoint. A Retry-After header will be included with the response. This header will contain the number of seconds that you should wait before attempting to send another request.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "Too many requests. Client has exceeded the rate limit for this endpoint.",
  "code": "too_many_requests"
}

Returned when a server error is encountered

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "Server error was encountered",
  "code": "server_error"
}

Loading...