Skip to main content
POST
/
sendPoints
Send Points API
curl --request POST \
  --url https://stagingstores.xoxoday.com/chef/v1/oauth/api/sendPoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "storesAdmin.mutation.sendBalance",
  "tag": "storeAdmin",
  "variables": {
    "sender_email": "superadmin@yourcompany.com",
    "expiry_month": 12,
    "recipients": [
      {
        "to_name": "John Smith",
        "to_email": "john@company.com",
        "amount": "100",
        "citation": "Awesome work"
      }
    ]
  }
}
'
{
  "data": {
    "unique_id": 987654321,
    "email": "john@company.com",
    "points": 100,
    "name": "John Smith",
    "phone_code": "+1",
    "phone_number": "9998887776"
  }
}

Documentation Index

Fetch the complete documentation index at: https://help-plum.xoxoday.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Send Points API Schema

PropertyTypeDescription
variables.recipients_data.sender_emailStringSuper Admin email sending the points.
variables.recipients_data.expiry_monthInt/StringExpiry of points in month.
variables.recipients_data.recipients[Recipient]List of recipient objects to whom balance will be sent.
variables.recipients_data.recipients[].to_nameStringRecipient’s full name.
variables.recipients_data.recipients[].to_emailStringRecipient’s email address.
variables.recipients_data.recipients[].amountStringAmount of balance/credits to be sent.
variables.recipients_data.recipients[].citationStringPurpose or reference note for the transaction.

​
Response Schema

PropertyTypeDescription
data.unique_idnumberUnique identifier of the transaction.
data.emailstringEmail address of the recipient (optional).
data.pointsnumberNumber of points to be credited or transferred.
data.namestringFull name of the recipient user.
data.phone_codestringCountry calling code of the recipient’s phone number.
data.phone_numberstringMobile number of the recipient user.

Authorizations

​
Authorization
string
header
required

Authorization: Bearer <access_token>

Body

application/json
​
query
enum<string>
default:storesAdmin.mutation.sendBalance
required

Always use storesAdmin.mutation.sendBalance.

Available options:
storesAdmin.mutation.sendBalance
​
tag
enum<string>
default:storeAdmin
required

Always use storeAdmin.

Available options:
storeAdmin
​
variables
object
required

Response

Points sent successfully.

​
data
object