Subscribe to an addon

POST /api/v1/subscribe

Headers

application/json

Body Required

  • addon_id string Required

    Unique identifier of the addon to subscribe to

  • config array[string]

    Configuration parameters dependant on type of addon

  • enabled boolean Required

    If the addon should start enabled

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • enabled string

      Determines if the addon is enabled

    • addon object

      Details about the addon subscribed to

      Additional properties are allowed.
POST /api/v1/subscribe 
curl \
 -X POST https://api.plannrcrm.com/api/v1/subscribe \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"addon_id":"transact_valuation_feed","config":[{"api_key":"apikey123"}],"enabled":true}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "addon_id": "transact_valuation_feed",
  "config": [
    {
      "api_key": "apikey123"
    }
  ],
  "enabled": true
}
Response examples (200) 
{
  "uuid": "74231fd7-e4a2-4603-b84f-2371b59b4019",
  "addon": {
    "id": "transact_valuation_feed",
    "name": "Transact Valuation Feed",
    "price": {
      "amount": {
        "example": "4000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£40.00",
        "description": "Money amount formatted with currency"
      }
    },
    "params": {
      "pin": {
        "type": "text",
        "inputs": [],
        "example": "secret-password-123",
        "options": [],
        "required": false,
        "list_type": null,
        "description": "TRDS Password (Not Your Transact Password)"
      },
      "third_pin": {
        "type": "text",
        "inputs": [],
        "example": "secret-password-123",
        "options": [],
        "required": false,
        "list_type": null,
        "description": "Third TRDS Password (Not Your Transact Password)"
      },
      "second_pin": {
        "type": "text",
        "inputs": [],
        "example": "secret-password-123",
        "options": [],
        "required": false,
        "list_type": null,
        "description": "Second TRDS Password (Not Your Transact Password)"
      },
      "access_code": {
        "type": "text",
        "inputs": [],
        "example": "555-123-456",
        "options": [],
        "required": false,
        "list_type": null,
        "description": "Transact Number"
      },
      "third_access_code": {
        "type": "text",
        "inputs": [],
        "example": "555-123-456",
        "options": [],
        "required": false,
        "list_type": null,
        "description": "Third Transact Number"
      },
      "second_access_code": {
        "type": "text",
        "inputs": [],
        "example": "555-123-456",
        "options": [],
        "required": false,
        "list_type": null,
        "description": "Second Transact Number"
      }
    },
    "category": "valuation_feed_integration",
    "icon_url": "https://plannrcrm.com/icon.png",
    "banner_url": "https://plannrcrm.com/banner.png",
    "is_visible": true,
    "description": "Provides an automatic holding and valuation feed via a transact integration",
    "setup_instructions": "Retrieve your transact api key from https://www.transact-online.co.uk/contact-us/",
    "can_be_subscribed_to": true
  },
  "enabled": "true",
  "created_at": "2024-11-20T13:24:04+00:00",
  "updated_at": "2024-11-20T13:24:04+00:00"
}