Skip to content
Frontier Platform Integration - FOR INTERNAL USE ONLY

DOCUMENTATION FOR INTERNAL USE ONLY

Create/Update Subscription

PUT
/subscription/{subscription_id}

Updates a subscription by ID, if the subscription doesn’t exist it is created

Parameters

Path Parameters

subscription_id
required
string

Request Body required

object
subscription_detail
required

List of subscription details

Array<object>
object
organisation
required

Organisation you would like to subscribe to

string
<= 50 characters
entityType
Any of:
string
<= 50 characters
product
Any of:
string
<= 50 characters
method

Optional methods to only subscribe to be notified of add update and delete

string
default: All
Allowed values: Read Update Delete All
webhook
Any of:
string

Responses

200

Successful Response

object
meta

A meta object that contains non-standard meta-information

object
key
additional properties
string
data

The document’s ‘primary data’.

object
id
required

Unique ID of the Entity

string
type
required

Type of entity

string
version
Any of:
string
attributes

This contains a data blob of the entity, this is where the main payload of data is

object
links

Links to any relevant information or entities

object
self
required

Link to the current resource.

string
related

Link of a related resource.

string
describedBy

Link to API documentation for that resource.

string
meta

Additional information about the entity which isn’t provided in the main data blob

object
key
additional properties
string
links

A links object related to the primary data

object
self
required

Link to the current resource.

string
related

Link of a related resource.

string
describedBy

Link to API documentation for that resource.

string

400

Bad request. Data not valid

401

Unauthorized access, credentials are invalid.

403

Forbidden access, this is returned when you do not have sufficient permissions to access the resource

422

Unprocessable entity

429

Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again.

500

Unexpected internal error, could not process request

503

The API is currently unavailable, please try again later

504

A request timed out while processing, please try again; if it persists try reducing the payload size.