Do not miss any Thankly API changes, ever again

Subscribe to the Thankly API changelog to be up to date on recent changes.

RSS

about 2 hours ago

main
0.1.0
Compare

API structure has changed

Next change
39 structure changes including:
12 Additions
27 Modifications
Modified 27 Breaking
GET /v1/internal/tenants/{platform}/{org_slug}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sections property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • installations, csp properties Added
GET /v1/internal/tenants/{platform}/{org_slug}/{brand_slug}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sections property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • installations, csp properties Added
PATCH /v1/admin/orgs/{org_id}/partner-apps/{app_id}
  • Body
  • application/json content type Modified
    • sections property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • installations, csp properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sections, published_section_ids properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • installations, csp, published_installation_ids properties Added
POST /engage
  • Body
  • application/json content type Modified
    • callback, journey_day, overrides properties Added
  • Response
  • 202 response Modified
    • application/json content type Modified
      • decision_id property Added
POST /experiences
  • Body
  • application/json content type Modified
    • context property Modified
      • customer property Modified
        • membership_summary, benefits_gap, campaign_id, engagement_score properties Added
    • capabilities property Modified
      • property Modified
        • catalog_recommendations, engagement_decision alternatives Modified
POST /experiences/{experience_id}/capabilities
  • Body
  • application/json content type Modified
    • context property Modified
      • customer property Modified
        • membership_summary, benefits_gap, campaign_id, engagement_score properties Added
    • capabilities property Modified
      • property Modified
        • catalog_recommendations, engagement_decision alternatives Modified
POST /playbooks
  • Body
  • application/json content type Modified
    • pre_filter property Modified
      • * property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
    • capabilities_on_send property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • excluded_capabilities, content_ttl_seconds properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • capabilities_on_send property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • excluded_capabilities, content_ttl_seconds, quiet_hours, frequency_cap properties Added
POST /playbooks/{playbook_id}/rollback
  • Response
  • 200 response Modified
    • application/json content type Modified
      • capabilities_on_send property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • excluded_capabilities, content_ttl_seconds, quiet_hours, frequency_cap properties Added
POST /v1/admin/orgs/{org_id}/partner-apps
  • Body
  • application/json content type Modified
    • csp property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • sections, published_section_ids properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • installations, csp, published_installation_ids properties Added
POST /v1/admin/orgs/{org_id}/partner-apps/{app_id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sections, published_section_ids properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • installations, csp, published_installation_ids properties Added
POST /v1/admin/orgs/{org_id}/partner-apps/{app_id}/preview
  • Body
  • application/json content type Modified
    • sections property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • installations, csp properties Added
POST /v1/admin/orgs/{org_id}/partner-apps/{app_id}/preview-validation
  • Body
  • application/json content type Modified
    • sections property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • installations, csp properties Added
POST /v1/admin/orgs/{org_id}/partner-apps/{app_id}/publish
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sections, published_section_ids properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • installations, csp, published_installation_ids properties Added
POST /v1/admin/orgs/{org_id}/partner-apps/{app_id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sections, published_section_ids properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • installations, csp, published_installation_ids properties Added
POST /v1/admin/orgs/{org_id}/partner-apps/{app_id}/suspend
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sections, published_section_ids properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • installations, csp, published_installation_ids properties Added
POST /v1/admin/orgs/{org_id}/playbooks
  • Body
  • application/json content type Modified
    • pre_filter property Modified
      • * property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
    • capabilities_on_send property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • excluded_capabilities, content_ttl_seconds properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • capabilities_on_send property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • excluded_capabilities, content_ttl_seconds properties Added
POST /v1/admin/orgs/{org_id}/playbooks/{playbook_id}/rollback
  • Response
  • 200 response Modified
    • application/json content type Modified
      • capabilities_on_send property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • excluded_capabilities, content_ttl_seconds properties Added
POST /v1/internal/experiences/{capability}/invoke
  • Body
  • application/json content type Modified
    • section_context property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • installation_context property Added
PUT /playbooks/{playbook_id}
  • Body
  • application/json content type Modified
    • pre_filter property Modified
      • * property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
    • capabilities_on_send property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • excluded_capabilities, content_ttl_seconds, quiet_hours, frequency_cap properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • capabilities_on_send property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • excluded_capabilities, content_ttl_seconds, quiet_hours, frequency_cap properties Added
PUT /v1/admin/orgs/{org_id}/playbooks/{playbook_id}
  • Body
  • application/json content type Modified
    • pre_filter property Modified
      • * property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
    • capabilities_on_send property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • excluded_capabilities, content_ttl_seconds properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • capabilities_on_send property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • excluded_capabilities, content_ttl_seconds properties Added
GET /v1/admin/orgs/{org_id}/playbooks/{playbook_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • capabilities_on_send property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • excluded_capabilities, content_ttl_seconds properties Added
GET /v1/admin/orgs/{org_id}/playbooks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • playbooks property Modified
        • capabilities_on_send property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • excluded_capabilities, content_ttl_seconds properties Added
GET /v1/admin/orgs/{org_id}/partner-apps/{app_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sections, published_section_ids properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • installations, csp, published_installation_ids properties Added
GET /v1/admin/orgs/{org_id}/partner-apps
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sections, published_section_ids properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • installations, csp, published_installation_ids properties Added
GET /playbooks/{playbook_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • capabilities_on_send property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • excluded_capabilities, content_ttl_seconds, quiet_hours, frequency_cap properties Added
GET /playbooks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • playbooks property Modified
        • capabilities_on_send property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • excluded_capabilities, content_ttl_seconds, quiet_hours, frequency_cap properties Added
GET /customers/{external_customer_id}/profile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • summary property Added
Added 12
GET /brand-config
GET /brand-config/versions
GET /engage/decisions/{decision_id}
GET /v1/admin/orgs/{org_id}/brand-config
GET /v1/admin/orgs/{org_id}/brand-config/versions
POST /brand-config/rollback
POST /outcomes
POST /v1/admin/orgs/{org_id}/brand-config/rollback
POST /v1/admin/orgs/{org_id}/outcomes
POST /v1/internal/impressions/ingest
PUT /brand-config
PUT /v1/admin/orgs/{org_id}/brand-config