Skip to main content
POST
/
v1
/
subscriptions
Create subscription
curl --request POST \
  --url https://api.pointset.io/v1/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "city": "London",
  "entity_type": "restaurant",
  "fields": [
    "phone",
    "rating",
    "website"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "city": "London",
  "entity_type": "restaurant",
  "fields": [
    "phone",
    "rating",
    "website"
  ],
  "status": "active",
  "data_status": "<string>",
  "field_assessments": {},
  "created_at": "<string>",
  "updated_at": "<string>",
  "cancelled_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
city
string
required
Minimum string length: 1
Example:

"London"

​
entity_type
string
required
Minimum string length: 1
Example:

"restaurant"

​
fields
string[]
required
Minimum array length: 1
Minimum string length: 1
Example:
["phone", "rating", "website"]

Response

Created

​
id
string<uuid>
required
​
account_id
string<uuid>
required
​
city
string
required
Example:

"London"

​
entity_type
string
required
Example:

"restaurant"

​
fields
string[]
required
Example:
["phone", "rating", "website"]
​
status
enum<string>
required
Available options:
active,
paused,
cancelled
Example:

"active"

​
data_status
string
required
​
field_assessments
object
required
​
created_at
string
required
​
updated_at
string
required
​
cancelled_at
string | null
required