Create Pool

Creates an empty pool.

POST https://apigateway.boost.rs/matchbox/pools

Pools are used for connecting to them multiple objects of the same type. Once an object of a specific type was linked (mapped) to a pool, that pool inherits the type. Any future objects that will be mapped to the pool must have the same object_type.

Headers

NameTypeDescription

Authorization*

String

Authorisation token received from oAuth API Bearer :token

Accept-Language

String

Allows you to specify if you want the output to be in one of the accepted languages. Format: ISO 639-1 language code. If no value is specified, the response language will be English.

Request Body

NameTypeDescription

name*

String

Pool name. Max length: 255

external_id

String

String with custom values.

Max length: 255 characters

provider

String

String to be used as an external linking key for linking to other client data.

Max length: 255 characters

{
    "success": true,
    "message": "",
    "result": {
        "id": 6,
        "name": "my pool",
        "external_id": "XKL-345876",
        "provider": "Group of courses"
        "objects": []
    }
}

Sample request

{
    "name": "my pool",
    "external_id": "XKL-345876",
    "provider": "Group of courses"
}

Last updated