Collectibles/Cards

Create Collectibles Campaign Order

post

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

Authorizations
Path parameters
campaignCollectiblesIdstringRequired

The unique identifier for the collectibles campaign

Example: campaign_456
Body
contactsstring · email[]Required

Recipients of the order as email addresses

Example: [email protected]
titlestringOptional

Optional title for the order

Example: Winter Collection Reward
descriptionstringOptional

Optional description for the order

Example: Reward for completing the challenge
Responses
201
Order created successfully
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?