Create order

Places an order for one or more rewards.

Email Rewards

Orders are delivered via Giftbit email by default, and at least one valid contacts entry is required.

Shortlnk Rewards

Optionally, you can set delivery_type: SHORTLINK to create shortlink rewards that don’t require any contacts. Shortlink rewards use the same endpoint, return the same order object, but generate links you can distribute yourself. When using delivery_type: SHORTLINK include a link_count to specify the number of rewards to create.

Order Configuration

The use of gift_template is optional, but all required parameters must be specified in the API call, or set in the template.

Include the optional expiry parameter to create a promotional reward with a limited claim period.

If you do not specify delivery_type, the request defaults to an email reward delivered by Giftbit.

POST /campaign

cURL

email

curl --request POST \
  --url https://api-testbed.giftbit.com/papi/v1/campaign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "gift_template": "XDKHE",
  "contacts": [
    {
      "firstname": "Perry",
      "lastname": "Johnson",
      "email": "[e-mail]"
    },
    {
      "firstname": "Rita",
      "lastname": "Robson",
      "email": "[e-mail]"
    }
  ],
  "price_in_cents": 5000,
  "brand_codes": [
    "itunesus",
    "amazonus"
  ],
  "expiry": "2018-11-01",
  "id": "clientProvidedGiftId_abc123"
}
'

200

{
  "info": {
    "code": "INFO_CAMPAIGN_CREATED",
    "name": "Campaign Created",
    "message": "Campaign creation has begun."
  },
  "status": 200,
  "campaign": {
    "company_name": "Company Name",
    "message": "Thanks for being such an awesome customer!",
    "subject": "Please enjoy this reward!",
    "contacts": [
      {
        "email": "[e-mail]",
        "firstname": "Perry",
        "added_successfully": true,
        "lastname": "Johnson",
        "message": "Contact ready"
      }
    ],
    "price_in_cents": 5000,
    "brand_codes": [
      "itunesus",
      "amazonus"
    ],
    "status": "API_CREATING",
    "uuid": "9a405b513c11413aaac593a0c2e1a15d",
    "suppress_default_greeting": false,
    "delivery_type": "GIFTBIT_EMAIL",
    "expiry": "2017-05-01",
    "contacts_success_count": 2,
    "contacts_failure_count": 0,
    "gift_template": "XDKHE",
    "id": "clientProvidedGiftId_abc123"
  }
}

Authorizations

Authorization · string · header · required

Send your API token prefixed by Bearer in the Authorization header.

Body

application/json

price_in_cents · integer · required

The value of the offer in cents.

id · string · required

A unique client-assigned identifier for the order. Idempotent on retry.

message · string

Reward email message. Required if no supplied template.

subject · string

Reward email subject. Required if no supplied template.

gift_template · string

The template id used for this order.

contacts · object[]

A list of contact objects. Required for email delivery.

Show child attributes

brand_codes · string[]

Custom list of one or more brand_code. Not applicable to Full Catalog choice.

region · string

Region for the Full Catalog from which recipients select a brand.

delivery_type · enum<string>

Optional. Defaults to email delivery. Set to SHORTLINK to create shortlink rewards from this same /campaign endpoint instead of having Giftbit deliver the reward by email.

Available options: GIFTBIT_EMAIL, SHORTLINK

link_count · integer

Optional. For shortlink orders, the number of reward links to generate. Include this when delivery_type is SHORTLINK.

expiry · string

The order's claim-before date (YYYY-MM-dd). May not exceed one year from creation.

Response

200

application/json

Order creation has begun.

info · object

Status information returned on successful requests.

Show child attributes

status · integer

campaign · object

An order object.

Show child attributes