Create a Loop Link

Create a new Loop Link to begin submitting events and feedback.

Create a Loop Link

post

Authorizations

AuthorizationstringRequired

Enter your PredictHQ API key. The Bearer prefix is added automatically.

When calling the API directly, send: Authorization: Bearer <YOUR_API_KEY> as documented at https://docs.predicthq.com/api/overview/authenticating

Body

expire_dtstring · date-timeOptional

Date/time the Loop Link is set to expire in ISO 8601 format.

All dates are in UTC.

This is an optional field - omit if not needed.

E.g. 2023-05-08T00:29:45.859Z

namestring · min: 1 · max: 120Optional

Name of the Loop Link. This is for your own use as a way to differentiate your Loop Links.

E.g. Hotel ABC

Example: Hotel ABCPattern: ^[a-zA-Z0-9 _-]+$

Responses

201

Successful Response

application/json

link_idstringRequired

Loop Link Identifier.

E.g. ber7ntO0ZHuFVCfrSNsN

expire_dtstring · date-timeOptional

Date/time the Loop Link is set to expire in ISO 8601 format.

All dates are in UTC.

E.g. 2023-05-08T00:29:45.859Z

namestring · min: 1 · max: 120Required

Name of the Loop Link. This is for your own use as a way to differentiate your Loop Links.

E.g. Hotel ABC

Pattern: ^[a-zA-Z0-9 _-]+$

statusconst: activeRequired

Status of the loop link.

create_dtstring · date-timeRequired

Date/time the Loop Link was created in ISO 8601 format.

All dates are in UTC.

E.g. 2023-05-08T00:29:45.859Z

update_dtstring · date-timeOptional

Date/time the Loop Link was last updated in ISO 8601 format.

All dates are in UTC.

E.g. 2023-05-08T00:29:45.859Z

422

Validation Error

application/json

post/v1/loop/links

POST /v1/loop/links HTTP/1.1
Host: api.predicthq.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "expire_dt": "2026-01-01T00:00:00.000Z",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "name": "Hotel ABC"
}

{
  "link_id": "text",
  "expire_dt": "2026-01-01T00:00:00.000Z",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "name": "text",
  "status": "text",
  "create_dt": "2026-01-01T00:00:00.000Z",
  "update_dt": "2026-01-01T00:00:00.000Z",
  "links": {
    "event": "https://example.com",
    "event_feedback": "https://example.com"
  }
}

Examples

curl

curl -X POST "https://api.predicthq.com/v1/loop/links" \
     -H "Accept: application/json" \
     -H "Authorization: Bearer $API_TOKEN" \
     --data @<(cat <<EOF
    {
        "name": "Hotel A",
        "expire_dt": "2021-11-01T11:12:34",
        "metadata": {
            "hotel_id": "123456789"
        }
    }
    EOF
    )

python

import requests

response = requests.post(
    url="https://api.predicthq.com/v1/loop/links",
    headers={
        "Authorization": "Bearer $API_TOKEN",
        "Accept": "application/json"
    },
    json={
        "name": "Hotel A",
        "expire_dt": "2021-11-01T11:12:34",
        "metadata": {
            "hotel_id": "123456789"
        }
    }
)

print(response.json())

OpenAPI Spec

The OpenAPI spec for Loop API can be found here.

Guides

Below are some guides relevant to this API:

• Integrate with Loop Links