{"componentChunkName":"component---src-templates-api-js","path":"/api/inline-seeds/","result":{"data":{"allApiBlueprint":{"edges":[{"node":{"meta":{"title":"A/B Testing API","label":"New"},"fields":{"path":"/api/ab-testing/","file":"ab-testing.apib"}}},{"node":{"meta":{"title":"Data Privacy API","label":"New"},"fields":{"path":"/api/data-privacy/","file":"data-privacy.apib"}}},{"node":{"meta":{"title":"Events API","label":null},"fields":{"path":"/api/events/","file":"events.apib"}}},{"node":{"meta":{"title":"Ingest API","label":"Private Access"},"fields":{"path":"/api/events-ingest/","file":"events-ingest.apib"}}},{"node":{"meta":{"title":"Inbound Domains API","label":null},"fields":{"path":"/api/inbound-domains/","file":"inbound-domains.apib"}}},{"node":{"meta":{"title":"Account API","label":null},"fields":{"path":"/api/account/","file":"account.apib"}}},{"node":{"meta":{"title":"API Overview","label":null},"fields":{"path":"/api/","file":"index.apib"}}},{"node":{"meta":{"title":"Automatic Inline Seeding","label":"Deliverability"},"fields":{"path":"/api/inline-seeds/","file":"inline-seeds.apib"}}},{"node":{"meta":{"title":"Labs APIs","label":null},"fields":{"path":"/api/labs/","file":"labs.apib"}}},{"node":{"meta":{"title":"Message Events API","label":null},"fields":{"path":"/api/message-events/","file":"message-events.apib"}}},{"node":{"meta":{"title":"Recipient Validation API","label":"New"},"fields":{"path":"/api/recipient-validation/","file":"recipient-validation.apib"}}},{"node":{"meta":{"title":"IP Pools API","label":null},"fields":{"path":"/api/ip-pools/","file":"ip-pools.apib"}}},{"node":{"meta":{"title":"Seed List API","label":"Deliverability"},"fields":{"path":"/api/seed-list/","file":"seed-list.apib"}}},{"node":{"meta":{"title":"Bounce Domains API","label":null},"fields":{"path":"/api/bounce-domains/","file":"bounce-domains.apib"}}},{"node":{"meta":{"title":"Recipient Lists API","label":null},"fields":{"path":"/api/recipient-lists/","file":"recipient-lists.apib"}}},{"node":{"meta":{"title":"Sending IPs API","label":null},"fields":{"path":"/api/sending-ips/","file":"sending-ips.apib"}}},{"node":{"meta":{"title":"Relay Webhooks API","label":null},"fields":{"path":"/api/relay-webhooks/","file":"relay-webhooks.apib"}}},{"node":{"meta":{"title":"SMTP API","label":null},"fields":{"path":"/api/smtp/","file":"smtp.apib"}}},{"node":{"meta":{"title":"Snippets API","label":"New"},"fields":{"path":"/api/snippets/","file":"snippets.apib"}}},{"node":{"meta":{"title":"Subaccounts API","label":null},"fields":{"path":"/api/subaccounts/","file":"subaccounts.apib"}}},{"node":{"meta":{"title":"Sending Domains API","label":null},"fields":{"path":"/api/sending-domains/","file":"sending-domains.apib"}}},{"node":{"meta":{"title":"Suppression List API","label":null},"fields":{"path":"/api/suppression-list/","file":"suppression-list.apib"}}},{"node":{"meta":{"title":"Template Language","label":null},"fields":{"path":"/api/template-language/","file":"template-language.apib"}}},{"node":{"meta":{"title":"Tracking Domains API","label":null},"fields":{"path":"/api/tracking-domains/","file":"tracking-domains.apib"}}},{"node":{"meta":{"title":"Templates API","label":null},"fields":{"path":"/api/templates/","file":"templates.apib"}}},{"node":{"meta":{"title":"Transmissions API","label":null},"fields":{"path":"/api/transmissions/","file":"transmissions.apib"}}},{"node":{"meta":{"title":"Event Webhooks API","label":null},"fields":{"path":"/api/webhooks/","file":"webhooks.apib"}}},{"node":{"meta":{"title":"Usage API","label":null},"fields":{"path":"/api/usage/","file":"usage.apib"}}},{"node":{"meta":{"title":"Metrics API","label":null},"fields":{"path":"/api/metrics/","file":"metrics.apib"}}}]},"apiBlueprint":{"ast":{"element":"parseResult","content":[{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"api"}]},"title":{"element":"string","content":""}},"attributes":{"meta":{"element":"array","content":[{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"FORMAT"},"value":{"element":"string","content":"1A"}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"title"},"value":{"element":"string","content":"Automatic Inline Seeding"}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string","content":"Accept campaign stats, sanitize PII, and trigger seed messages."}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"label"},"value":{"element":"string","content":"Deliverability"}}}]}},"content":[{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"resourceGroup"}]},"title":{"element":"string","content":"Automatic Inline Seeding API"}},"content":[{"element":"copy","content":"The Automatic Inline Seeding API helps customers automatically send messages from their campaigns to seed addresses. This document is for customers that are sending with SparkPost.\n\n## Seed Config\n\nSeeding options that will apply to campaigns that match the provided rules.\n\n<DataStructure id=\"1ef76675846918f9c7d0611e046d5056\"  title=\"Attributes\" ></DataStructure>"},{"element":"resource","meta":{"title":{"element":"string","content":"Get Seed Config"}},"attributes":{"href":{"element":"string","content":"/v1/inline-seeds/config"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Get Seed Config"}},"attributes":{"href":{"element":"string","content":"/v1/inline-seeds/config"}},"content":[{"element":"copy","content":"Returns config details for the authenticated account.\nOnly one seed config with 5 match/exclude rules max is currently supported.\nOne or the other of (match, exclude) may be used, not both.\nAuth context (from API key) provides customer and subaccount IDs."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"X-MSYS-SUBACCOUNT"},"value":{"element":"string","content":"1"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"{\n  \"results\": {}\n}\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"X-MSYS-SUBACCOUNT"},"value":{"element":"string","content":"1"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"{\n  \"results\": {\n    \"configs\": [\n      {\n        \"threshold\": 1000,\n        \"duration\": 20,\n        \"reset\": 24,\n        \"match\": [\n          \"my-campaign\",\n          \"my-*\"\n        ]\n      }\n    ]\n  }\n}\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Create Seed Config"}},"attributes":{"href":{"element":"string","content":"/v1/inline-seeds/config"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Create Seed Config"}},"attributes":{"href":{"element":"string","content":"/v1/inline-seeds/config"}},"content":[{"element":"copy","content":"Create seed config for the authenticated account."},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"Create a seed config with match rule"}},"attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"X-MSYS-SUBACCOUNT"},"value":{"element":"string","content":"1"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"{\n  \"threshold\": 1000,\n  \"duration\": 20,\n  \"reset\": 24,\n  \"match\": [\n    \"my-*\"\n  ]\n}\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"{\n  \"results\": {\n    \"threshold\": 1000,\n    \"duration\": 20,\n    \"reset\": 24,\n    \"match\": [\n      \"my-*\"\n    ],\n    \"exclude\": []\n  }\n}\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"Both Match and Exclude rule not specified"}},"attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"X-MSYS-SUBACCOUNT"},"value":{"element":"string","content":"1"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"{\n  \"threshold\": 1000,\n  \"duration\": 20,\n  \"reset\": 24\n}\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"422"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"{\n    \"errors\": [\n        {\n            \"message\": \"Either match or exclude has to be specified\"\n        }\n    ]\n}\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Update Seed Config"}},"attributes":{"href":{"element":"string","content":"/v1/inline-seeds/config"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Update Seed Config"}},"attributes":{"href":{"element":"string","content":"/v1/inline-seeds/config"}},"content":[{"element":"copy","content":"Make updates to config details for the authenticated account.\nOnly one seed config with 5 match/exclude rules max is currently supported.\nAuth context (from API key) provides customer and subaccount IDs."},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"Remove redundant rule"}},"attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"X-MSYS-SUBACCOUNT"},"value":{"element":"string","content":"1"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"{\n  \"threshold\": 1000,\n  \"duration\": 20,\n  \"reset\": 24,\n  \"match\": [\n    \"my-*\"\n  ]\n}\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"{\n  \"results\": {\n    \"threshold\": 1000,\n    \"duration\": 20,\n    \"reset\": 24,\n    \"match\": [\n      \"my-*\"\n    ],\n    \"exclude\": []\n  }\n}\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"Too many matches"}},"attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"X-MSYS-SUBACCOUNT"},"value":{"element":"string","content":"1"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"{\n  \"threshold\": 1000,\n  \"duration\": 20,\n  \"reset\": 24,\n  \"match\": [\n    \"fred-*\",\n    \"wilma-*\",\n    \"pebbles-*\",\n    \"barney-*\",\n    \"betty-*\",\n    \"bam-bam-*\"\n  ]\n}\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"422"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"{\n    \"errors\": [\n        {\n            \"message\": \"Match rule limit exceeded (found 6, max is 5)\"\n        }\n    ]\n}\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"Both match and exclude"}},"attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"X-MSYS-SUBACCOUNT"},"value":{"element":"string","content":"1"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"{\n  \"threshold\": 1000,\n  \"duration\": 20,\n  \"reset\": 24,\n  \"match\": [\n    \"fred-*\",\n    \"wilma-*\"\n  ],\n  \"exclude\": [\n    \"barney-*\",\n    \"betty-*\"\n  ]\n}\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"422"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"{\n    \"errors\": [\n        {\n            \"message\": \"Incompatible rule type combination: 'match' and 'exclude' are mutually exclusive.\"\n        }\n    ]\n}\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"List Active Campaigns"}},"attributes":{"href":{"element":"string","content":"/v1/inline-seeds/status"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"List Active Campaigns"}},"attributes":{"href":{"element":"string","content":"/v1/inline-seeds/status"}},"content":[{"element":"copy","content":"Returns read-only list of seed-eligible campaigns that have recent activity.\nIntended use case is informational - checking status via API or UI.\nSet the X-MSYS-SUBACCOUNT header to get campaigns for a specific subaccount\n(set the header to 0 to get campaigns for the primary account).\nDo not set the X-MSYS-SUBACCOUNT header to get campaigns for the primary\naccount and all subaccounts."},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"Get campaigns for primary account and subaccounts"}},"attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"X-MSYS-SUBACCOUNT"},"value":{"element":"string","content":"1"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"{\n  \"results\": [\n    {\n      \"campaign\": \"my_campaign\",\n      \"sending_domain\": \"foo.example.com\",\n      \"count\": 1256,\n      \"threshold\": 1256,\n      \"seed_start\": 1620078946682,\n      \"duration\": 30\n    },\n    {\n      \"campaign\": \"second_campaign\",\n      \"sending_domain\": \"bar.example.com\",\n      \"count\": 1337,\n      \"threshold\": 5000,\n      \"seed_start\": null,\n      \"duration\": 30,\n      \"subaccount_id\": 123\n    }\n  ]\n}\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Check Campaign Status"}},"attributes":{"href":{"element":"string","content":"/v1/inline-seeds/status?id=my_campaign&sending_domain=foo.example.com"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Check Campaign Status"}},"attributes":{"href":{"element":"string","content":"/v1/inline-seeds/status?id=my_campaign&sending_domain=foo.example.com"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string","content":"my-campaign"}}},{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"sending_domain"},"value":{"element":"string","content":"foo.example.com"}}}]}},"content":[{"element":"copy","content":"Returns read-only campaign metadata.\nAuth context (from API key) provides customer and subaccount IDs."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"X-MSYS-SUBACCOUNT"},"value":{"element":"string","content":"1"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"{\n  \"results\": {\n    \"campaign\": \"my_campaign\",\n    \"sending_domain\": \"foo.example.com\",\n    \"count\": 1256,\n    \"threshold\": 1256,\n    \"seed_start\": 1620078946682,\n    \"duration\": 30\n  }\n}\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"X-MSYS-SUBACCOUNT"},"value":{"element":"string","content":"1"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"{\n  \"results\": {\n    \"campaign\": \"my_campaign\",\n    \"sending_domain\": \"foo.example.com\",\n    \"count\": 1256,\n    \"threshold\": 1256,\n    \"seed_start\": 1620078946682,\n    \"duration\": 30,\n    \"subaccount_id\": 123\n  }\n}\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"X-MSYS-SUBACCOUNT"},"value":{"element":"string","content":"1"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"404"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"{\n    \"errors\": [\n        {\n            \"message\": \"Resource could not be found\"\n        }\n    ]\n}\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Get Options"}},"attributes":{"href":{"element":"string","content":"/v1/inline-seeds/options"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Get Options"}},"attributes":{"href":{"element":"string","content":"/v1/inline-seeds/options"}},"content":[{"element":"copy","content":"Returns Inline Seeds options.  \nIf no subaccount ID is provided via the X-MSYS-SUBACCOUNT header this will return the primary account and all subaccount options.  \nIf a subaccount ID is provided this will return the subaccount's options.\n\n<DataStructure id=\"e205ece99f55a2bb7cb44d3e68fa339f\"  title=\"Attributes\" ></DataStructure>\n\nIf `enabled` is false Automatic Inline Seeding is currently paused. If set back to true a campaign will resume from its previous state unless it has reached the 24 hour timeout window and been reset. This will not interrupt a campaign that has already begun seeding.\n\nA user can turn off Automatic Inline Seeding for all subaccounts (including the primary account) by setting the account level option \"inline_seeds\" to false via the [Account API](/api/account). The Account-level option supercedes the API-level option."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"X-MSYS-SUBACCOUNT"},"value":{"element":"string","content":"1"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"{\n  \"results\": {\n    \"enabled\": true\n  }\n}\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"{\n  \"results\": [\n    {\n      \"enabled\": true\n    },\n    {\n      \"subaccount_id\": 1,\n      \"enabled\": false\n    }\n  ]\n}\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Update Options"}},"attributes":{"href":{"element":"string","content":"/v1/inline-seeds/options"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Update Options"}},"attributes":{"href":{"element":"string","content":"/v1/inline-seeds/options"}},"content":[{"element":"copy","content":"Make updates to options for the authenticated account.\nIf no subaccount ID is provided via the X-MSYS-SUBACCOUNT header this will update the primary account's options."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"-"},"value":{"element":"string","content":"Authorization: 14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"-"},"value":{"element":"string","content":"X-MSYS-SUBACCOUNT: 1"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"{\n    \"enabled\": false\n}\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"204"}}}]}]}]}]},{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"dataStructures"}]}},"content":[{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"1ef76675846918f9c7d0611e046d5056"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Number of messages seen for a campaign before seed sending starts. <br /> Maximum: `1,000,000`<br /> Minimum: `1,000`"}},"content":{"key":{"element":"string","content":"threshold"},"value":{"element":"number","attributes":{"default":{"element":"number","content":10000}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Number of minutes after threshold is met over which to spread out seed messages. <br /> Maximum: `720` (12 hours)<br /> Minimum: `20`"}},"content":{"key":{"element":"string","content":"duration"},"value":{"element":"number","attributes":{"default":{"element":"number","content":30}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Number of hours after threshold is met until seed sending can happen again. <br /> Maximum: `168` (7 days) <br /> Minimum: `22`"}},"content":{"key":{"element":"string","content":"reset"},"value":{"element":"number","attributes":{"default":{"element":"number","content":24}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Array of Campaign IDs or prefixes that are eligible. Strings ending with an asterisk are treated as prefixes. <br /> Maximum: `5` entries."}},"content":{"key":{"element":"string","content":"match"},"value":{"element":"array"}}},{"element":"member","meta":{"description":{"element":"string","content":"Array of Campaign IDs or prefixes that are NOT eligible. Strings ending with an asterisk are treated as prefixes. <br /> Maximum: `5` entries."}},"content":{"key":{"element":"string","content":"exclude"},"value":{"element":"array"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"e205ece99f55a2bb7cb44d3e68fa339f"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Whether Automatic Inline Seeding is enabled or not."}},"content":{"key":{"element":"string","content":"enabled"},"value":{"element":"boolean","attributes":{"default":{"element":"boolean","content":false}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether Automatic Inline Seeding is enabled for all subaccounts (including the primary account). Only returned when false and fetching a specific subaccount's options."}},"content":{"key":{"element":"string","content":"account_enabled"},"value":{"element":"boolean","attributes":{"default":{"element":"boolean","content":false}}}}}]}}]}]},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":894},{"element":"number","content":58}]},{"element":"array","content":[{"element":"number","content":960},{"element":"number","content":23}]}]}]}},"content":"headers is expected to be a pre-formatted code block, every of its line indented by exactly 12 spaces or 3 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":3},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":986},{"element":"number","content":56}]}]}]}},"content":"unable to parse response signature, expected 'response [<HTTP status code>] [(<media type>)]'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":986},{"element":"number","content":56}]}]}]}},"content":"missing response HTTP status code, assuming 'Response 200'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":3},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":1132},{"element":"number","content":56}]}]}]}},"content":"unable to parse response signature, expected 'response [<HTTP status code>] [(<media type>)]'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":1132},{"element":"number","content":56}]}]}]}},"content":"missing response HTTP status code, assuming 'Response 200'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":1130},{"element":"number","content":422}]}]}]}},"content":"response payload `200` already defined for `GET` method"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":1752},{"element":"number","content":58}]},{"element":"array","content":[{"element":"number","content":1818},{"element":"number","content":23}]}]}]}},"content":"headers is expected to be a pre-formatted code block, every of its line indented by exactly 12 spaces or 3 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":2419},{"element":"number","content":58}]},{"element":"array","content":[{"element":"number","content":2485},{"element":"number","content":23}]}]}]}},"content":"headers is expected to be a pre-formatted code block, every of its line indented by exactly 12 spaces or 3 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":1552},{"element":"number","content":55}]}]}]}},"content":"the resource '/v1/inline-seeds/config' is already defined"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":3238},{"element":"number","content":58}]},{"element":"array","content":[{"element":"number","content":3304},{"element":"number","content":23}]}]}]}},"content":"headers is expected to be a pre-formatted code block, every of its line indented by exactly 12 spaces or 3 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":3880},{"element":"number","content":58}]},{"element":"array","content":[{"element":"number","content":3946},{"element":"number","content":23}]}]}]}},"content":"headers is expected to be a pre-formatted code block, every of its line indented by exactly 12 spaces or 3 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":4618},{"element":"number","content":58}]},{"element":"array","content":[{"element":"number","content":4684},{"element":"number","content":23}]}]}]}},"content":"headers is expected to be a pre-formatted code block, every of its line indented by exactly 12 spaces or 3 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":2900},{"element":"number","content":54}]}]}]}},"content":"the resource '/v1/inline-seeds/config' is already defined"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":5830},{"element":"number","content":58}]},{"element":"array","content":[{"element":"number","content":5896},{"element":"number","content":23}]}]}]}},"content":"headers is expected to be a pre-formatted code block, every of its line indented by exactly 12 spaces or 3 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":6963},{"element":"number","content":58}]},{"element":"array","content":[{"element":"number","content":7029},{"element":"number","content":23}]}]}]}},"content":"headers is expected to be a pre-formatted code block, every of its line indented by exactly 12 spaces or 3 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":7401},{"element":"number","content":382}]}]}]}},"content":"response payload `200` already defined for `GET` method"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":8},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":6595},{"element":"number","content":103}]}]}]}},"content":"parameter 'id' is not found within the URI template '/v1/inline-seeds/status?id=my_campaign&sending_domain=foo.example.com' for 'Check Campaign Status' "},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":8},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":6595},{"element":"number","content":103}]}]}]}},"content":"parameter 'sending_domain' is not found within the URI template '/v1/inline-seeds/status?id=my_campaign&sending_domain=foo.example.com' for 'Check Campaign Status' "},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":5},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":9259},{"element":"number","content":31}]}]}]}},"content":"ignoring unrecognized block"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":9997},{"element":"number","content":60}]}]}]}},"content":"headers is expected to be a pre-formatted code block, every of its line indented by exactly 12 spaces or 3 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":13},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":9997},{"element":"number","content":59}]}]}]}},"content":"missing colon after header name '-'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":10065},{"element":"number","content":25}]}]}]}},"content":"headers is expected to be a pre-formatted code block, every of its line indented by exactly 12 spaces or 3 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":13},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":10065},{"element":"number","content":24}]}]}]}},"content":"missing colon after header name '-'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":13},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":10065},{"element":"number","content":24}]}]}]}},"content":"duplicate definition of '-' header"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":5},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":10201},{"element":"number","content":78}]}]}]}},"content":"ignoring unrecognized block"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":9718},{"element":"number","content":51}]}]}]}},"content":"the resource '/v1/inline-seeds/options' is already defined"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":8},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":11313},{"element":"number","content":31}]}]}]}},"content":"sub-types of primitive types should not have nested members"}]},"TableOfContents":[{"anchor":"#automatic-inline-seeding-api","title":"Automatic Inline Seeding API","children":[{"anchor":"#header-seed-config","title":"Seed Config"},{"anchor":"#automatic-inline-seeding-api-get-seed-config","title":"Get Seed Config","children":[{"anchor":"#automatic-inline-seeding-api-get-get-seed-config","title":"Get Seed Config"}]},{"anchor":"#automatic-inline-seeding-api-create-seed-config","title":"Create Seed Config","children":[{"anchor":"#automatic-inline-seeding-api-post-create-seed-config","title":"Create Seed Config"}]},{"anchor":"#automatic-inline-seeding-api-update-seed-config","title":"Update Seed Config","children":[{"anchor":"#automatic-inline-seeding-api-put-update-seed-config","title":"Update Seed Config"}]},{"anchor":"#automatic-inline-seeding-api-list-active-campaigns","title":"List Active Campaigns","children":[{"anchor":"#automatic-inline-seeding-api-get-list-active-campaigns","title":"List Active Campaigns"}]},{"anchor":"#automatic-inline-seeding-api-check-campaign-status","title":"Check Campaign Status","children":[{"anchor":"#automatic-inline-seeding-api-get-check-campaign-status","title":"Check Campaign Status"}]},{"anchor":"#automatic-inline-seeding-api-get-options","title":"Get Options","children":[{"anchor":"#automatic-inline-seeding-api-get-get-options","title":"Get Options"}]},{"anchor":"#automatic-inline-seeding-api-update-options","title":"Update Options","children":[{"anchor":"#automatic-inline-seeding-api-put-update-options","title":"Update Options"}]}]}],"meta":{"title":"Automatic Inline Seeding","description":"Accept campaign stats, sanitize PII, and trigger seed messages.","full":false},"fields":{"path":"/api/inline-seeds/"}}},"pageContext":{"file":"inline-seeds.apib"}},"staticQueryHashes":["1319884646","1428769721","3859448388"]}