{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"44989a9d-eb61-43fb-b1ee-7b58c02d266f","name":"PatchCue API","description":"# About PatchCue\n\nSoftware companies use **PatchCue** to automate publication of release notes and notify customers using an omnichannel messaging strategy.\n\nSign up for PatchCue at **app.patchcue.com/signup**\n\n# API Overview\n\n## API Host\n\nAll PatchCue API requests are required to be made on the host, `api.patchcue.com`. Request formats requesting JSON on PatchCue subdomain hosts (yousite.patchcue.com) will return a **404 Not Found**.\n\n## Creating an API Client\n\nTo build against the PatchCue API, you'll need to create an API Client, which is makes available credentials needed to authorize your requests.\n\nTo create a new API Client, navigate to **Organization > Manage Users**, then find the **Manage API Clients** section. Click on **Create New API Credentials** to create a new API Client.\n\nAfter your API Client is created, you can use the **Client ID** and **Client Secret** to retrieve an Access Token.\n\n<img src=\"https://content.pstmn.io/98c587a3-b1a9-4497-925f-613cd0b7825f/Y29weS1jbGllbnQtc2VjcmV0LXRvLWNsaXBib2FyZC5wbmc=\">\n\n## Retrieve an Access Token\n\nPatchCue tenants support multiple active API Clients. After you've created an API Client, use the **Request Access Token** request to exchange the `client_id` and `client_secret` for an `access_token`.\n\n## Authorized Requests\n\nAll PatchCue API requests require the following headers to be provided:\n\n`Request-Client-Id: {{your_client_id}}`\n\n`Authorization: Bearer {{your_access_token}}`\n\n## Resources\n\nAll PatchCue resources are uniquely identified by an `id` string property. All `id` values follow a `prefix_identifier` convention. For example, a **Product** ID in PatchCue would look like: `prod_00asq16w2gfw4v61tx1awa4whx`.\n\nEach resource type has it's own id prefix.\n\n**Unique ID prefixes:**\n\n- **Product** - `prod_`\n- **Release Channel** - `prch_`\n- **Product Version** - `pver_`\n- **Note** - `note_`\n- **Label -** `label_`\n    \n\n## Resource Responses\n\nRequests which return resources will include those resources in a root key. For example, a **List Product** request will return an object containing a collection of products located in a **products** (plural) root key.\n\nRequests which return a singular object (**Get Product**) will return the resulting object in a **product** (singular) root key.\n\n# Resource Format\n\nAll PatchCue resources are expected to be returned as JSON. The following HTTP header is required:\n\n`Accept: application/json`\n\n**A note on Content-Type**\n\nThe `Content-Type: application/json` header is optional, as JSON is the inferred format.\n\n# Endpoints","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"36639727","team":6337391,"collectionId":"44989a9d-eb61-43fb-b1ee-7b58c02d266f","publishedId":"2sA3e1A9M8","public":true,"publicUrl":"https://apidocs.patchcue.com","privateUrl":"https://go.postman.co/documentation/36639727-44989a9d-eb61-43fb-b1ee-7b58c02d266f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4f46e5"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Software companies use PatchCue to automate publication of release notes and notify customers using an omnichannel messaging strategy."},{"name":"title","value":"Automate Release Notes and Notifications using the PatchCue API"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/18a70765-6037-407f-8968-edf205dcc2b9/cGF0Y2hjdWUtbG9nby5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"4f46e5"}},{"name":"light","logo":"https://content.pstmn.io/18a70765-6037-407f-8968-edf205dcc2b9/cGF0Y2hjdWUtbG9nby5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4f46e5"}}]}},"version":"8.10.1","publishDate":"2024-07-12T03:26:00.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Automate Release Notes and Notifications using the PatchCue API","description":"Software companies use PatchCue to automate publication of release notes and notify customers using an omnichannel messaging strategy."},"logos":{"logoLight":"https://content.pstmn.io/18a70765-6037-407f-8968-edf205dcc2b9/cGF0Y2hjdWUtbG9nby5wbmc=","logoDark":"https://content.pstmn.io/18a70765-6037-407f-8968-edf205dcc2b9/cGF0Y2hjdWUtbG9nby5wbmc="}},"statusCode":200},"environments":[{"name":"api.patchcue.com","id":"de6cd788-3475-4181-b900-7e23a8df70af","owner":"36639727","values":[{"key":"root_url","value":"https://api.patchcue.com","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/9627ef68472294f407d53636800514c6b79774302eab729cc32f6ea6c6568f84","favicon":"https://patchcue.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"api.patchcue.com","value":"36639727-de6cd788-3475-4181-b900-7e23a8df70af"}],"canonicalUrl":"https://apidocs.patchcue.com/view/metadata/2sA3e1A9M8"}