Create Points Pool

1 min

POST

https://api.b.preview.loyaltyservices.io/api/v3/points-pools

Create a new points pool. At least two initial (active or invited) members are required. A member can be active in or invited to only one active points pool at a time.

Body Parameters

bodyPointsPoolrequired
- namestring
  Description
  Pool name
  Max Length
  128
- descriptionstring
  Description
  Pool description
  Max Length
  500
- membersPointsPoolMember[]
  - memberIdentifierstringrequired
  - statusCodestringrequired
    Description
    Pool membership status, one of A (Active), D (Declined), I (Invited), R (Retired)
    Default
    A
  - accountNumberstring
    Description
    Member's account number
  - firstNamestring
    Description
    Member's first name
  - lastNamestring
    Description
    Member's last name
  - accountStatusCodestring
    Description
    Member's account status
  - pointBalancenumber
    Example
    12345
    Description
    Member's point balance

Responses

200Success

PointsPool
- poolIdinteger<int64>
  Description
  Pool identifier
  Format
  int64
- namestring
  Description
  Pool name
  Max Length
  128
- descriptionstring
  Description
  Pool description
  Max Length
  500
- statusCodestring
  Description
  Pool status code, one of A (Active), I (Inactive)
- membersPointsPoolMember[]
  - memberIdentifierstringrequired
  - statusCodestringrequired
    Description
    Pool membership status, one of A (Active), D (Declined), I (Invited), R (Retired)
    Default
    A
  - accountNumberstring
    Description
    Member's account number
  - firstNamestring
    Description
    Member's first name
  - lastNamestring
    Description
    Member's last name
  - accountStatusCodestring
    Description
    Member's account status
  - pointBalancenumber
    Example
    12345
    Description
    Member's point balance

400Bad request

ErrorResponse
- errorsValidationError[]
  Description
  List of errors
  - codestring
    Description
    Error code assigned to this violation
  - fieldNamestring
    Description
    Name of field that violated validation constraint (optional)
  - messagestring
    Description
    Internal message describing the error
  - messageParametersobject[]
    Description
    Error message parameters

401Unauthorized

403Forbidden

500Internal error

curl

curl --request POST \
     --url https://api.b.preview.loyaltyservices.io/api/v3/points-pools \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "members": [
     {
     "memberIdentifier": "",
     "statusCode": "A"
     }
     ]
     }'

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.b.preview.loyaltyservices.io/api/v3/points-pools")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "members": [
      {
         "memberIdentifier": "",
         "statusCode": "A"
      }
   ]
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.b.preview.loyaltyservices.io/api/v3/points-pools"

payload = json.dumps({
   "members": [
      {
         "memberIdentifier": "",
         "statusCode": "A"
      }
   ]
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

java

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"members\": [\n    {\n      \"memberIdentifier\": \"\",\n      \"statusCode\": \"A\"\n    }\n  ]\n}");
Request request = new Request.Builder()
   .url("https://api.b.preview.loyaltyservices.io/api/v3/points-pools")
   .method("POST", body)
   .addHeader("accept", "application/json")
   .addHeader("content-type", "application/json")
   .build();
Response response = client.newCall(request).execute();

200

// Success
{
  "poolId": "",
  "name": "",
  "description": "",
  "statusCode": "",
  "members": [
    {
      "memberIdentifier": "",
      "statusCode": "",
      "accountNumber": "",
      "firstName": "",
      "lastName": "",
      "accountStatusCode": "",
      "pointBalance": 12345
    }
  ]
}

400

// Bad request
{
  "errors": [
    {
      "code": "",
      "fieldName": "",
      "message": "",
      "messageParameters": [
        {}
      ]
    }
  ]
}

401

// Unauthorized

403

// Forbidden

500

// Internal error