Sponsorship JSON Schema

To request a collection of sponsorships use the URL path "/sponsorships.json".

To request a single sponsorship use the URL path "/sponsorships/< permalink >.json.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Sponsorship",
  "description": "A sponsorship object from REACH",
  "type": "object",
  "properties": {
    "title": {
      "description": "Returns the title of the sponsorship.",
      "type": "string"
    },
    "permalink": {
      "description": "Returns the permalink of the sponsorship.",
      "type": "string"
    },
    "url": {
      "description": "Returns the relative URL of the sponsorship.",
      "type": "string"
    },
    "full_url": {
      "description": " Returns the full URL with domain name of the sponsorship.",
      "type": "string"
    },
    "description": {
      "description": "Returns the description of the sponsorship.",
      "type": "string"
    },
    "external_reference_id": {
      "description": "Returns the external refernce ID of the sponsorship.",
      "type": "string"
    },
    "disable": {
      "description": "Returns a true/false value for whether the sponsorship is disabled.",
      "type": "boolean"
    },
    "position": {
      "description": "Returns the position of the sponsorship.",
      "type": "integer"
    },
    "current_shares": {
      "description": "Returns the number of shares currently sponsored for the sponsorship.",
      "type": "integer"
    },
    "shares_available": {
      "description": "Returns the number of shares available for sponsorship.",
      "type": "integer"
    },
    "total_shares": {
      "description": "Returns the maximum number of shares designated by the sponsorship type.",
      "type": "integer"
    },
    "images": {
      "type": "object",
      "items": {
        "thumbnail": "string",
        "small": "string",
        "medium": "string",
        "large": "string",
        "original": "string"
      }
    }
  }
}

Feedback and Knowledge Base