CoSend is developed using an API-first approach. This means that the majority of the actions you want to perform using our API should be possible.
\nHowever, not all our API is currently documented - so please bear with us as we continue to add to and improve the documentation.
\nIf you have any questions, please don't hesitate to reach out to us via support@cosend.io
\nThis documentation is generated using Postman. You can import it to your Postman by pressing the orange 'Run in Postman' button on the top right of this page. This will then create a copy of the Collection in your Postman software.
\nIn Postman you will need to Edit the Collection you created in the previous step. To do this, click on the dots next to the Collection, choose Edit and then choose the Variables. Next fill in the Initial Value spaces with the following:
\nbaseUrl the root URL of your system (without a trailing /)
apiToken the API key generated from your profile in your system (if you want to perform API actions, you will need to generate a token from a profile that has Admin access)
This will then update the entire Collection so that you won't need to manually update the domain or prepare your API token for each request.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Quick start using Postman","slug":"quick-start-using-postman"},{"content":"Authentication","slug":"authentication"}],"owner":"3400646","collectionId":"a48d7a9d-a701-4c18-a2db-b20567042c67","publishedId":"TzXumz1K","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"32b7ff"},"publishDate":"2021-05-24T15:26:33.000Z"},"item":[{"name":"Admin Actions","item":[{"name":"User Accounts","item":[{"name":"List all User Accounts","id":"6ee8e548-c236-4d51-9de6-cc5e15e78f93","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://your.domain.com/api/all-users","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","all-users"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[{"id":"df9fff22-39e4-4634-be7e-99dedcba4a0a","name":"List all User Accounts","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://your.domain.com/api/all-users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/7.4.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 22 Jun 2021 06:31:56 GMT"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"599"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Peter Griffin\",\n \"email\": \"peter@griffin.com\",\n \"created_at\": \"2021-03-16 14:14:29\",\n \"updated_at\": \"2021-06-20 17:40:49\",\n \"trial_ends_at\": \"2021-03-26 14:14:29\",\n \"deleted_at\": null,\n \"photo_url\": \"https://cosend-dev.fra1.digitaloceanspaces.com/app.cosend.io/assets/eE1cVqDH8iXkdg7ON6LRoRyLG9zBQ6MTn6ytaEIK.png\",\n \"tax_rate\": 0\n },\n {\n \"id\": 2,\n \"name\": \"Homer Simpson\",\n \"email\": \"homer@simpson.com\",\n \"created_at\": \"2021-05-04 13:03:21\",\n \"updated_at\": \"2021-06-20 17:40:46\",\n \"trial_ends_at\": \"2022-05-04 13:03:21\",\n \"deleted_at\": null,\n \"photo_url\": \"https://cosend-dev.fra1.digitaloceanspaces.com/app.cosend.io/assets/eE1cVqDH8iXkdg7ON6LRoRyLG9zBQ6MTn6ytaEIK.png\",\n \"tax_rate\": 0\n }\n]"}],"_postman_id":"6ee8e548-c236-4d51-9de6-cc5e15e78f93"},{"name":"Create User Account","id":"dfe0b286-4b5e-4c7f-821a-19e0f9897bbf","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","type":"text","value":"Joe Bloggs"},{"key":"password","type":"text","value":"joe1234"},{"key":"password_confirmation","type":"text","value":"joe1234"},{"key":"email","type":"text","value":"joe@bloggs.com"},{"description":"1 = true, 0 = false
\n","key":"add_to_existing","type":"text","value":"1"},{"description":"TODO: Data needs to be sent as an array
\n","key":"team_rows[][]","type":"text","value":"","disabled":true},{"description":"ID of the Team/Brand you're adding the user to
\n","key":"existing_team","type":"text","value":"1"}]},"url":"https://your.domain.com/api/account/create","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","account","create"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"dfe0b286-4b5e-4c7f-821a-19e0f9897bbf"},{"name":"Delete User Account","id":"d41040bc-e375-4f51-a9a2-24fa21323474","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://your.domain.com/api/account/delete?id=1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","account","delete"],"host":["https://your.domain.com"],"query":[{"description":{"content":"ID of the user to be deleted
\n","type":"text/plain"},"key":"id","value":"1"}],"variable":[]}},"response":[],"_postman_id":"d41040bc-e375-4f51-a9a2-24fa21323474"}],"id":"06153f48-c3e5-4e59-87d8-73f022710c32","_postman_id":"06153f48-c3e5-4e59-87d8-73f022710c32","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}}},{"name":"Teams (Brands)","item":[{"name":"List all Teams","id":"8d48127a-8a81-40dd-96df-9a0df6133cb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://your.domain.com/api/all-teams","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","all-teams"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8d48127a-8a81-40dd-96df-9a0df6133cb8"},{"name":"Delete Team","id":"c2c59b0c-ee27-482a-ad2c-db2441c66125","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://your.domain.com/api/team/delete?id=1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","team","delete"],"host":["https://your.domain.com"],"query":[{"key":"id","value":"1"}],"variable":[]}},"response":[],"_postman_id":"c2c59b0c-ee27-482a-ad2c-db2441c66125"}],"id":"92950a22-df56-41a6-9e03-abdcf3ea7445","_postman_id":"92950a22-df56-41a6-9e03-abdcf3ea7445","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}}},{"name":"API Tokens","item":[{"name":"Create API Token for User","id":"17f5e53a-5ed4-4720-b51c-3f64d10d82a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","type":"text","value":"Token Name"},{"key":"user_id","type":"text","value":"1"}]},"url":"https://your.domain.com/api/tokens/create","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","tokens","create"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"17f5e53a-5ed4-4720-b51c-3f64d10d82a9"},{"name":"Get all API Tokens","id":"a152bbca-f9b6-4bb3-9a25-805734897f6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://your.domain.com/api/all-api-tokens","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","all-api-tokens"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a152bbca-f9b6-4bb3-9a25-805734897f6c"},{"name":"Delete Token","id":"c3a38837-5913-46bf-adff-cdf5d7e405bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://your.domain.com/api/tokens/delete?id=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","tokens","delete"],"host":["https://your.domain.com"],"query":[{"description":{"content":"UUID of Token
\n","type":"text/plain"},"key":"id","value":""}],"variable":[]}},"response":[],"_postman_id":"c3a38837-5913-46bf-adff-cdf5d7e405bb"}],"id":"8b3577fa-20de-4562-bdd7-f47fe7a1523a","_postman_id":"8b3577fa-20de-4562-bdd7-f47fe7a1523a","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}}},{"name":"Timezones","item":[{"name":"Get Timezones","id":"ccf9726e-9608-4433-abef-5b830f821ad7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://your.domain.com/api/timezones","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","timezones"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ccf9726e-9608-4433-abef-5b830f821ad7"}],"id":"443b979f-4bdb-4e74-aca8-ae33b747a07c","_postman_id":"443b979f-4bdb-4e74-aca8-ae33b747a07c","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}}},{"name":"Customisation","item":[{"name":"Get Customisation Status","id":"a738c336-9c6f-43d1-84e5-f173980c18e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://your.domain.com/api/system/customize/status","description":"Returns a JSON object showing which parts of the system have been customized and/or setup.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","system","customize","status"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a738c336-9c6f-43d1-84e5-f173980c18e7"},{"name":"Get Customisation Settings","id":"a5f492a3-336a-4a6a-b843-483566503c9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://your.domain.com/api/system/customize/settings","description":"Returns a JSON object containing all the current values that have been used to customize the system.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","system","customize","settings"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a5f492a3-336a-4a6a-b843-483566503c9d"},{"name":"Update Brand Basics","id":"e16835a1-7182-4f95-adc5-9ab74f44d250","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"color","value":"#888","description":"The color used across the system to make it match the system's owner branding
\n","type":"text"},{"key":"name","value":"My System Name","description":"The name of the system displayed to-end users
\n","type":"text"},{"key":"team_label","value":"Brand","description":"The label used to describe Teams (e.g. Brand, Practice)
\n","type":"text"},{"key":"terms_url","value":"https://yoursite.com/terms","description":"A link to a custom Terms and Conditions page
\n","type":"text"},{"key":"privacy_url","value":"https://yoursite.com/privacy","description":"A link to a custom Privacy Policy page
\n","type":"text"}]},"url":"https://your.domain.com/api/system/customize/brand-basics","description":"Allows the updating of the following options:
\nThe logo file being uploaded. Must be in PNG format.
\n","key":"file","type":"file","value":null}]},"url":"https://your.domain.com/api/system/customize/logo","description":"Updates the logo shown on the system login pages, as well as the logo used in transactional e-mails.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","system","customize","logo"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8768548d-62e3-4c5c-90e6-5415a9d351c4"},{"name":"Update Favicon","id":"117db482-dc4e-4689-9dd9-754d9f9031bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"The favicon file being uploaded. Must be in PNG format.
\n","key":"file","type":"file","value":null}]},"url":"https://your.domain.com/api/system/customize/favicon","description":"Allows the updating of the following options:
\nThe profile image file being uploaded. Must be in PNG format.
\n","key":"file","type":"file","value":null}]},"url":"https://your.domain.com/api/system/customize/profile-placeholder","description":"Updates the Profile Placeholder image used across the system. Only PNG is supported.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","system","customize","profile-placeholder"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"da47e5c6-9f78-4521-9e44-7e42a39d418f"},{"name":"Update Team Placeholder Image","id":"310fb44e-21ac-4cf1-bd61-b38d2106f608","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"The team image file being uploaded. Must be in PNG format.
\n","key":"file","type":"file","value":null}]},"url":"https://your.domain.com/api/system/customize/team-placeholder","description":"Updates the Team Placeholder image used across the system. Only PNG is supported.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","system","customize","team-placeholder"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"310fb44e-21ac-4cf1-bd61-b38d2106f608"},{"name":"Update Login Screen Image","id":"52952d00-e0b9-4f7d-81c1-6cc3f728c388","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"The team image file being uploaded. Must be in PNG format.
\n","key":"file","type":"file","value":null}]},"url":"https://your.domain.com/api/system/customize/login-image","description":"Updates the Background Image on the login screen. Only PNG is supported.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","system","customize","login-image"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"52952d00-e0b9-4f7d-81c1-6cc3f728c388"},{"name":"Update Domain Settings","id":"473802d8-7f37-44ad-b844-a1835cffcc9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"The domain name of the system. Must be in format: their.domain.com (no https or trailing slash)
A valid e-mail address that will be used to send transactional emails to end-users
\n","key":"from_address","type":"text","value":"notifications@cosend.com"},{"description":"A valid e-mail address that support e-mails will be sent to
\n","key":"support_address","type":"text","value":"support@cosend.com"}]},"url":"https://your.domain.com/api/system/customize/domain","description":"Updates the Team Placeholder image used across the system. Only PNG is supported.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","system","customize","domain"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"473802d8-7f37-44ad-b844-a1835cffcc9f"},{"name":"Validate Domain Name is Setup","id":"ba78b699-4605-4be5-b05a-fc733e2185c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://your.domain.com/api/system/customize/domain/validate","description":"Checks the status of a domain and whether it is setup correctly and will also update the domain name if the domain is pending validation.
\nReturns an object containing the domain name(s) and their statuses.
\nIf a newly validated domain is processed the redirect_to_new_domain will be set to true, and you should redirect that user to the new domain to login.
HTML code that is inserted into the header
\n","key":"header_html","type":"text","value":""}]},"url":"https://your.domain.com/api/system/customize/header-html","description":"Updates the HTML code that is inserted into the Header of every page in the system.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","system","customize","header-html"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fa783189-fac8-4aac-91ae-98f099067a4d"},{"name":"Update Footer HTML","id":"9fe8c97a-0002-4f31-9abc-87d56ad502c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"HTML code that is inserted into the footer
\n","key":"footer_html","type":"text","value":""}]},"url":"https://your.domain.com/api/system/customize/footer-html","description":"Updates the HTML code that is inserted into the Header of every page in the system.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","system","customize","footer-html"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9fe8c97a-0002-4f31-9abc-87d56ad502c3"}],"id":"aef06fa7-be8f-4e06-bdb2-c6af7d9fd785","_postman_id":"aef06fa7-be8f-4e06-bdb2-c6af7d9fd785","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}}}],"id":"4fa2dc29-582e-4f87-a8f7-15a8c9457207","description":"This folder contains API endpoints which can be performed by a White Label Admin using an API token that has been generated under a White Label User's profile.
\nImportant: Any API calls that can also be performed by an end-user will be found under the User or Team actions folder (such as the ability to Create a new Team/Brand).
\n","event":[{"listen":"prerequest","script":{"id":"de849166-0058-4f90-8e8f-02dced2d3645","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"882d0628-38c3-4402-a1dc-35b1d60899e8","type":"text/javascript","exec":[""]}}],"_postman_id":"4fa2dc29-582e-4f87-a8f7-15a8c9457207","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}}},{"name":"User Actions","item":[{"name":"Post Groups","item":[{"name":"List Post Groups","id":"da3f6ea7-4b86-451f-98c5-e06a79022162","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://your.domain.com/api/categories?brand_id=1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","categories"],"host":["https://your.domain.com"],"query":[{"description":{"content":"Brand ID
\n","type":"text/plain"},"key":"brand_id","value":"1"}],"variable":[]}},"response":[{"id":"1c546d28-770d-4351-937a-a26a6599f67b","name":"specify a valid API key","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://your.domain.com/categories?api_token=ID of the Post Group
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"1d68f003-a505-4f7b-b35b-a2db9a46a8ab","name":"internal server error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://your.domain.com/category/:id/accounts?api_token=(Required) Brand ID
\n","type":"text"},{"key":"categories","value":"(Required) IDs of categories to add the post to
\n","type":"text"},{"key":"text","value":"(Required) The content of your post
\n","type":"text"},{"key":"status","value":"(Required: Draft or approved
\n","type":"text"},{"key":"media_url","value":"URL of image to be used (will be downloaded and stored in the media library unless media_is_remote_image is set to true)
\n","type":"text"},{"key":"media_is_remote_image","value":"Load and send an image from a remote URL (bypass media library)
\n","type":"text"},{"key":"media_alt_text","value":"The accessible text / caption that is used by the network for those with disabilities (if supported by the network)
\n","type":"text"},{"key":"content_is_remote_text","value":"DEPRECATED. Load and send text from a remote URL - must return a JSON feed with a variable 'content'
\n","type":"text"}]},"url":"https://your.domain.com/api/evergreen-post","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","evergreen-post"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[{"id":"5be60e62-e44c-43cc-ba96-e6df92998282","name":"internal server error","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://your.domain.com/evergreen-post?api_token=Brand ID
\n","type":"text/plain"},"key":"brand_id","value":"(Required) Brand ID
\n","type":"text"},{"key":"accounts[]","value":"(Required) Array of account IDs to send the post to
\n","type":"text"},{"key":"approval_status","value":"Default: approved. Options: draft, pending, approved, rejected, changes_requested
\n","type":"text"},{"key":"text","value":"(Required) The content of your post
\n","type":"text"},{"key":"media_url","value":"URL of the image to be used (will be downloaded and stored in the media library unless media_is_remote_image is set to true)
\n","type":"text"},{"key":"media_is_remote_image","value":"Load and send an image from a remote URL (bypass media library)
\n","type":"text"},{"key":"media_alt_text","value":"The accessible text / caption that is used by the network for those with disabilities (if supported by the network). Max length 1,000 characters. NOTE: This text will get truncated to 300 characters for LinkedIn Page Posts.
\n","type":"text"},{"key":"media_additional[]","value":"['media_url' => '', 'media_is_remote_image => true, 'media_alt_text' => '', 'media_caption' => '']","description":"Array of any additional media attached to a post (used to create a gallery if the network supports it)
\n","type":"text"},{"key":"content_is_remote_text","value":"Load and send text from a remote URL - must return a JSON feed with a variable 'content'
\n","type":"text"},{"key":"now","value":"(Required) Send now?
\n","type":"text"},{"key":"scheduled_at","value":"Specify UTC timestamp (e.g. 1515170582) of when the post should be sent (if it's in the past, it will send immediately)
\n","type":"text"}]},"url":"https://your.domain.com/api/post","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","post"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c1a291a7-1942-401e-b079-2f004245e9af"},{"name":"Update Post","id":"194438e3-d319-4968-a014-24d9269bb59d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"description":"Brand ID - defaults to Authorised user's current Brand
\n","key":"brand_id","type":"text","value":"(Required) Array of account IDs to send the post to
\n","key":"accounts[]","type":"text","value":"Options: draft, pending, approved, rejected, changes_requested. If left blank, it will keep its current status.
\n","type":"text"},{"description":"(Required) The content of your post
\n","key":"text","type":"text","value":"URL of image to be used (will be downloaded and stored in the media library unless media_is_remote_image is set to true)
\n","key":"media_url","type":"text","value":"Load and send an image from a remote URL (bypass media library)
\n","key":"media_is_remote_image","type":"text","value":"The accessible text / caption that is used by the network for those with disabilities (if supported by the network). Max length 1,000 characters.
\n","type":"text"},{"key":"media_type","value":"Specify either image or video
\n","type":"text"},{"key":"media_thumbnail","value":"Specify UTC timestamp (e.g. 1515170582) of when the post should be sent (if it's in the past, it will send immediately)
\n","key":"scheduled_at","type":"text","value":"Brand ID
\n","type":"text/plain"},"key":"brand_id","value":"(Required) Format: YYYY-MM-DD
\n","type":"text/plain"},"key":"to","value":"2020-01-01"},{"description":{"content":"(Required) Format: YYYY-MM-DD
\n","type":"text/plain"},"key":"from","value":"2022-01-01"},{"description":{"content":"The id of the Brand you want to load (default's to users current brand)
\n","type":"text/plain"},"key":"brand_id","value":""}],"variable":[]}},"response":[],"_postman_id":"ab1f146f-5c38-406f-96fc-a9d02366eb3a"},{"name":"Delete Sent Posts","id":"7a650405-1151-4557-9c2d-d18d088cee42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://your.domain.com/api/sent-items?brand_id=(Required) The brand ID that the Sent Posts belong to
\n","type":"text/plain"},"key":"brand_id","value":"(Required) Comma separated list of the Sent Post IDs that you want to delete. Max 25 items. NOTE: Instagram and Facebook Groups do not currently support post deletion.
\n","type":"text/plain"},"key":"sent_post_ids","value":"1,2,3"}],"variable":[]}},"response":[{"id":"98b37692-6c2f-4316-8f8e-9b680944499e","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://your.domain.com/api/sent-items?brand_id=1&sent_post_ids=1,2,3","host":["https://your.domain.com"],"path":["api","sent-items"],"query":[{"key":"brand_id","value":"1","description":"(Required) The brand ID that the Sent Posts belong to"},{"key":"sent_post_ids","value":"1,2,3","description":"(Required) Comma separated list of the Sent Post IDs that you want to delete. Max 25 items."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/7.4.21"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Fri, 09 Jul 2021 14:01:28 GMT"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"598"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IjV3VHBlWEd5ZHoybEo3RGJxZUNwd1E9PSIsInZhbHVlIjoicXFVeW51RERVOEJ3RjdHN1pNNDJWTzk5NG0wcGdzb1ZIWGVPYVpjTGdBcUdPZWRRc0xOVmdac1UybnArR1Q0VitYTk4zOTl2SmdCVkRmOEU4VkpzSjROYTc3L05IZFhjMGNpbTFybStRMTFMcXZPNW85RWc5cmNLNzVhakhrL1oiLCJtYWMiOiI5MGM3NmNhNjY2YWE1ZDlmNWEwZjMyZTk3OWEwNTk0YTg2ODhmZWViMzAzYjdjZDVkYzYxZDg5NWYyZmY5OTVjIn0%3D; expires=Fri, 09-Jul-2021 16:01:28 GMT; Max-Age=7200; path=/"},{"key":"Set-Cookie","value":"cosend_session=eyJpdiI6ImlEOTByQXQvcXVsZmw1NFM4ZmJ1VVE9PSIsInZhbHVlIjoiYTJkd0NndkdBekk4djN0cDZETHZvQ3FmeGMxbzd4OVJMY1dtbXhpSTl4SEl6TkNHemVLQi9zdzN3dDVlMWh6YmxEVm84V3Jxb3BoZ3lLbThMTElPaDBkb1dBYWxJUVcxcUl6cFJNU2h6aVpabGsxZmEwQ1pCczZXWU5iWXRjQUUiLCJtYWMiOiI2ZTcyOWFiNTMxMTI1YmQ2YTEwZTBmMWEzNjE0ZWI3YzMyOTY0ZjY4N2Q1ZTkwMzFhZWNlZDI4ZDAyMDM5Nzk0In0%3D; expires=Fri, 09-Jul-2021 16:01:28 GMT; Max-Age=7200; path=/; httponly"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"queued_for_deletion\": \"1,2,3\",\n \"skipped\": \"4,5,6\"\n}"},{"id":"bd55982b-84fc-44af-aac1-aa9cc6655e61","name":"Internal Server Error","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://your.domain.com/api/sent-items?brand_id=1&sent_post_ids=1,2,3","host":["https://your.domain.com"],"path":["api","sent-items"],"query":[{"key":"brand_id","value":"1","description":"(Required) The brand ID that the Sent Posts belong to"},{"key":"sent_post_ids","value":"1,2,3","description":"(Required) Comma separated list of the Sent Post IDs that you want to delete. Max 25 items."}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.4.21"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Fri, 09 Jul 2021 14:00:57 GMT"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"599"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IkRYc3NUWFpTdXBEdUNNL1I4L01pWkE9PSIsInZhbHVlIjoiM21BdGpyL013OHA5THUwVFlsclFqd0xneEdmVHV2MmRrRWFkcHlOSDJML3NUbFEwYW01WHhodnhKOEMwZVU0MHV3alZUd2I3VlpVMmVWdDRpVUdKUXY1TVpDR3ZqU0pLNTNxZFd1QnkydUZCT0dDZFdIbWpqUCtCNXZEZExkaFEiLCJtYWMiOiI0YWQ5OGJjMDkwNmQ2ZDc3ZGNmZjRkNzI2OWI5YjgzMjkxNTY5ZjQ4MWViNTdkOTMwZmFmYjRkOGUwMzk5NjEyIn0%3D; expires=Fri, 09-Jul-2021 16:00:57 GMT; Max-Age=7200; path=/"},{"key":"Set-Cookie","value":"cosend_session=eyJpdiI6IlNpNVN6Z29zWHFCaXdsVDRsNVVhVnc9PSIsInZhbHVlIjoidVF3cFFQK2tEaTNSWFFkcjlQcXF3a1RlSnFOVWdYTmhyOVpwUjB0SFZzOEMxY1pqS0RIckVOdy85ejNURi9IT20waEdsVkU5MTc3WXZTck4zQ2NTUUtRU1lhT3J4YTRzR21FaVdiRzlOQU91Nk1hM0thTTdiRE9DblZ1amJGajciLCJtYWMiOiJjOTFlMTFmZDg3MDliMjQ4MDc5YzI0OGQxYjk3MmIxYWExNWIyYmEwMWUxNmQ3NGNhYTEwMzU2ZmU0MjMyYjQ0In0%3D; expires=Fri, 09-Jul-2021 16:00:57 GMT; Max-Age=7200; path=/; httponly"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Something went wrong.\"\n}"},{"id":"f114eda8-d223-4598-9e0c-c312cb627d0a","name":"Unauthorised","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://your.domain.com/api/sent-items?brand_id=2&sent_post_ids=1,2,3","host":["https://your.domain.com"],"path":["api","sent-items"],"query":[{"key":"brand_id","value":"2","description":"(Required) The brand ID that the Sent Posts belong to"},{"key":"sent_post_ids","value":"1,2,3","description":"(Required) Comma separated list of the Sent Post IDs that you want to delete. Max 25 items."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.4.21"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Fri, 09 Jul 2021 14:01:49 GMT"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"597"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6Ik8xL3AzYzZuckZOSXN4K3BPc0dRWGc9PSIsInZhbHVlIjoieWQ0OG5oK01JZXl6UUQzNHZwVDdib3VKL1hlQXYzV3NicDlEVExrWEI4NzdGdy9VZllrVXpOM0t5Y1VSUlpGV3Y1cW9takdIVFlzZzVranBFM0tEZUVQRVZBUWRaWGJpVUt6SS95ZXpoOGhYcENRN0dQbHR4elcrUlY3OFI0anUiLCJtYWMiOiIwYTRkZTkwMDFiMWYwZDU1YjlmYzJlMzI1ZmM5MmJhMGYxNDllM2M1NzdlOTg5ZDM3YjQ4NzBjZDI1ZmJkN2E1In0%3D; expires=Fri, 09-Jul-2021 16:01:49 GMT; Max-Age=7200; path=/"},{"key":"Set-Cookie","value":"cosend_session=eyJpdiI6IlZNUVF1MDhMcjBMWVdPeWNLRWI0b2c9PSIsInZhbHVlIjoiN3ZqYWJuK0dXY1pROGcybnpRa21FR1RpQXkvamI3VitvODNLckY0T09KbHNUN2lrdmhUbzRnWWc5ODQwWWtmdTNOOXg3cmhmdmQ4RzEyQnY0ek1vZmRoaXF2QWxjNDdjbkVkRENQVXNaQjJrWDV5ZkhIaS9oZ3cyQkxMK2gxYkYiLCJtYWMiOiI2OWM2N2M1MTkwOTA0MDYwNTRlM2U3ZmMyMzczZjZmZjdmYmFlYTBjYzY4MzhhYTg0ZTNmZWFiOTIwZmFkZDI2In0%3D; expires=Fri, 09-Jul-2021 16:01:49 GMT; Max-Age=7200; path=/; httponly"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"You do not have permission to delete this Brands sent items.\"\n}"},{"id":"2aaa8d52-db1b-4942-a312-36b4bc94c7ff","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://your.domain.com/api/sent-items?brand_id=1&sent_post_ids=99999","host":["https://your.domain.com"],"path":["api","sent-items"],"query":[{"key":"brand_id","value":"1","description":"(Required) The brand ID that the Sent Posts belong to"},{"key":"sent_post_ids","value":"99999","description":"(Required) Comma separated list of the Sent Post IDs that you want to delete. Max 25 items."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/7.4.21"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Fri, 09 Jul 2021 14:02:42 GMT"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"599"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IjBBRjllNGp3QTdhTEFRbDdTZ003Z1E9PSIsInZhbHVlIjoiZHAwUmJBMU5jaGo0UWRkU0NxTmtmZG9HQ0JHZHFvRXJSUC83cHpFWVB5NVltUkdmeDdndFllTVdvZ1Vva1J6UDBTdVRERUx0bURnYW04eDhKb0VkWDh0ckcwS1FZekp4MkZjTEV3YkNRTUhKOVEwNmtkazUxNEowdzlPaHcvMGsiLCJtYWMiOiIxZGVlZDQ1MjFkMzliYzgyM2I1MjVjNDlhMGE3MzJkZGQ3MjI1ZGU5NzE3ZmNhOWVlY2JhZGVmY2E2YTM4N2Y2In0%3D; expires=Fri, 09-Jul-2021 16:02:42 GMT; Max-Age=7200; path=/"},{"key":"Set-Cookie","value":"cosend_session=eyJpdiI6ImJxOWhRWURVOVlIalM4ejNyVW1SdEE9PSIsInZhbHVlIjoiTE50YlNHenUwSzcreU81cndNN1M3NkwxWlVGa0hnNFByZ0JFLzZpalk4WlpqTk5BSVRJd1NMUVY0QUltbVJoQTBtN05PT3RaV09tM3F5cCtHV1pnbVhLR3VDc2RKell0TGQ1c3Nydy8rNG5ScnB1SnVTYmJvT040Q0V4clUrZDAiLCJtYWMiOiI5NGU0Yjg4NmFiMzRmZWNlMWVkZDgyZmQ1MjlhYWYzZjBlMTQ3MTllYTUyY2RhMGRiMDM5NTA0ZTM5NmI3MWFiIn0%3D; expires=Fri, 09-Jul-2021 16:02:42 GMT; Max-Age=7200; path=/; httponly"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No posts to delete\"\n}"}],"_postman_id":"7a650405-1151-4557-9c2d-d18d088cee42"}],"id":"4310bd74-6429-40e8-8a7d-782c18a0453a","_postman_id":"4310bd74-6429-40e8-8a7d-782c18a0453a","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}}},{"name":"Hints / Calendar Events","item":[{"name":"Get Calendar Events","id":"557cdf00-e874-4f4d-8394-9d9023db6fd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://your.domain.com/api/calendar-events?date=2021-10-11&end=2021-10-30&name=&type&limit=20&with_templates=1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","calendar-events"],"host":["https://your.domain.com"],"query":[{"description":{"content":"Start date. Format YYYY-MM-DD
\n","type":"text/plain"},"key":"date","value":"2021-10-11"},{"description":{"content":"End date. Format YYYY-MM-DD
\n","type":"text/plain"},"key":"end","value":"2021-10-30"},{"description":{"content":"Allows you to search for content hints by phrase (searches the content hint name)
\n","type":"text/plain"},"key":"name","value":""},{"description":{"content":"Specify the type of hint. 'system' or 'standard'
\n","type":"text/plain"},"key":"type","value":null},{"description":{"content":"The number of results that should be returned
\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"Boolean. Will include the most recent template for the Calendar Event (if available)
\n","type":"text/plain"},"key":"with_templates","value":"1"}],"variable":[]}},"response":[{"id":"88c6ed88-6bbc-4e30-bf69-ff28bf2f31bf","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://your.domain.com/api/calendar-events?date=2021-10-04&end=2021-10-30","host":["https://your.domain.com"],"path":["api","calendar-events"],"query":[{"key":"date","value":"2021-10-04","description":"Start date. Format YYYY-MM-DD"},{"key":"end","value":"2021-10-30","description":"End date. Format YYYY-MM-DD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/7.4.23"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 04 Oct 2021 10:52:49 GMT"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"587"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IktiUU94TG1HdFB6S0V6Z2gxQ2JlUkE9PSIsInZhbHVlIjoiRm9PUlJuRjVkQ3hGUmREZ2NwU29jQWg1NW05K2dqRGZOQzdBSjM1czdrVjN4WXd0elpoM1JNWDVodWlObVhBNCtLamdpTWdpTWNmdk5hbCs5bUlLSDhZeFR1RldMdjdzQlk4d2JWaWtYMFlTR0dsUHZ4dFRpd2ZzZExLczBYOXMiLCJtYWMiOiIzYTU2YzIyN2IwNzE2NDM2MWQwZDY3Yzc4YjkwODE1YWEyZWIyZDM2YmI3OTU2ZWRlNTM5MGFmYmZlYzQ5Y2Y0In0%3D; expires=Mon, 04-Oct-2021 12:52:49 GMT; Max-Age=7200; path=/"},{"key":"Set-Cookie","value":"cosend_session=eyJpdiI6InNySklxRVc4WHhRZzdkVGFGd0tsWlE9PSIsInZhbHVlIjoiR2w4bTFwUm5mNEFocDdjdm5EbGJCa2tucXN4akJkUWIveFVkYnVWUW1pSHFlZE5ucDZHbjZuQXdLSDZvV203ZWVGMDJaZFV3RzhzcDJMbThCcml1L24ybWtydTNPbUtUZmU4a3Zwb1lPN2J2MW1YT1RKTllzZVY4bHhnZ3l0ZGgiLCJtYWMiOiJhNzMzNDZhMWMxNGJhMjJhMzMxYWEzY2YwOGNkNTVlMTM3MWNhZjk2N2FlOTY3MGI5YWZhNmVkZWY1N2ViMmQ4In0%3D; expires=Mon, 04-Oct-2021 12:52:49 GMT; Max-Age=7200; path=/; httponly"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"calendarEvents\": [\n {\n \"id\": 1,\n \"name\": \"Example Calendar Event / Content Hint\",\n \"data\": null,\n \"start\": \"2021-09-09 00:00:00\",\n \"end\": \"2021-09-09 00:00:00\",\n \"created_at\": \"2021-09-09 07:35:22\",\n \"updated_at\": \"2021-09-09 07:35:22\",\n \"color\": \"#32b0f6\",\n \"user_id\": null,\n \"team_id\": null,\n \"recurrence\": null,\n \"type\": \"system\"\n }\n ]\n}"}],"_postman_id":"557cdf00-e874-4f4d-8394-9d9023db6fd1"},{"name":"Create Calendar Event","id":"c3cbdd84-1ead-4ae3-a544-ad50a7d53c11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"test3","description":"(Required) The name of the Calendar Event that gets shown to the end user
\n","type":"text"},{"key":"start","value":"2021-10-10","description":"(Required) The start date for the event. Format YYYY-MM-DD.
\n","type":"text"},{"key":"end","value":"2021-10-11","description":"(Required) The end date for the event. Format YYYY-MM-DD.
\n","type":"text"},{"key":"color","value":"#000000","description":"(Required) The color of the label in Hex format, e.g. #000000
\n","type":"text"},{"key":"type","value":"standard","description":"(Required) Standard = added to the logged-in user's team Calendar. System = shows in all team Calendars
\n","type":"text"}]},"url":"https://your.domain.com/api/calendar-events","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","calendar-events"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3cbdd84-1ead-4ae3-a544-ad50a7d53c11"},{"name":"Update Calendar Event","id":"d0fd30fe-e1f9-40ed-8e90-a4b83942f1d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"","description":"(Required) The name of the Calendar Event that gets shown to the end user
\n","type":"text"},{"key":"start","value":"","description":"(Required) The start date for the event. Format YYYY-MM-DD.
\n","type":"text"},{"key":"end","value":"","description":"(Required) The end date for the event. Format YYYY-MM-DD.
\n","type":"text"},{"key":"color","value":"","description":"(Required) The color of the label in Hex format, e.g. #000000
\n","type":"text"},{"key":"type","value":"","description":"(Required) Standard = added to the logged-in user's team Calendar. System = shows in all team Calendars
\n","type":"text"}]},"url":"https://your.domain.com/api/calendar-events/:id?name&start&end&color&type","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","calendar-events",":id"],"host":["https://your.domain.com"],"query":[{"description":{"content":"(Required) The name of the Calendar Event that gets shown to the end user
\n","type":"text/plain"},"key":"name","value":null},{"description":{"content":"(Required) The start date for the event. Format YYYY-MM-DD.
\n","type":"text/plain"},"key":"start","value":null},{"description":{"content":"(Required) The end date for the event. Format YYYY-MM-DD.
\n","type":"text/plain"},"key":"end","value":null},{"description":{"content":"(Required) The color of the label in Hex format, e.g. #000000
\n","type":"text/plain"},"key":"color","value":null},{"description":{"content":"(Required) Standard = added to the logged-in user's team Calendar. System = shows in all team Calendars
\n","type":"text/plain"},"key":"type","value":null}],"variable":[{"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"d0fd30fe-e1f9-40ed-8e90-a4b83942f1d3"},{"name":"Delete Calendar Event","id":"89502953-839a-41c1-965f-d163f99592ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://your.domain.com/api/calendar-events/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","calendar-events",":id"],"host":["https://your.domain.com"],"query":[],"variable":[{"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"89502953-839a-41c1-965f-d163f99592ab"}],"id":"6b5d8be5-882d-4d00-a8a9-c4fa796b0a73","_postman_id":"6b5d8be5-882d-4d00-a8a9-c4fa796b0a73","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}}}],"id":"8c820207-e5ab-4396-a6ed-889d353bc1a2","_postman_id":"8c820207-e5ab-4396-a6ed-889d353bc1a2","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}}},{"name":"Media Library","item":[{"name":"Folders","item":[{"name":"Create Folder","id":"e65870f8-1dcf-48e4-95aa-2d1554f382a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"type","description":"Leave blank unless creating a 'system' folder type. User must be a system admin to create system folders.
\n","type":"text","value":"(Required) The name of the folder as it will appear for the user
\n","type":"text"},{"key":"parent_id","value":"Only use if you're adding a folder. Leave blank to add to the root
\n","type":"text"}]},"url":"https://your.domain.com/api/folders","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","folders"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[{"id":"5acb30f6-ae1b-4b5e-af44-fb1e6d4f9445","name":"Successful response","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"type","description":"Leave blank unless creating a 'system' folder type. User must be a system admin to create system folders.","type":"text","value":""},{"key":"name","value":"(Required) The new name of the folder
\n","type":"text"}]},"url":"https://your.domain.com/api/folders/:folderId/rename","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","folders",":folderId","rename"],"host":["https://your.domain.com"],"query":[],"variable":[{"description":{"content":"The UUID of the folder you're renaming
\n","type":"text/plain"},"type":"any","value":"Returns folders for current Team (Brand) if left blank
\n","type":"text/plain"},"key":"team_id","value":""}],"variable":[]}},"response":[],"_postman_id":"34629bc8-5aea-4adc-977a-73b175ea70b9"},{"name":"Get list of Files in Folder","id":"728c689d-bf1c-4238-986a-6e04f2c7cd4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://your.domain.com/api/folders/:folderId/files?page=30 results are returned at a time, define the page you want to retrive
\n","type":"text/plain"},"key":"page","value":"Searches the meta data of the file
\n","type":"text/plain"},"key":"phrase","value":"Searches the tags associated with the file
\n","type":"text/plain"},"key":"tag","value":"Options are: root, all-system or the folder UUID
\n","type":"text/plain"},"type":"any","value":"","key":"folderId"}]}},"response":[],"_postman_id":"728c689d-bf1c-4238-986a-6e04f2c7cd4d"},{"name":"Delete Folder","id":"5a0ef55e-c811-4164-be23-568e6b2a97bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://your.domain.com/api/folders/:folderId","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","folders",":folderId"],"host":["https://your.domain.com"],"query":[],"variable":[{"description":{"content":"UUID of the folder being deleted. Note: will delete all child folders, and any media contained in the parent or child folders.
\n","type":"text/plain"},"type":"any","value":"","key":"folderId"}]}},"response":[{"id":"73fc0917-427a-44ae-a501-f38536b06e51","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://your.domain.com/api/folders/:folderId","host":["https://your.domain.com"],"path":["api","folders",":folderId"],"variable":[{"key":"folderId","value":"de1a3b57-4e7e-45d4-852e-a700a098466f"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/7.4.27"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Fri, 25 Feb 2022 07:42:54 GMT"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"599"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IjRNYzRwck1udjc2bnVWQ1RrM05BYkE9PSIsInZhbHVlIjoiTXI1d2RpTTJQbE9MR1d6bVFrQTdhTDl5c0I1MklPazdLYUVmaWRLc1hqVVRWZWRKZDFGYk9DV1h0R29vWmV2RnJlNUkwRXVFYWU1ditCRndhem0xblp1N2I5VXV3b0lxS2EwN283MEw1UGUwdVk2Y014akdXRno1NHRyUGc3enMiLCJtYWMiOiJkMjIzZmU0NzU2OGEyNjhkZDRlZGU1MjM1YTdiZTdkNjc3MmRmMDU5NGQ5ZWQyOTVmZmNiOTJlYmFhOWZiZjM1In0%3D; expires=Fri, 25-Feb-2022 09:42:54 GMT; Max-Age=7200; path=/"},{"key":"Set-Cookie","value":"cosend_session=eyJpdiI6InU5dnB6ZUVUMm5BRVYxd3N6NElVTXc9PSIsInZhbHVlIjoib053Q3Mwdjd6cEFDZjRSbEhFc2NTY2hOVGovdVN2aHpIS3haQXM5S0VnWG91a2cxdWQ1MWI0MTR0bUZjTitmejZwVVg3TWRFL3ZzditZQ0E0dXBpTzU2bUUwRkN6dElDbVpKbnAvSGFXZm1kSk1ycDc0ZlZiRU5RN3Y5NHNmREkiLCJtYWMiOiI4ZmQwN2ExOGNmNTBkYTI5YzdlNGNiNjAwODQ4MWZlZTEwMjNlYjkzYzNkZDQ5YTViMDFlZWM5MzU1OTEzNGRjIn0%3D; expires=Fri, 25-Feb-2022 09:42:54 GMT; Max-Age=7200; path=/; httponly"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Success.\"\n}"}],"_postman_id":"5a0ef55e-c811-4164-be23-568e6b2a97bb"}],"id":"99a38ddc-88bb-4c32-8056-350bb28a7b4d","_postman_id":"99a38ddc-88bb-4c32-8056-350bb28a7b4d","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}}},{"name":"Uploads","item":[{"name":"Upload Media to Root Folder","id":"5e27782a-e0cb-4fcc-ba1c-6e4aa82867fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"media","description":"(Required) File to be uploaded
\n","type":"text","value":"The file being referenced is a URL (the system will download it) - defauls to false
\n","type":"text"},{"key":"brand_id","value":"Brand ID
\n","type":"text"}]},"url":"https://your.domain.com/api/media/upload/public","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","media","upload","public"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[{"id":"8a78ec80-9013-40b8-81c5-074eec2f5de3","name":"specify a valid API key","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://your.domain.com/media/upload/public?media=(Required) File to be uploaded
\n","type":"text","value":"(Required) ID of media file
\n","type":"text"},{"key":"file","type":"file","value":null}]},"url":"https://your.domain.com/api/media/upload/thumbnail","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","media","upload","thumbnail"],"host":["https://your.domain.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3e7d7750-6d74-4cda-ae0a-4511b5fc6f43"}],"id":"5aed51bf-ffad-458a-9e31-221d969e82f7","_postman_id":"5aed51bf-ffad-458a-9e31-221d969e82f7","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}}},{"name":"Files","item":[{"name":"Update File","id":"e91c6e75-88c7-401a-8e89-e267336915cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"notes","value":"This is my note","description":"The notes for the file
\n","type":"text"}]},"url":"https://your.domain.com/api/media/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}},"urlObject":{"path":["api","media",":id"],"host":["https://your.domain.com"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"e91c6e75-88c7-401a-8e89-e267336915cd"}],"id":"4dd5c19e-7dc6-4fbe-8d83-70772242ed7f","_postman_id":"4dd5c19e-7dc6-4fbe-8d83-70772242ed7f","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a48d7a9d-a701-4c18-a2db-b20567042c67","id":"a48d7a9d-a701-4c18-a2db-b20567042c67","name":"CoSend","type":"collection"}}},{"name":"Get size of used storage","id":"7dfb0068-09a1-4098-94a7-edbcb959eeec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://your.domain.com/api/media/storage/usage?brand_id=Brand ID
\n","type":"text/plain"},"key":"brand_id","value":"Folder ID. If left blank usage for all folders will be shown. Enter root for the top level folder.
\n","type":"text/plain"},"key":"folder_id","value":"