Update the configuration on an addon subscription Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}
Close
PUT /api/v1/addon-subscriptions/{addonSubscription_uuid}
Personal access token & O auth2

This is also the only place an addon's data permissions (e.g. access to client documents) can currently be changed, so it doubles as the "permissions changed" audit event until a dedicated permissions model exists. Config holds credentials and account ids alongside anything permission-like, with nothing marking which is which, so the entry is tagged and titled as a configuration change rather than claiming a permission changed when someone only corrected a username.

Path parameters

  • addonSubscription_uuid string Required
application/json

Body

  • config object

    Configuration parameters dependant on type of addon.

    Additional properties are allowed.

Responses

  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • message string Required

      A human-readable description of the error.

    • errors object

      Validation messages keyed by the field that failed.

      Hide errors attribute Show errors attribute object
      • * array[string] Additional properties
PUT /api/v1/addon-subscriptions/{addonSubscription_uuid} 
curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/addon-subscriptions/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{
  "config": {
    "api_key": "example-api-key"
  }
}'
Request examples 
{
  "config": {
    "api_key": "example-api-key"
  }
}
Response examples (422) 
{
  "message": "The given data was invalid.",
  "errors": {
    "field": [
      "The field is invalid."
    ]
  }
}