Tokens/Points

Create Points Campaign Order

post

Creates a new order for a points campaign. This endpoint is used when you want to award specific points to recipients.

Authorizations

ApiKeyAuth

x-gft_api_keystringRequired

API key for authentication (can also use x-gft-api-key or gft-api-key)

Path parameters

campaignPointsIdstringRequired

The unique identifier for the points campaign

Example: campaign_456

Body

application/json

contactsstring · email[]Required

Recipients of the order as email addresses

Example: [email protected]

titlestringOptional

Optional title for the order

Example: Gold Points Reward

descriptionstringOptional

Optional description for the order

Example: Reward for completing the survey

Responses

201

Order created successfully

application/json

Response from creating an order

orderIdstringOptional

Unique identifier for the created order

Example: order_12345

statusstring · enumOptional

Current status of the order

Example: createdPossible values:

400

Bad Request - Missing or invalid parameters

application/json

401

Unauthorized - API key is missing or invalid

application/json

404

Campaign not found

application/json

post

/gcm/reseller/campaign/{campaignPointsId}/order

HTTPcURLJavaScriptPython

POST /api/v1/gcm/reseller/campaign/{campaignPointsId}/order HTTP/1.1
Host: api.giftoin.org
x-gft_api_key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 304

{
  "contacts": [
    "[email protected]"
  ],
  "thirdPartyUserIds": [
    {
      "type": "discord",
      "id": "123456789012345678"
    }
  ],
  "title": "Gold Points Reward",
  "description": "Reward for completing the survey",
  "items": {
    "points": [
      {
        "id": "point_789",
        "quantity": 100
      }
    ]
  },
  "metadata": {
    "source": "winter_promotion",
    "department": "marketing"
  }
}

{
  "orderId": "order_12345",
  "status": "created"
}

API Reference Notice

We are currently experiencing a technical issue with the API reference display in GitBook. For the most accurate and complete API documentation, please refer to our official API reference on Postman.

We apologize for any inconvenience and are working to resolve this issue. Thank you for your understanding.