In this article
Add a New Subscription Type
Use this endpoint to add a new subscription type to the subscription service.
Upon creation, the listed subscriber will be granted owner permissions to the created type.
URL
https://{{HOST}}/subscriptiontype
Method
POST
Required IMS Scopes
- subscription_write
- apollo_write
Request Header Parameters
| Type | Value | Description |
|---|---|---|
| Authorization required |
Bearer {access_token} | IMS access token |
| Content-Type required |
application/json | Content Type |
Request Body Params
| Property | Description | Type |
|---|---|---|
| id | Identifier for Type | string |
Example
Request
curl -X POST
'https://{{HOST}}/subscriptiontype'
-H 'Content-Type: application/json'
-d '
{
"id": "d8178fd0-35ed-499e-89ad-d5b13f0d4427"
}
'
Response
{
"id": "d8178fd0-35ed-499e-89ad-d5b13f0d4427"
}
Errors
| Error | Description |
|---|---|
| 401 | Unauthorized |
| 403 | Forbiden. Possible causes: * You do not have access to this endpoint (scope) |
| 409 | Subscriber is already registered to this type |
| 504 | Timeout while attempting to write type to storage repository |
Response Body Parameters
| Name | Description | Schema |
|---|---|---|
| id | For the type object | string |