Bulk import mPass users

POST 
/api/gateway/v1/mpass/users/import

Bulk import mPass users

Request

Header Parameters

x-api-key stringrequired

Gateway API key

application/json

Body

required

users

object[]

required

List of users to import

Array [

object

]

Responses

201

Users imported successfully

application/json

Schema

Schema

status numberrequired

Response status code

message stringrequired

Response status message

data

object[]

required

Response data

Array [

id stringrequired

User ID

name stringrequired

User name

email stringrequired

User email

membershipId stringrequired

Membership ID

status stringrequired

Possible values: [active, inactive]

User status

tierCode string

User tier code

createdAt date-timerequired

Created date

disabledAt date-time

Disabled date

]

requestId string

Request ID for tracking

meta

object

Pagination details, if applicable

page numberrequired

Current page number

perPage numberrequired

Number of items per page

count numberrequired

Number of returned items

totalCount numberrequired

Total number of items

totalPages numberrequired

Total number of pages

hasNextPage boolean

Has next page

hasPrevPage boolean

Has previous page

Example (from schema)

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "John Doe",
      "email": "john.doe@example.com",
      "membershipId": "memb-550e8400-e29b-41d4-a716-446655440000",
      "status": "active",
      "tierCode": "STANDARD",
      "createdAt": "2023-01-01T00:00:00.000Z",
      "disabledAt": "2023-01-01T00:00:00.000Z"
    }
  ],
  "requestId": "req-123456",
  "meta": {
    "page": 1,
    "perPage": 10,
    "count": 10,
    "totalCount": 100,
    "totalPages": 10,
    "hasNextPage": true,
    "hasPrevPage": false
  }
}

401

Unauthorized

application/json

Schema

Schema

status number
message string

error

object

code string

Error code

detail string

Error detail

Example (from schema)

{
  "status": 401,
  "message": "Invalid API key",
  "error": {
    "code": "UNAUTHORIZED",
    "detail": "Invalid API key"
  }
}

Loading...