Endpoint

POST /api/v1/<%= content_type.name.downcase.pluralize %>/<id>/references

Example call

• application_token string required

  The token for your application.

• authorization_token string required

  The authorization token for your user.

• id integer required

  The ID of the <%= content_type.name.downcase %> you're adding a reference to.

• reference_url url required

  The URL that this reference will link users to when they click it on Notebook.ai.

• reference_title string

  The title that should be displayed on Notebook.ai when this reference is displayed.

• reference_description string

  The description that should be shown next to this reference on Notebook.ai. Only used if reference_title is also given. Maximum of 300 characters; more than that will be truncated with an ellipses when displaying.

• reference_image url

  An image may optionally be included to display with references in some views when the design permits.

Example response

{ "id": 1, "name": "Some <%= content_type.name %>", <% unless content_type.name == Universe.name %> "universe_id": 2, <% end %> "meta": { "created_at": "2020-02-01 08:24:20 UTC", "updated_at": "2020-02-09 06:57:12 UTC" }, "categories": { "Overview": { "fields": [ { "id": 123, "label": "Description", "value": "Some Description" }, { "id": 124, "label": "Another Field", "value": "Some other value" }, ... ], }, ... }, "references": [ { "url": "https://www.example.com/something/wow", "title": "Reference name", "description": "This is something really cool on the Internet that this <%= content_type.name.downcase %> appears in!", "reference_image": "https://www.example.com/<%= content_type.name.downcase.pluralize %>/12345.png" } ] }