Collectibles/Cards
Creates a new order for a collectibles campaign. This endpoint is used when you want to award specific collectibles to recipients.
Authorizations
Path parameters
campaignCollectiblesIdstringRequiredExample:
The unique identifier for the collectibles campaign
campaign_456
Body
contactsstring · email[]RequiredExample:
Recipients of the order as email addresses
[email protected]
titlestringOptionalExample:
Optional title for the order
Winter Collection Reward
descriptionstringOptionalExample:
Optional description for the order
Reward for completing the challenge
Responses
201
Order created successfully
application/json
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
POST /api/v1/gcm/reseller/campaign/{campaignCollectiblesId}/order HTTP/1.1
Host: api.giftoin.org
x-gft_api_key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 258
{
"contacts": [
"[email protected]"
],
"thirdPartyUserIds": [
{
"type": "discord",
"id": "123456789012345678"
}
],
"title": "Winter Collection Reward",
"description": "Reward for completing the challenge",
"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.
Last updated
Was this helpful?