{"docs":{"name":"Newsroom API","info":"\n\u003cp\u003eThe PR.co API is organized around REST. This is to make sure the API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate any API errors. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website\u0026#39;s client-side code). JSON is returned by all API responses, including errors, although our API libraries convert responses to appropriate language-specific objects.\u003c/p\u003e\n\n\u003cp\u003ePlease note that all API endpoints are read-only and only to be used for building custom solutions: an integration with your own site, a feed of latest news on your homepage or app, direct integrations with internal tools, etc. There is no open API for the creation or modification of content in PR.co, that is only available through PR.co’s management console.\u003c/p\u003e\n\n\u003cp\u003eOur documentation is only a mostly-automated overview of the endpoints and their supported parameters. If you have any questions or trouble integrating with the API you can contact regular PR.co support (hello@pr.co) and we will get back with you as soon as we can.\u003c/p\u003e\n","copyright":"\u0026copy; 2026 PR.co B.V.","doc_url":"/docs/1.0","api_url":"/v1","resources":{"app-activities":{"doc_url":"/docs/1.0/app-activities","id":"app-activities","api_url":"/v1","name":"App::Activities","short_description":"Activities","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/app-activities/index","name":"index","apis":[{"api_url":"/v1{object_type}/{object_id}/activities.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a list of activities\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"last_id","full_name":"last_id","description":"\n\u003cp\u003eLast Id for pagination\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eAmount to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-activities/create","name":"create","apis":[{"api_url":"/v1{object_type}/{object_id}/activities.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eCreates a new activity\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"activity","full_name":"activity","description":"\n\u003cp\u003eParam description for all methods\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"changes","full_name":"activity[changes]","description":"\n\u003cp\u003eChanges made to the object\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"campaign_id","full_name":"activity[campaign_id]","description":"\n\u003cp\u003eId of the campaign\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"distribution_id","full_name":"activity[distribution_id]","description":"\n\u003cp\u003eId of the campaign\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"newsroom_id","full_name":"activity[newsroom_id]","description":"\n\u003cp\u003eId of the newsroom\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"activity[organisation_id]","description":"\n\u003cp\u003eId of the organisation\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revision_id","full_name":"activity[revision_id]","description":"\n\u003cp\u003eId of the revision\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"member_id","full_name":"activity[member_id]","description":"\n\u003cp\u003eId of the member\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"activity[user_id]","description":"\n\u003cp\u003eId of the user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"verb","full_name":"activity[verb]","description":"\n\u003cp\u003eActivity Verb\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"verb","full_name":"verb","description":"\n\u003cp\u003eActivity Verb\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"app-approvals":{"doc_url":"/docs/1.0/app-approvals","id":"app-approvals","api_url":"/v1","name":"App::Approvals","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/app-approvals/start","name":"start","apis":[{"api_url":"/v1campaigns/{campaign_id}/approvals/{id}.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eStart an approval\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-approvals/approve","name":"approve","apis":[{"api_url":"/v1campaigns/{campaign_id}/approvals/{id}.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eApprove approval\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-approvals/reject","name":"reject","apis":[{"api_url":"/v1campaigns/{campaign_id}/approvals/{id}.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReject approval\u003c/p\u003e\n","errors":[],"params":[{"name":"approval","full_name":"approval","description":"\n\u003cp\u003eParam description for all methods\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"message","full_name":"approval[message]","description":"\n\u003cp\u003eMessage to send\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"app-campaigns":{"doc_url":"/docs/1.0/app-campaigns","id":"app-campaigns","api_url":"/v1","name":"App::Campaigns","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/app-campaigns/update","name":"update","apis":[{"api_url":"/v1campaigns/{object_id}.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdate the campaign\u003c/p\u003e\n","errors":[],"params":[{"name":"campaign","full_name":"campaign","description":"\n\u003cp\u003eParam description for all methods\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"title","full_name":"campaign[title]","description":"\n\u003cp\u003eTitle of the campaign\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"medium_description","full_name":"campaign[medium_description]","description":"\n\u003cp\u003eDescription of the campaign\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"featured_image_id","full_name":"campaign[featured_image_id]","description":"\n\u003cp\u003eFeatured Image of the campaign\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locale","full_name":"campaign[locale]","description":"\n\u003cp\u003eLocale of the campaign\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_timeline","full_name":"campaign[show_in_timeline]","description":"\n\u003cp\u003eCampaign visible on newsroom\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_boilerplate_text","full_name":"campaign[show_boilerplate_text]","description":"\n\u003cp\u003eBoilerplate text visible on campaign\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_newsroom_ids","full_name":"campaign[parent_newsroom_ids]","description":"\n\u003cp\u003eParent newsrooms of the campaign\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"campaign[tags]","description":"\n\u003cp\u003eTags to update\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"publish_immediately","full_name":"campaign[publish_immediately]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"release_date","full_name":"campaign[release_date]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-campaigns/cancel","name":"cancel","apis":[{"api_url":"/v1campaigns/{object_id}/cancel.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eSet the campaign back to draft\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-campaigns/poll","name":"poll","apis":[{"api_url":"/v1campaigns/{object_id}/poll.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRetrieves current campaign status information\u003c/p\u003e\n","errors":[],"params":[{"name":"currentStep","full_name":"currentStep","description":"\n\u003cp\u003eThe users current step in the campaign flow (for Overwrite Lock)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tabId","full_name":"tabId","description":"\n\u003cp\u003eTab id, for autolock\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"comments","full_name":"comments","description":"\n\u003cp\u003eCheck for update to comments?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"activities","full_name":"activities","description":"\n\u003cp\u003eCheck for update to activities?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team","full_name":"team","description":"\n\u003cp\u003eCheck for update to the campaign team?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revisions","full_name":"revisions","description":"\n\u003cp\u003eCheck for update to revisions?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"app-comments":{"doc_url":"/docs/1.0/app-comments","id":"app-comments","api_url":"/v1","name":"App::Comments","short_description":"Comments","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/app-comments/index","name":"index","apis":[{"api_url":"/v1{object_type}/{object_id}/comments.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a list of comments\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-comments/create","name":"create","apis":[{"api_url":"/v1{object_type}/{object_id}/comments.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eCreates a new comment\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"comment","full_name":"comment","description":"\n\u003cp\u003eParam description for all methods\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"message","full_name":"comment[message]","description":"\n\u003cp\u003eMessage to for the comment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"commented_at","full_name":"comment[commented_at]","description":"\n\u003cp\u003eTimestamp for the comment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"skip_notification","full_name":"comment[skip_notification]","description":"\n\u003cp\u003eSkip the notification for this comment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"app-distributions":{"doc_url":"/docs/1.0/app-distributions","id":"app-distributions","api_url":"/v1","name":"App::Distributions","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/app-distributions/index","name":"index","apis":[{"api_url":"/v1campaigns/{object_id}/distributions","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eGet the distributions for a campaign\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-distributions/show","name":"show","apis":[{"api_url":"/v1campaigns/{object_id}/distributions/{distribution_id}","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eGet a distribution for a campaign\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-distributions/create","name":"create","apis":[{"api_url":"/v1campaigns/{object_id}/distributions/create","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCreate a distribution for the campaign\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-distributions/update","name":"update","apis":[{"api_url":"/v1campaigns/{object_id}/distributions/{distribution_id}","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdate a distribution\u003c/p\u003e\n","errors":[],"params":[{"name":"distribution","full_name":"distribution","description":"\n\u003cp\u003eParam description for all methods\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"distribution[name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"from_address","full_name":"distribution[from_address]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"from_name","full_name":"distribution[from_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subject","full_name":"distribution[subject]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"body","full_name":"distribution[body]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"embargo","full_name":"distribution[embargo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"send_on_date","full_name":"distribution[send_on_date]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"confirm","full_name":"distribution[confirm]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"update_contacts","full_name":"distribution[update_contacts]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_duplicates","full_name":"distribution[remove_duplicates]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_list_id","full_name":"distribution[contact_list_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"subsegment_id","full_name":"distribution[subsegment_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query","full_name":"distribution[query]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query_method","full_name":"distribution[query_method]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"selection_method","full_name":"distribution[selection_method]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"selection","full_name":"distribution[selection]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-distributions/destroy","name":"destroy","apis":[{"api_url":"/v1campaigns/{object_id}/distributions/{distribution_id}","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRemove a distribution from the campaign\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-distributions/cancel","name":"cancel","apis":[{"api_url":"/v1campaigns/{object_id}/distributions/{distribution_id}","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCancel a distribution\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-distributions/duplicate","name":"duplicate","apis":[{"api_url":"/v1campaigns/{object_id}/distributions/{id}/duplicate","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eDuplicate a distribution\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-distributions/contacts_from_ids","name":"contacts_from_ids","apis":[{"api_url":"/v1campaigns/{object_id}/distributions/{id}/contacts_from_ids","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eGet the ids of the currently selected contacts for a distribution\u003c/p\u003e\n","errors":[],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eId of the user requesting the selection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eId of the organisation requesting the selection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_ids","full_name":"contact_ids","description":"\n\u003cp\u003eContact IDs to get full contacts from\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-distributions/validate","name":"validate","apis":[{"api_url":"/v1campaigns/{object_id}/distributions/{id}/validate","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eValidate that the distribution selection is valid to send out\u003c/p\u003e\n","errors":[],"params":[{"name":"segment_id","full_name":"segment_id","description":"\n\u003cp\u003eSelected segment id for the distribution\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eId of the user requesting the selection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eId of the organisation requesting the selection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-distributions/tag_on_send","name":"tag_on_send","apis":[{"api_url":"/v1campaigns/{object_id}/distributions/{distribution_id}/tag_on_send","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eTag the distribution in the CRM when it sends out\u003c/p\u003e\n","errors":[],"params":[{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eId of the user requesting the selection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eId of the organisation requesting the selection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"campaign_id","full_name":"campaign_id","description":"\n\u003cp\u003eId of the campaign of the distribution being tagged\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the distribution being tagged\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"app-media_kit_categories":{"doc_url":"/docs/1.0/app-media_kit_categories","id":"app-media_kit_categories","api_url":"/v1","name":"App::Media_kit_categories","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/app-media_kit_categories/index","name":"index","apis":[{"api_url":"/v1/media_kit_categories.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRetrieves a list of media kit categories (previously called presskits) for a specific pressroom\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-media_kit_categories/tree","name":"tree","apis":[{"api_url":"/v1/media_kit_categories/tree.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRetrieves a tree structure of media kit categories (previously called presskits) in a tree structure for a specific pressroom\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-media_kit_categories/create","name":"create","apis":[{"api_url":"/v1/media_kit_categories.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCreates a media kit category\u003c/p\u003e\n","errors":[],"params":[{"name":"media_kit_category","full_name":"media_kit_category","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"created_by","full_name":"media_kit_category[created_by]","description":"\n\u003cp\u003eId of the user that created the category\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"media_kit_category[name]","description":"\n\u003cp\u003eMedia Kit Category name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"media_kit_category[description]","description":"\n\u003cp\u003eMedia Kit Category description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"image_id","full_name":"media_kit_category[image_id]","description":"\n\u003cp\u003eID of Media Kit Category image\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ancestry","full_name":"media_kit_category[ancestry]","description":"\n\u003cp\u003eID of Media Kit Category parent category\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-media_kit_categories/update","name":"update","apis":[{"api_url":"/v1/media_kit_categories/:id.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdate a specific media kit category\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eMedia Kit Category ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"media_kit_category","full_name":"media_kit_category","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"created_by","full_name":"media_kit_category[created_by]","description":"\n\u003cp\u003eId of the user that created the category\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"media_kit_category[name]","description":"\n\u003cp\u003eMedia Kit Category name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"media_kit_category[description]","description":"\n\u003cp\u003eMedia Kit Category description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"image_id","full_name":"media_kit_category[image_id]","description":"\n\u003cp\u003eID of Media Kit Category image\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ancestry","full_name":"media_kit_category[ancestry]","description":"\n\u003cp\u003eID of Media Kit Category parent category\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"position","full_name":"media_kit_category[position]","description":"\n\u003cp\u003ePosition of the media kit category (on it\u0026#39;s level)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"publish_date","full_name":"media_kit_category[publish_date]","description":"\n\u003cp\u003ePublish date of the media kit category\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"embargo_date","full_name":"media_kit_category[embargo_date]","description":"\n\u003cp\u003eEmbargo date of the media kit category\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-media_kit_categories/publish","name":"publish","apis":[{"api_url":"/v1/media_kit_categories/:id/publish.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003ePublishes a media kit category\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-media_kit_categories/publish_under_embargo","name":"publish_under_embargo","apis":[{"api_url":"/v1/media_kit_categories/:id/publish_under_embargo.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003ePublishes a media kit category\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-media_kit_categories/unpublish","name":"unpublish","apis":[{"api_url":"/v1/media_kit_categories/:id/unpublish.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUnpublishes a media kit category\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-media_kit_categories/show","name":"show","apis":[{"api_url":"/v1/media_kit_categories/:id.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRetrieve a specific media kit category\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eMedia Kit Category ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-media_kit_categories/update_positions","name":"update_positions","apis":[{"api_url":"/v1/media_kit_categories/update_positions.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdate position of media kit categories in newsroom\u003c/p\u003e\n","errors":[],"params":[{"name":"media_kit_category_positions","full_name":"media_kit_category_positions","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-media_kit_categories/destroy","name":"destroy","apis":[{"api_url":"/v1/media_kit_categories/:id.json","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eDestroys a specific media kit category and conditionally moves it\u0026#39;s children up a level\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eMedia Kit Category ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"destroy_children","full_name":"destroy_children","description":"\n\u003cp\u003eDo you also want to destroy child categories of this category, if there are any?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"app-media_kits":{"doc_url":"/docs/1.0/app-media_kits","id":"app-media_kits","api_url":"/v1","name":"App::Media_kits","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/app-media_kits/index","name":"index","apis":[{"api_url":"/v1/media_kits.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRetrieves a list of media kits (previously called presskits) for a specific pressroom\u003c/p\u003e\n","errors":[],"params":[{"name":"include_categories","full_name":"include_categories","description":"\n\u003cp\u003eInclude media kit categories?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-media_kits/create","name":"create","apis":[{"api_url":"/v1/media_kits.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCreates a media kit\u003c/p\u003e\n","errors":[],"params":[{"name":"media_kit","full_name":"media_kit","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"title","full_name":"media_kit[title]","description":"\n\u003cp\u003eMedia Kit Category name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"media_kit[description]","description":"\n\u003cp\u003eMedia Kit Category description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"media_kit[user_id]","description":"\n\u003cp\u003eId of the user that created the category\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"category_id","full_name":"media_kit[category_id]","description":"\n\u003cp\u003eID of Media Kit Category the media kit belongs to\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-media_kits/update","name":"update","apis":[{"api_url":"/v1/media_kits/:id.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdates a media kit\u003c/p\u003e\n","errors":[],"params":[{"name":"media_kit","full_name":"media_kit","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"title","full_name":"media_kit[title]","description":"\n\u003cp\u003eMedia Kit Category name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"media_kit[description]","description":"\n\u003cp\u003eMedia Kit Category description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-media_kits/publish","name":"publish","apis":[{"api_url":"/v1/media_kits/:id/publish.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003ePublishes a media kit\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-media_kits/publish_under_embargo","name":"publish_under_embargo","apis":[{"api_url":"/v1/media_kits/:id/publish_under_embargo.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003ePublishes a media kit\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-media_kits/unpublish","name":"unpublish","apis":[{"api_url":"/v1/media_kits/:id/unpublish.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUnpublishes a media kit\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-media_kits/show","name":"show","apis":[{"api_url":"/v1/media_kits/:id.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRetrieve a specific media kit\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eMedia Kit ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-media_kits/update_positions","name":"update_positions","apis":[{"api_url":"/v1/media_kits/update_positions.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdate position of media kits in newsroom\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-media_kits/update_category","name":"update_category","apis":[{"api_url":"/v1/media_kits/:id/update_category.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eChange category of media kit\u003c/p\u003e\n","errors":[],"params":[{"name":"category_id","full_name":"category_id","description":"\n\u003cp\u003eID of the new category for the media kit\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-media_kits/destroy","name":"destroy","apis":[{"api_url":"/v1/media_kits/:id.json","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eDestroys a specific media kit\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eMedia Kit ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"app-newsrooms":{"doc_url":"/docs/1.0/app-newsrooms","id":"app-newsrooms","api_url":"/v1","name":"App::Newsrooms","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/app-newsrooms/index","name":"index","apis":[{"api_url":"/v1organisations/\u003cid\u003e/newsrooms.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRetrieve newsrooms for organisation\u003c/p\u003e\n","errors":[],"params":[{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eOrganisation Id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"app-proposals":{"doc_url":"/docs/1.0/app-proposals","id":"app-proposals","api_url":"/v1","name":"App::Proposals","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/app-proposals/index","name":"index","apis":[{"api_url":"/v1campaigns/{campaign_id}/proposals.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRetrieves all the proposals for a campaign\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-proposals/create","name":"create","apis":[{"api_url":"/v1campaigns/{id}/proposals.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdd a new proposals to a campaign\u003c/p\u003e\n","errors":[],"params":[{"name":"proposal","full_name":"proposal","description":"\n\u003cp\u003eParam description for all methods\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"user_ids","full_name":"proposal[user_ids]","description":"\n\u003cp\u003eIds of users to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"message","full_name":"proposal[message]","description":"\n\u003cp\u003eMessage to send\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-proposals/update","name":"update","apis":[{"api_url":"/v1campaigns/{id}/proposals/{proposal_id}.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdate proposal in a campaign\u003c/p\u003e\n","errors":[],"params":[{"name":"proposal","full_name":"proposal","description":"\n\u003cp\u003eParam description for all methods\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"user_ids","full_name":"proposal[user_ids]","description":"\n\u003cp\u003eIds of users to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-proposals/destroy","name":"destroy","apis":[{"api_url":"/v1campaigns/{id}/proposals/{proposal_id}.json","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRemove proposal and set a campaign back to draft\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"app-reviewers":{"doc_url":"/docs/1.0/app-reviewers","id":"app-reviewers","api_url":"/v1","name":"App::Reviewers","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/app-reviewers/index","name":"index","apis":[{"api_url":"/v1campaigns/{campaign_id}/reviewers.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRetrieves a list of users that may approve this campaign\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"app-revisions":{"doc_url":"/docs/1.0/app-revisions","id":"app-revisions","api_url":"/v1","name":"App::Revisions","short_description":"Revisions","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/app-revisions/index","name":"index","apis":[{"api_url":"/v1campaigns/{object_id}/revisions.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a series of revisions\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-revisions/current","name":"current","apis":[{"api_url":"/v1campaigns/{object_id}/revisions/current.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves current revision or creates a new revision\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"campaign_id","full_name":"campaign_id","description":"\n\u003cp\u003eCampaign id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-revisions/create","name":"create","apis":[{"api_url":"/v1campaigns/{object_id}/revisions.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eCreates a new revision and update the user\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"revision","full_name":"revision","description":"\n\u003cp\u003eParam description for all methods\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"json","full_name":"revision[json]","description":"\n\u003cp\u003eCampaign JSON data\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"campaign_id","full_name":"revision[campaign_id]","description":"\n\u003cp\u003eId of the campaign\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-revisions/status","name":"status","apis":[{"api_url":"/v1revisions.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves the revisions status page\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"app-writers":{"doc_url":"/docs/1.0/app-writers","id":"app-writers","api_url":"/v1","name":"App::Writers","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/app-writers/index","name":"index","apis":[{"api_url":"/v1campaigns/{campaign_id}/users.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRetrieves a campaign team\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-writers/create","name":"create","apis":[{"api_url":"/v1campaigns/{id}/users.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdd users to a campaign\u003c/p\u003e\n","errors":[],"params":[{"name":"campaign","full_name":"campaign","description":"\n\u003cp\u003eParam description for all methods\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"user_ids","full_name":"campaign[user_ids]","description":"\n\u003cp\u003eIds of users to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"message","full_name":"campaign[message]","description":"\n\u003cp\u003eMessage to send\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/app-writers/destroy","name":"destroy","apis":[{"api_url":"/v1campaigns/{id}/users.json","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRemove user from a campaign\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"clippings":{"doc_url":"/docs/1.0/clippings","id":"clippings","api_url":"/v1","name":"Clippings","short_description":"Clippings are articles written about you.","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/clippings/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/clippings.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a list of clippings for a specific pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eComma seperated list of attributes to orders results by (e.g. id desc, release_date asc)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/clippings/show","name":"show","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/clippings/:id.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieve a specific clipping\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eClipping id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"crm-agents":{"doc_url":"/docs/1.0/crm-agents","id":"crm-agents","api_url":"/v1","name":"Crm::Agents","short_description":"Agents","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/crm-agents/bulk_update","name":"bulk_update","apis":[{"api_url":"/v1agents.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eCreate and/or update multiple agents for an organisation\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-agents/update","name":"update","apis":[{"api_url":"/v1agents/:id.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eUpdates an agent in the CRM\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User who is doing the deactivating\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"role","full_name":"role","description":"\n\u003cp\u003eNew role for the agent\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-agents/destroy","name":"destroy","apis":[{"api_url":"/v1agents/:id.json","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eDeactivates an agent from CRM\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User who is doing the deactivating\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"crm-bulkjobs":{"doc_url":"/docs/1.0/crm-bulkjobs","id":"crm-bulkjobs","api_url":"/v1","name":"Crm::Bulkjobs","short_description":"Bulkjobs","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/crm-bulkjobs/index","name":"index","apis":[{"api_url":"/v1bulkjobs.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eGet bulkjobs\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-bulkjobs/show","name":"show","apis":[{"api_url":"/v1bulkjobs/\u003cid\u003e.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eShow bulkjob\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-bulkjobs/errors","name":"errors","apis":[{"api_url":"/v1bulkjobs/\u003cid\u003e/errors.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eShow Bulk job with errors\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"crm-contact_imports":{"doc_url":"/docs/1.0/crm-contact_imports","id":"crm-contact_imports","api_url":"/v1","name":"Crm::Contact_imports","short_description":"Contacts","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/crm-contact_imports/create","name":"create","apis":[{"api_url":"/v1contact_imports.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eCreate a contact import\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"file","full_name":"file","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a ActionDispatch::Http::UploadedFile","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"has_headers","full_name":"has_headers","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-contact_imports/show","name":"show","apis":[{"api_url":"/v1contact_imports/\u003cid\u003e.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eShow contact import\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"record_separator","full_name":"record_separator","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_separator","full_name":"column_separator","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-contact_imports/update","name":"update","apis":[{"api_url":"/v1contact_imports/\u003ccontact_import_id\u003e.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eUpdate contact import\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"record_separator","full_name":"record_separator","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_separator","full_name":"column_separator","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mapping","full_name":"mapping","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-contact_imports/begin","name":"begin","apis":[{"api_url":"/v1contact_imports/\u003ccontact_import_id\u003e/begin.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eUpdate contact import\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"segments","full_name":"segments","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"tags","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-contact_imports/process_import","name":"process_import","apis":[{"api_url":"/v1contact_imports/\u003ccontact_import_id\u003e/process_import.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eProcess the contact import\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"crm-contact_tags":{"doc_url":"/docs/1.0/crm-contact_tags","id":"crm-contact_tags","api_url":"/v1","name":"Crm::Contact_tags","short_description":"Tags","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/crm-contact_tags/destroy","name":"destroy","apis":[{"api_url":"/v1contacts/\u003ccontact_id\u003e/tags/\u003cid\u003e.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRemove tag from contact\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the contact\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_id","full_name":"contact_id","description":"\n\u003cp\u003eID of the contact\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"crm-contacts":{"doc_url":"/docs/1.0/crm-contacts","id":"crm-contacts","api_url":"/v1","name":"Crm::Contacts","short_description":"Contacts","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/crm-contacts/import","name":"import","apis":[{"api_url":"/v1contacts.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eCreate and/or update multiple contacts\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"contacts","full_name":"contacts","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"list_names","full_name":"list_names","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"context","full_name":"context","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook","full_name":"webhook","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-contacts/destroy","name":"destroy","apis":[{"api_url":"/v1contacts/:id.json","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eMove a specific contact to trash\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the contact\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-contacts/bulk_destroy","name":"bulk_destroy","apis":[{"api_url":"/v1contacts.json","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eMove contacts to trash by selection\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"segment_id","full_name":"segment_id","description":"\n\u003cp\u003eID of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"selection_ids","full_name":"selection_ids","description":"","required":true,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"selection_method","full_name":"selection_method","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query","full_name":"query","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query_method","full_name":"query_method","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"crm-fields":{"doc_url":"/docs/1.0/crm-fields","id":"crm-fields","api_url":"/v1","name":"Crm::Fields","short_description":"Fields","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/crm-fields/index","name":"index","apis":[{"api_url":"/v1fields.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieve fields\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-fields/multi_create","name":"multi_create","apis":[{"api_url":"/v1fields/multi_create.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eCreate fields in bulk for organisation in CRM\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the organisation owner\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mappings","full_name":"mappings","description":"\n\u003cp\u003eArray of fields to create\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"crm-notices":{"doc_url":"/docs/1.0/crm-notices","id":"crm-notices","api_url":"/v1","name":"Crm::Notices","short_description":"Notices","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/crm-notices/create","name":"create","apis":[{"api_url":"/v1notices.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eCreate a mailgun notice (eg email bounced, contact unsubscribed) in the CRM API\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"notice","full_name":"notice","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"email","full_name":"notice[email]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"verb","full_name":"notice[verb]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"prco_newsroom_id","full_name":"notice[prco_newsroom_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"timestamp","full_name":"notice[timestamp]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser ID of the user who sent the event\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-notices/bulk","name":"bulk","apis":[{"api_url":"/v1notices/bulk.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eCreate mailgun notices in bulk (eg email bounced, contact unsubscribed) in the CRM API\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"notices","full_name":"notices","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eUser ID of the user who sent the event\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"crm-organisations":{"doc_url":"/docs/1.0/crm-organisations","id":"crm-organisations","api_url":"/v1","name":"Crm::Organisations","short_description":"Organisations","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/crm-organisations/destroy","name":"destroy","apis":[{"api_url":"/v1organisations/\u003cid\u003e.json","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRemove organisation from CRM -\u0026gt; Dangerous!\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003epr.co org id of the organisation to delete\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"crm-removed_contacts":{"doc_url":"/docs/1.0/crm-removed_contacts","id":"crm-removed_contacts","api_url":"/v1","name":"Crm::Removed_contacts","short_description":"Removed contacts","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/crm-removed_contacts/index","name":"index","apis":[{"api_url":"/v1removed_contacts.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieve removed contacts\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"size","description":"\n\u003cp\u003eNumber of contacts to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eOrder of contacts to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-removed_contacts/bulk_restore","name":"bulk_restore","apis":[{"api_url":"/v1removed_contacts/restore.json","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRestore removed contacts\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"selection_ids","full_name":"selection_ids","description":"","required":true,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"selection_method","full_name":"selection_method","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-removed_contacts/bulk_destroy","name":"bulk_destroy","apis":[{"api_url":"/v1removed_contacts.json","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003ePermanently delete contacts\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"selection_ids","full_name":"selection_ids","description":"","required":true,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"selection_method","full_name":"selection_method","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"crm-segment_agents":{"doc_url":"/docs/1.0/crm-segment_agents","id":"crm-segment_agents","api_url":"/v1","name":"Crm::Segment_agents","short_description":"Agents","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/crm-segment_agents/update_permissions","name":"update_permissions","apis":[{"api_url":"/v1segments/:segment_id/agents/:id/permissions.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eUpdate the permissions for an agent within a segment\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"permissions","full_name":"permissions","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"full_access","full_name":"permissions[full_access]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"can_create","full_name":"permissions[can_create]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"can_edit","full_name":"permissions[can_edit]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"can_remove","full_name":"permissions[can_remove]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"can_email","full_name":"permissions[can_email]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"can_export","full_name":"permissions[can_export]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUser ID of the agent to update\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"segment_id","full_name":"segment_id","description":"\n\u003cp\u003eID of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-segment_agents/destroy","name":"destroy","apis":[{"api_url":"/v1segments/:segment_id/agents/:id.json","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRemove an agent from a segment\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the agent\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"segment_id","full_name":"segment_id","description":"\n\u003cp\u003eID of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"crm-segment_contact_activities":{"doc_url":"/docs/1.0/crm-segment_contact_activities","id":"crm-segment_contact_activities","api_url":"/v1","name":"Crm::Segment_contact_activities","short_description":"Activities","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/crm-segment_contact_activities/index","name":"index","apis":[{"api_url":"/v1segments/\u003csegment_id\u003e/contacts/\u003cid\u003e/activities.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"contact_id","full_name":"contact_id","description":"\n\u003cp\u003eID of the contact\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"segment_id","full_name":"segment_id","description":"\n\u003cp\u003eID of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"verb","full_name":"verb","description":"\n\u003cp\u003eVerb to get activities from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"last_timestamp","full_name":"last_timestamp","description":"\n\u003cp\u003eLast timestamp\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"crm-segment_contact_notes":{"doc_url":"/docs/1.0/crm-segment_contact_notes","id":"crm-segment_contact_notes","api_url":"/v1","name":"Crm::Segment_contact_notes","short_description":"Notes","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/crm-segment_contact_notes/create","name":"create","apis":[{"api_url":"/v1segments/\u003csegment_id\u003e/contacts/\u003ccontact_id\u003e/notes.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"contact_id","full_name":"contact_id","description":"\n\u003cp\u003eID of the contact\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"segment_id","full_name":"segment_id","description":"\n\u003cp\u003eID of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"body","full_name":"body","description":"\n\u003cp\u003eBody of the note\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-segment_contact_notes/destroy","name":"destroy","apis":[{"api_url":"/v1segments/\u003csegment_id\u003e/contacts/\u003ccontact_id\u003e/notes/\u003cid\u003e.json","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the note\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_id","full_name":"contact_id","description":"\n\u003cp\u003eID of the contact\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"segment_id","full_name":"segment_id","description":"\n\u003cp\u003eID of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"crm-segment_contacts":{"doc_url":"/docs/1.0/crm-segment_contacts","id":"crm-segment_contacts","api_url":"/v1","name":"Crm::Segment_contacts","short_description":"Contacts","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/crm-segment_contacts/index","name":"index","apis":[{"api_url":"/v1segments/\u003csegment_id\u003e/contacts.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieve/contacts\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"segment_id","full_name":"segment_id","description":"\n\u003cp\u003eID of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"newsroom_id","full_name":"newsroom_id","description":"\n\u003cp\u003eID of the newsrooms\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"size","description":"\n\u003cp\u003eNumber of contacts to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eOrder of contacts to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-segment_contacts/show","name":"show","apis":[{"api_url":"/v1segments/\u003csegment_id\u003e/contacts/\u003cid\u003e.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the contact\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"segment_id","full_name":"segment_id","description":"\n\u003cp\u003eID of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-segment_contacts/create","name":"create","apis":[{"api_url":"/v1segments/\u003csegment_id\u003e/contacts.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eCreate a contact\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"segment_id","full_name":"segment_id","description":"\n\u003cp\u003eID of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact","full_name":"contact","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"primary_email","full_name":"contact[primary_email]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"card","full_name":"contact[card]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"contact[tags]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-segment_contacts/update","name":"update","apis":[{"api_url":"/v1segments/\u003csegment_id\u003e/contacts/\u003cid\u003e.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eUPDATE a contact\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the contact\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"segment_id","full_name":"segment_id","description":"\n\u003cp\u003eID of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact","full_name":"contact","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"primary_email","full_name":"contact[primary_email]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"card","full_name":"contact[card]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-segment_contacts/destroy","name":"destroy","apis":[{"api_url":"/v1segments/\u003csegment_id\u003e/contacts/\u003cid\u003e.json","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRemove a contact from a segment\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the contact\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"segment_id","full_name":"segment_id","description":"\n\u003cp\u003eID of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-segment_contacts/bulk_destroy","name":"bulk_destroy","apis":[{"api_url":"/v1segments/\u003csegment_id\u003e/contacts.json","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRemove contacts by selection from a segment\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"segment_id","full_name":"segment_id","description":"\n\u003cp\u003eID of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"selection_ids","full_name":"selection_ids","description":"","required":true,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"selection_method","full_name":"selection_method","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query","full_name":"query","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query_method","full_name":"query_method","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-segment_contacts/export","name":"export","apis":[{"api_url":"/v1segments/\u003csegment_id\u003e/contacts/export.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eExport contacts with an optional selection\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"segment_id","full_name":"segment_id","description":"\n\u003cp\u003eID of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"context","full_name":"context","description":"\n\u003cp\u003eContext of the export\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"selection_ids","full_name":"selection_ids","description":"","required":true,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"selection_method","full_name":"selection_method","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query","full_name":"query","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query_method","full_name":"query_method","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-segment_contacts/add_segments","name":"add_segments","apis":[{"api_url":"/v1segments/\u003csegment_id\u003e/contacts/\u003cid\u003e/segments.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eAssign segments to a contact\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the contact\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"segment_id","full_name":"segment_id","description":"\n\u003cp\u003eID of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"segments","full_name":"segments","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"segments[name]","description":"\n\u003cp\u003eName of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"segments[description]","description":"\n\u003cp\u003eDescription of the segment\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-segment_contacts/add_tags","name":"add_tags","apis":[{"api_url":"/v1segments/\u003csegment_id\u003e/contacts/\u003cid\u003e/tags.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eAssign tags to a contact\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the contact\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"segment_id","full_name":"segment_id","description":"\n\u003cp\u003eID of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"tags","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"tags[name]","description":"\n\u003cp\u003eName of the tag\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"crm-segment_segments":{"doc_url":"/docs/1.0/crm-segment_segments","id":"crm-segment_segments","api_url":"/v1","name":"Crm::Segment_segments","short_description":"Segments","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/crm-segment_segments/create","name":"create","apis":[{"api_url":"/v1segments/\u003csegment_id\u003e/segments.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eCreate segment\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"segment","full_name":"segment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"segment[name]","description":"\n\u003cp\u003eName of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"segment[description]","description":"\n\u003cp\u003eDescription of the segment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query","full_name":"segment[query]","description":"\n\u003cp\u003eQuery\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query_method","full_name":"segment[query_method]","description":"\n\u003cp\u003eQuery method\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-segment_segments/bulk_update","name":"bulk_update","apis":[{"api_url":"/v1segments/\u003csegment_id\u003e/segments.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eCreate segment(s) and assign contacts\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"segment_id","full_name":"segment_id","description":"\n\u003cp\u003eID of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"segments","full_name":"segments","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"segments[name]","description":"\n\u003cp\u003eName of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"segments[description]","description":"\n\u003cp\u003eDescription of the segment\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"selection_ids","full_name":"selection_ids","description":"","required":true,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"selection_method","full_name":"selection_method","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query","full_name":"query","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query_method","full_name":"query_method","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"crm-segment_tags":{"doc_url":"/docs/1.0/crm-segment_tags","id":"crm-segment_tags","api_url":"/v1","name":"Crm::Segment_tags","short_description":"Tags","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/crm-segment_tags/bulk_update","name":"bulk_update","apis":[{"api_url":"/v1segments/\u003csegment_id\u003e/tags.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eCreate tags and assign contacts\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"segment_id","full_name":"segment_id","description":"\n\u003cp\u003eID of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"tags","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"tags[name]","description":"\n\u003cp\u003eName of the  tag\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"selection_ids","full_name":"selection_ids","description":"","required":true,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"selection_method","full_name":"selection_method","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query","full_name":"query","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query_method","full_name":"query_method","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"crm-segments":{"doc_url":"/docs/1.0/crm-segments","id":"crm-segments","api_url":"/v1","name":"Crm::Segments","short_description":"Segments","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/crm-segments/index","name":"index","apis":[{"api_url":"/v1segments.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieve/segments\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"permissions","full_name":"permissions","description":"\n\u003cp\u003eInclude segment based on the permissions of the user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-segments/show","name":"show","apis":[{"api_url":"/v1segments/{id}.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieve/segment\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-segments/create","name":"create","apis":[{"api_url":"/v1segments.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eCreate segment\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"segment","full_name":"segment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"segment[name]","description":"\n\u003cp\u003eName of the segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"segment[description]","description":"\n\u003cp\u003eDescription of the segment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ai_context","full_name":"segment[ai_context]","description":"\n\u003cp\u003eAI context of the segment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-segments/update","name":"update","apis":[{"api_url":"/v1segments/{id}.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eUpdate segment\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"segment","full_name":"segment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"segment[name]","description":"\n\u003cp\u003eName of the segment\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"segment[description]","description":"\n\u003cp\u003eDescription of the segment\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ai_context","full_name":"segment[ai_context]","description":"\n\u003cp\u003eAI context of the segment\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query","full_name":"segment[query]","description":"\n\u003cp\u003eQuery\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query_method","full_name":"segment[query_method]","description":"\n\u003cp\u003eQuery method\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-segments/destroy","name":"destroy","apis":[{"api_url":"/v1segments/{id}.json","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRemove segment\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_contacts","full_name":"remove_contacts","description":"\n\u003cp\u003eAlso remove contacts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-segments/duplicate","name":"duplicate","apis":[{"api_url":"/v1segments/{id}/duplicate.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eDuplicate segment\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Segment to be duplicated\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"segment","full_name":"segment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"name","full_name":"segment[name]","description":"\n\u003cp\u003eName of the new segment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"segment[description]","description":"\n\u003cp\u003eDescription of the new segment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"crm-tag_contacts":{"doc_url":"/docs/1.0/crm-tag_contacts","id":"crm-tag_contacts","api_url":"/v1","name":"Crm::Tag_contacts","short_description":"Tags","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/crm-tag_contacts/destroy","name":"destroy","apis":[{"api_url":"/v1tags/\u003ctag_id\u003e/contacts/\u003cid\u003e.json","http_method":"PUT","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRemove contact from tag\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the contact\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tag_id","full_name":"tag_id","description":"\n\u003cp\u003eID of the tag\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"crm-tags":{"doc_url":"/docs/1.0/crm-tags","id":"crm-tags","api_url":"/v1","name":"Crm::Tags","short_description":"Tags","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/crm-tags/index","name":"index","apis":[{"api_url":"/v1tags.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieve tags\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"organisation_id","full_name":"organisation_id","description":"\n\u003cp\u003eID of the organisation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the User\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"crm-webhooks":{"doc_url":"/docs/1.0/crm-webhooks","id":"crm-webhooks","api_url":"/v1","name":"Crm::Webhooks","short_description":"Webhooks","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/crm-webhooks/webhook_contact_list_export_ready","name":"webhook_contact_list_export_ready","apis":[{"api_url":"/v1webhook_contact_list_export_ready.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eWebhook received after contact list export ready\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"results","full_name":"results","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"csv","full_name":"results[csv]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"xls","full_name":"results[xls]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"total","full_name":"results[total]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"list_name","full_name":"list_name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"context","full_name":"context","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-webhooks/webhook_contact_export_ready","name":"webhook_contact_export_ready","apis":[{"api_url":"/v1webhook_contact_export_ready.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eWebhook received after a selected contacts export is ready\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"results","full_name":"results","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"csv","full_name":"results[csv]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"xls","full_name":"results[xls]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"total","full_name":"results[total]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"list_name","full_name":"list_name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"context","full_name":"context","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/crm-webhooks/webhook_contact_import_finished","name":"webhook_contact_import_finished","apis":[{"api_url":"/v1webhook_contact_import_finished.json","http_method":"POST","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eWebhook received after a selected contacts export is ready\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"context","full_name":"context","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"documents":{"doc_url":"/docs/1.0/documents","id":"documents","api_url":"/v1","name":"Documents","short_description":"Documents","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/documents/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/documents.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a list of documents for a specific pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/documents/show","name":"show","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/documents/:id.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieve a specific document\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eDcoument id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"events":{"doc_url":"/docs/1.0/events","id":"events","api_url":"/v1","name":"Events","short_description":"Newsroom Events","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/events/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/events.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a list of events for a specific pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"past","full_name":"past","description":"\n\u003cp\u003eWhether or not to return past events\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/events/show","name":"show","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/events/:id.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieve a specific event for a pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eEvent id or slug\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"images":{"doc_url":"/docs/1.0/images","id":"images","api_url":"/v1","name":"Images","short_description":"Images","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/images/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/images.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a list of images for a specific pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/images/show","name":"show","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/images/:id.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieve a specific image\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eImage id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"live_events":{"doc_url":"/docs/1.0/live_events","id":"live_events","api_url":"/v1","name":"Live_events","short_description":"Newsroom Virtual Events","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/live_events/show","name":"show","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/live_events/:id.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieve a specific virtual event for a pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eEvent id or slug\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"movies":{"doc_url":"/docs/1.0/movies","id":"movies","api_url":"/v1","name":"Movies","short_description":"Movies","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/movies/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/movies.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a list of movies for a specific pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/movies/show","name":"show","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/movies/:id.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieve a specific movie\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eImage id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pages":{"doc_url":"/docs/1.0/pages","id":"pages","api_url":"/v1","name":"Pages","short_description":"Newsroom Pages","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pages/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/pages.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a list of pages for a specific pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"past","full_name":"past","description":"\n\u003cp\u003eWhether or not to return existing pages\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/pages/show","name":"show","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/pages/:id.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieve a specific page for a pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003ePage id or slug\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pr_contacts":{"doc_url":"/docs/1.0/pr_contacts","id":"pr_contacts","api_url":"/v1","name":"Spokespeople","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pr_contacts/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/pr_contacts.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a list of pr_contacts for a specific pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/pr_contacts/show","name":"show","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/pr_contacts/:id.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieve a specific pr_contact for a pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003ePr Contact id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"press_releases":{"doc_url":"/docs/1.0/press_releases","id":"press_releases","api_url":"/v1","name":"Press releases","short_description":"Retrieve one or multiple press releases from the API","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/press_releases/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/press_releases.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a list of press releases for a specific pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"includes","full_name":"includes","description":"\n\u003cp\u003eInclude attachments. To include featured images use: \u003cstrong\u003efeatured_images\u003c/strong\u003e.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eComma seperated list of attributes to orders results by (e.g. id desc, release_date asc)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"language","full_name":"language","description":"\n\u003cp\u003eComma separated list of locales for which to return press releases\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country_code","full_name":"country_code","description":"\n\u003cp\u003eCountry to display releases from if there is multicountry support\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/press_releases/show","name":"show","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/press_releases/:id.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieve a specific press release\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"includes","full_name":"includes","description":"\n\u003cp\u003eInclude attachments. To include featured images use: \u003cstrong\u003efeatured_images\u003c/strong\u003e.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003ePress release id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pressroom_server-archive-clippings":{"doc_url":"/docs/1.0/pressroom_server-archive-clippings","id":"pressroom_server-archive-clippings","api_url":"/v1","name":"Archive / Clippings","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pressroom_server-archive-clippings/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/archive/clippings.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a list of clippings for a specific pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"includes","full_name":"includes","description":"\n\u003cp\u003eInclude attachments (e.g. use \u003cstrong\u003e\u0026#39;tags\u0026#39;\u003c/strong\u003e to include tags)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"year","full_name":"year","description":"\n\u003cp\u003eYear to filter clippings on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"month","full_name":"month","description":"\n\u003cp\u003eMonth to filter clippings on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"tags","description":"\n\u003cp\u003eComma separated list of tags to filter clippings on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"match","full_name":"match","description":"\n\u003cp\u003eMatch \u0026#39;all\u0026#39; or \u0026#39;any\u0026#39; of the tags, defaults to \u0026#39;all\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"language","full_name":"language","description":"\n\u003cp\u003eComma separated list of locales for which to return clippings\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country_code","full_name":"country_code","description":"\n\u003cp\u003eCountry to display clippings from if there is multicountry support\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eComma seperated list of attributes to orders results by (e.g. id desc, release_date asc)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eNumber of clippings returned, defaults to 10\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pressroom_server-archive-events":{"doc_url":"/docs/1.0/pressroom_server-archive-events","id":"pressroom_server-archive-events","api_url":"/v1","name":"Archive / Events","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pressroom_server-archive-events/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/archive/events.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a list of events for a specific pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"includes","full_name":"includes","description":"\n\u003cp\u003eInclude attachments (e.g. use \u003cstrong\u003e\u0026#39;tags\u0026#39;\u003c/strong\u003e to include tags)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"year","full_name":"year","description":"\n\u003cp\u003eYear to filter events on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"month","full_name":"month","description":"\n\u003cp\u003eMonth to filter events on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"tags","description":"\n\u003cp\u003eComma separated list of tags to filter events on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"match","full_name":"match","description":"\n\u003cp\u003eMatch \u0026#39;all\u0026#39; or \u0026#39;any\u0026#39; of the tags, defaults to \u0026#39;all\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"language","full_name":"language","description":"\n\u003cp\u003eComma separated list of locales for which to return events\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country_code","full_name":"country_code","description":"\n\u003cp\u003eCountry to display events from if there is multicountry support\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eComma seperated list of attributes to orders results by (e.g. id desc, publish_date asc)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eNumber of events returned, defaults to 10\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"past","full_name":"past","description":"\n\u003cp\u003eWhether or not to return past events\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n\u003cp\u003eLive or Regular events\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pressroom_server-archive-press_releases":{"doc_url":"/docs/1.0/pressroom_server-archive-press_releases","id":"pressroom_server-archive-press_releases","api_url":"/v1","name":"Archive / Press releases","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pressroom_server-archive-press_releases/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/archive/press_releases.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a list of press releases for a specific pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"includes","full_name":"includes","description":"\n\u003cp\u003eInclude attachments (e.g. use \u003cstrong\u003e\u0026#39;featured_images\u0026#39;\u003c/strong\u003e to include featured images)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"year","full_name":"year","description":"\n\u003cp\u003eYear to filter press releases on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"month","full_name":"month","description":"\n\u003cp\u003eMonth to filter press releases on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"tags","description":"\n\u003cp\u003eComma separated list of tags to filter press releases on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"match","full_name":"match","description":"\n\u003cp\u003eMatch \u0026#39;all\u0026#39; or \u0026#39;any\u0026#39; of the tags, defaults to \u0026#39;all\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"language","full_name":"language","description":"\n\u003cp\u003eComma separated list of locales for which to return press releases\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country_code","full_name":"country_code","description":"\n\u003cp\u003eCountry to display press releases from if there is multicountry support\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eComma seperated list of attributes to orders results by (e.g. id desc, release_date asc)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eNumber of press releases returned, defaults to 10\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pressroom_server-media_kit_categories-media_kits":{"doc_url":"/docs/1.0/pressroom_server-media_kit_categories-media_kits","id":"pressroom_server-media_kit_categories-media_kits","api_url":"/v1","name":"Media kit categories: Media kits","short_description":"Retrieve media kits within a media kit category","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pressroom_server-media_kit_categories-media_kits/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/media_kit_categories/:id/media_kits.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves all media kits for a category\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the category\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hashed_passwords","full_name":"hashed_passwords","description":"\n\u003cp\u003ePasswords of the media kits\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pressroom_server-media_kit_categories":{"doc_url":"/docs/1.0/pressroom_server-media_kit_categories","id":"pressroom_server-media_kit_categories","api_url":"/v1","name":"Media kit categories","short_description":"Retrieve one or multiple media kit (formerly presskit) categories","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pressroom_server-media_kit_categories/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/media_kit_categories.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a list of media kit (formerly presskit) categories for a specific pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"category_id","full_name":"category_id","description":"\n\u003cp\u003eID of root category\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/pressroom_server-media_kit_categories/tree","name":"tree","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/media_kit_categories/tree.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a list of media kit (formerly presskit) categories in a tree structure for a specific pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"category_id","full_name":"category_id","description":"\n\u003cp\u003eID of root category\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/pressroom_server-media_kit_categories/show","name":"show","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/media_kit_categories/:id.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a media kit (formerly presskit) category\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of category\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pressroom_server-media_kits":{"doc_url":"/docs/1.0/pressroom_server-media_kits","id":"pressroom_server-media_kits","api_url":"/v1","name":"Media kits","short_description":"Retrieve one or multiple media kits (this resource was previously called presskits)","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pressroom_server-media_kits/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/media_kits.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a list of media kits (previously called presskits) for a specific pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hashed_passwords","full_name":"hashed_passwords","description":"\n\u003cp\u003ePasswords of the media kits\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/pressroom_server-media_kits/show","name":"show","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/media_kits/:id.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieve a specific media kit\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eMedia Kit ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hashed_password","full_name":"hashed_password","description":"\n\u003cp\u003ePassword of the media kit\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pressroom_server-search-clippings":{"doc_url":"/docs/1.0/pressroom_server-search-clippings","id":"pressroom_server-search-clippings","api_url":"/v1","name":"Search / Clippings","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pressroom_server-search-clippings/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/search/clippings.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eFull text search of the clippings in this pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null},{"code":422,"description":"You must provide a search term in the query parameter.","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query","full_name":"query","description":"\n\u003cp\u003eText to search clippings for\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country_code","full_name":"country_code","description":"\n\u003cp\u003eCountry to display clippings from if there is multicountry support\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"language","full_name":"language","description":"\n\u003cp\u003eLanguage for which to return clippings\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"includes","full_name":"includes","description":"\n\u003cp\u003eInclude attachments (e.g. use \u003cstrong\u003e\u0026#39;tags\u0026#39;\u003c/strong\u003e to include tags)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pressroom_server-search-media_kits":{"doc_url":"/docs/1.0/pressroom_server-search-media_kits","id":"pressroom_server-search-media_kits","api_url":"/v1","name":"Search / Media Kits","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pressroom_server-search-media_kits/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/search/media_kits.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eFull text search of the media kits in this pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null},{"code":422,"description":"You must provide a search term in the query parameter.","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query","full_name":"query","description":"\n\u003cp\u003eText to search media kits for\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country_code","full_name":"country_code","description":"\n\u003cp\u003eCountry to display media kits from if there is multicountry support\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"includes","full_name":"includes","description":"\n\u003cp\u003eInclude attachments (e.g. use \u003cstrong\u003e\u0026#39;tags\u0026#39;\u003c/strong\u003e to include tags)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hashed_passwords","full_name":"hashed_passwords","description":"\n\u003cp\u003ePasswords of the media kits\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pressroom_server-search-press_releases":{"doc_url":"/docs/1.0/pressroom_server-search-press_releases","id":"pressroom_server-search-press_releases","api_url":"/v1","name":"Search / Press releases","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pressroom_server-search-press_releases/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/search/press_releases.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eFull text search of the press releases in this pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null},{"code":422,"description":"You must provide a search term in the query parameter.","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query","full_name":"query","description":"\n\u003cp\u003eText to search releases for\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country_code","full_name":"country_code","description":"\n\u003cp\u003eCountry to display releases from if there is multicountry support\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"language","full_name":"language","description":"\n\u003cp\u003eLanguage for which to return press releases\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"includes","full_name":"includes","description":"\n\u003cp\u003eInclude attachments (e.g. use \u003cstrong\u003e\u0026#39;featured_images\u0026#39;\u003c/strong\u003e to include featured images)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pressroom_server-search":{"doc_url":"/docs/1.0/pressroom_server-search","id":"pressroom_server-search","api_url":"/v1","name":"Search","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pressroom_server-search/show","name":"show","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/search/all.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eFull text search of the press releases, clippings and media kits in this pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null},{"code":422,"description":"You must provide a search term in the query parameter.","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query","full_name":"query","description":"\n\u003cp\u003eText to search newsroom for\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country_code","full_name":"country_code","description":"\n\u003cp\u003eCountry to display results from if there is multicountry support\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"language","full_name":"language","description":"\n\u003cp\u003eLanguage for which to return results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hashed_passwords","full_name":"hashed_passwords","description":"\n\u003cp\u003ePasswords of the media kits\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pressroom_server-tagged-clippings":{"doc_url":"/docs/1.0/pressroom_server-tagged-clippings","id":"pressroom_server-tagged-clippings","api_url":"/v1","name":"Tagged / Clippings","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pressroom_server-tagged-clippings/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/tagged/clippings.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves clippings matching a specific set of tags in a pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"tags","description":"\n\u003cp\u003eComma separated list of tags to filter clippings on\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"match","full_name":"match","description":"\n\u003cp\u003eMatch \u0026#39;all\u0026#39; or \u0026#39;any\u0026#39; of the tags, defaults to \u0026#39;all\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country_code","full_name":"country_code","description":"\n\u003cp\u003eCountry to display releases from if there is multicountry support\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eComma seperated list of attributes to orders results by (e.g. id desc, release_date asc)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eNumber of clippings returned, defaults to 30\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"includes","full_name":"includes","description":"\n\u003cp\u003eInclude attachments (e.g. use \u003cstrong\u003e\u0026#39;tags\u0026#39;\u003c/strong\u003e to include tags)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pressroom_server-tagged-events":{"doc_url":"/docs/1.0/pressroom_server-tagged-events","id":"pressroom_server-tagged-events","api_url":"/v1","name":"Tagged / Events","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pressroom_server-tagged-events/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/tagged/events.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves events matching a specific set of tags in a pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"past","full_name":"past","description":"\n\u003cp\u003eWhether or not to return past events\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"tags","description":"\n\u003cp\u003eComma separated list of tags to filter events on\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"match","full_name":"match","description":"\n\u003cp\u003eMatch \u0026#39;all\u0026#39; or \u0026#39;any\u0026#39; of the tags, defaults to \u0026#39;all\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country_code","full_name":"country_code","description":"\n\u003cp\u003eCountry to display releases from if there is multicountry support\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eComma seperated list of attributes to orders results by (e.g. starting_at desc, publish_date asc, ending_at desc)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eNumber of events returned, defaults to 30\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"includes","full_name":"includes","description":"\n\u003cp\u003eInclude attachments (e.g. use \u003cstrong\u003e\u0026#39;tags\u0026#39;\u003c/strong\u003e to include tags)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pressroom_server-tagged-media_kits":{"doc_url":"/docs/1.0/pressroom_server-tagged-media_kits","id":"pressroom_server-tagged-media_kits","api_url":"/v1","name":"Tagged / Media kits","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pressroom_server-tagged-media_kits/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/tagged/media_kits.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves media kits matching a specific set of tags in a pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"tags","description":"\n\u003cp\u003eComma separated list of tags to filter media kits on\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"match","full_name":"match","description":"\n\u003cp\u003eMatch \u0026#39;all\u0026#39; or \u0026#39;any\u0026#39; of the tags, defaults to \u0026#39;all\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country_code","full_name":"country_code","description":"\n\u003cp\u003eCountry to display releases from if there is multicountry support\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eNumber of media kits returned, defaults to 30\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"includes","full_name":"includes","description":"\n\u003cp\u003eInclude attachments (e.g. use \u003cstrong\u003e\u0026#39;tags\u0026#39;\u003c/strong\u003e to include tags)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hashed_passwords","full_name":"hashed_passwords","description":"\n\u003cp\u003ePasswords of the media kits\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pressroom_server-tagged-pages":{"doc_url":"/docs/1.0/pressroom_server-tagged-pages","id":"pressroom_server-tagged-pages","api_url":"/v1","name":"Tagged / Pages","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pressroom_server-tagged-pages/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/tagged/pages.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves pages matching a specific set of tags in a pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"tags","description":"\n\u003cp\u003eComma separated list of tags to filter events on\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"match","full_name":"match","description":"\n\u003cp\u003eMatch \u0026#39;all\u0026#39; or \u0026#39;any\u0026#39; of the tags, defaults to \u0026#39;all\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country_code","full_name":"country_code","description":"\n\u003cp\u003eCountry to display releases from if there is multicountry support\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eComma seperated list of attributes to orders results by (e.g. id desc, release_date asc)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eNumber of pages returned, defaults to 30\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"includes","full_name":"includes","description":"\n\u003cp\u003eInclude attachments (e.g. use \u003cstrong\u003e\u0026#39;tags\u0026#39;\u003c/strong\u003e to include tags)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pressroom_server-tagged-press_releases":{"doc_url":"/docs/1.0/pressroom_server-tagged-press_releases","id":"pressroom_server-tagged-press_releases","api_url":"/v1","name":"Tagged / Press releases","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pressroom_server-tagged-press_releases/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/tagged/press_releases.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves press releases matching a specific set of tags in a pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"tags","description":"\n\u003cp\u003eComma separated list of tags to filter press releases on\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"match","full_name":"match","description":"\n\u003cp\u003eMatch \u0026#39;all\u0026#39; or \u0026#39;any\u0026#39; of the tags, defaults to \u0026#39;all\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"language","full_name":"language","description":"\n\u003cp\u003eComma separated list of locales for which to return press releases\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country_code","full_name":"country_code","description":"\n\u003cp\u003eCountry to display releases from if there is multicountry support\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eComma seperated list of attributes to orders results by (e.g. id desc, release_date asc)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eNumber of press releases returned, defaults to 30\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"includes","full_name":"includes","description":"\n\u003cp\u003eInclude attachments (e.g. use \u003cstrong\u003e\u0026#39;featured_images\u0026#39;\u003c/strong\u003e to include featured images)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/pressroom_server-tagged-press_releases/count","name":"count","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/tagged/press_releases/count.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves total count of press releases matching a specific set of tags in a pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"tags","description":"\n\u003cp\u003eComma separated list of tags to filter press releases on\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"match","full_name":"match","description":"\n\u003cp\u003eMatch \u0026#39;all\u0026#39; or \u0026#39;any\u0026#39; of the tags, defaults to \u0026#39;all\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"language","full_name":"language","description":"\n\u003cp\u003eComma separated list of locales for which to return press releases\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country_code","full_name":"country_code","description":"\n\u003cp\u003eCountry to display releases from if there is multicountry support\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pressrooms":{"doc_url":"/docs/1.0/pressrooms","id":"pressrooms","api_url":"/v1","name":"Pressrooms","short_description":"Retrieve a pressroom or it's contents","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/pressrooms/show","name":"show","apis":[{"api_url":"/v1/pressrooms/:id.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieve a pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"includes","full_name":"includes","description":"\n\u003cp\u003eInclude attachments. To include featured images use: \u003cstrong\u003efeatured_images\u003c/strong\u003e, eg: ?includes=featured_images.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/pressrooms/timeline","name":"timeline","apis":[{"api_url":"/v1/pressrooms/:id/timeline.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves the complete timeline for a pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"includes","full_name":"includes","description":"\n\u003cp\u003eInclude attachments. To include featured images use: \u003cstrong\u003efeatured_images\u003c/strong\u003e, eg: ?includes=featured_images.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"clipping_token","full_name":"clipping_token","description":"\n\u003cp\u003eInclude the clipping token to include private clippings\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"sounds":{"doc_url":"/docs/1.0/sounds","id":"sounds","api_url":"/v1","name":"Sounds","short_description":"Sounds","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/sounds/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/sounds.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a list of sounds for a specific pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/sounds/show","name":"show","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/sounds/:id.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieve a specific sound for a pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSound id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"tags":{"doc_url":"/docs/1.0/tags","id":"tags","api_url":"/v1","name":"Tags","short_description":"Tags","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/tags/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/tags.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves the tags for a specific pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"videos":{"doc_url":"/docs/1.0/videos","id":"videos","api_url":"/v1","name":"Videos","short_description":"Videos","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/videos/index","name":"index","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/videos.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a list of videos for a specific pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/videos/show","name":"show","apis":[{"api_url":"/v1/pressrooms/:pressroom_id/videos/:id.json","http_method":"GET","short_description":null,"deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieve a specific video for a pressroom\u003c/p\u003e\n","errors":[{"code":404,"description":"Missing","metadata":null}],"params":[{"name":"pressroom_id","full_name":"pressroom_id","description":"\n\u003cp\u003ePressroom id or pressroom domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eVideo id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}}}}