Tokens/Points

Create Points Campaign Order

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

post

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

Authorizations

Path parameters

campaignPointsIdstringrequired

The unique identifier for the points campaign

Example: campaign_456

Body

titlestring

Optional title for the order

Example: Gold Points Reward

descriptionstring

Optional description for the order

Example: Reward for completing the survey

metadataobject

The 'metadata' field allows you to store up to 10 custom key-value pairs with the order. This is useful for tracking information like order source, internal reference IDs, department codes, or any other custom attributes needed for integration with your systems.

Example: {"source":"winter_promotion","department":"marketing"}

contactsstring · email[]required

thirdPartyUserIdsobject[]

Third-party user identification information

itemsobjectrequired

Points to include in the order

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.giftoin.org/api/v1/gcm/reseller/campaign/{campaignPointsId}/order' \
  --header 'x-gft_api_key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Gold Points Reward",
    "description": "Reward for completing the survey",
    "metadata": {
      "source": "winter_promotion",
      "department": "marketing"
    },
    "contacts": [
      "[e-mail]"
    ],
    "thirdPartyUserIds": [
      {
        "type": "discord",
        "id": "123456789012345678"
      }
    ],
    "items": {
      "points": [
        {
          "id": "point_789",
          "quantity": 100
        }
      ]
    }
  }'

201

400

401

404

201

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

Order created successfully

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.