Client 🀝

APIs to create and update a partner's clients

Available Endpoints

POST - Create New Client

https://api.gameball.co/api/v3.0/integrations/client

This API is used by partners to create new clients

This endpoint is only available for our Partner customers only 🀝

Request

Body

Sample Request Body

{
  "name": "Jon Snow",
  "email": "testEmail@email.com",
  "mobile": "+01010101010",
  "plan": "Pro",
  "isLoyaltyEnabled": true,
  "storeName": "MyNewStore",
  "domain": "mynewstore.com",
  "customDomain": "mynewstore.custom.com",
  "currency": "USD",
  "timezone": "GMT+1",
  "status": "active",
  "country": "Saudi Arabia",
  "subscriptionId": 23
}

Response

Store these values somewhere safe for later usage

Sample Response

{
    "apiKey": "e4ed9964dba843a98aa231cfca1c00ed",
    "secretKey": "0ba56fe05f604463a27b883809833a19",
    "gameballId": 12345
}

PUT - Update Client

https://api.gameball.co/api/v3.0/integrations/client

This API is used by partners to update clients

This endpoint is only available for our Partner customers only 🀝

Request

Header

Only parameters that will be updated should be sent

Body

Sample Request

{
  "status": "trialing",
  "name": "New Name",
  "email": "newemail@email.com",
  "mobile": "010010101010",
  "storeName": "NewStoreName",
  "isLoyaltyEnabled": true
}

Response

Sample Response

{
    "id": 1234,
    "name": "Jon Snow",
    "email": "testEmail@email.com",
    "mobile": "+01010101010",
    "plan": "Pro",
    "isLoyaltyEnabled": true,
    "storeName": "MyNewStore",
    "domain": "mynewstore.com",
    "customDomain": "mynewstore.custom.com",
    "currency": "USD",
    "timezone": "GMT+1",
    "status": "active",
    "country": "Saudi Arabia",
    "subscriptionId": 23
  }

Last updated