{"info":{"_postman_id":"0de6f651-e31f-4fb3-b432-9f4f7ca55b0e","name":"API documentation","description":"<html><head></head><body><p>Official Drop Cowboy Postman Collection: APIs, docs, and resources for voice &amp; text messaging.</p>\n<hr>\n<h1 id=\"thanks-for-stopping-by-this-space-contains-the-official-drop-cowboy-postman-collection\">Thanks for stopping by! This space contains the official Drop Cowboy Postman collection.</h1>\n<p>Just fork the collection to your workspace to immediately begin testing our API endpoints. You'll find everything you need to start building, including ready-to-use requests, examples, and detailed documentation.</p>\n<hr>\n<h2 id=\"connect-with-us\">Connect With Us</h2>\n<ul>\n<li><p>Email: <a href=\"https://mailto:info@dropcowboy.com\">info@dropcowboy.com</a></p>\n</li>\n<li><p>Website: <a href=\"https://www.dropcowboy.com/?utm_source=postman\">Drop Cowboy Website</a></p>\n</li>\n<li><p>LinkedIn: <a href=\"https://www.linkedin.com/company/ringlessvoicemail\">@RinglessVoicemail</a></p>\n</li>\n<li><p>Facebook: <a href=\"https://www.facebook.com/dropcowboy\">@DropCowboy</a></p>\n</li>\n<li><p>GitHub: <a href=\"https://github.com/Drop-Cowboy\">@Drop-Cowboy</a></p>\n</li>\n<li><p>X: <a href=\"https://x.com/DropCowboy\">@DropCowboy</a></p>\n</li>\n</ul>\n<hr>\n<h2 id=\"related-resources\">Related Resources</h2>\n<ul>\n<li><p><a href=\"https://drop-cowboy.gitbook.io/drop-cowboy-docs/\">GitBook Documentation</a></p>\n</li>\n<li><p><a href=\"https://openapi.gitbook.com/o/YMHSxyoqvIdTRVRI2PAH/spec/drop-cowboy-api.yaml\">OpenAPI Spec | YAML</a></p>\n</li>\n</ul>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Thanks for stopping by! This space contains the official Drop Cowboy Postman collection.","slug":"thanks-for-stopping-by-this-space-contains-the-official-drop-cowboy-postman-collection"}],"owner":"39210482","collectionId":"0de6f651-e31f-4fb3-b432-9f4f7ca55b0e","publishedId":"2sB3QFSD9C","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"26aae0"},"publishDate":"2025-10-01T20:56:07.000Z"},"item":[{"name":"RVM (Ringless Voicemail)","item":[{"name":"Send Ringless Voicemail","event":[{"listen":"test","script":{"id":"6e6a2b49-7f1a-43d6-bed2-dac826326263","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"a3e64c0f-f32a-4954-8d05-58858c3d1400","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"team_id\": \"<your team_id>\",\r\n    \"secret\": \"<your secret>\",\r\n    \"brand_id\": \"00000000-0000-0000-0000-000000000000\",\r\n    \"recording_id\": \"00000000-0000-0000-0000-000000000000\",\r\n    \"phone_number\": \"+15552223333\",\r\n    \"forwarding_number\": \"+15557778888\",\r\n    \"foreign_id\": \"<your system value>\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dropcowboy.com/v1/rvm","description":"<h2 id=\"attributes\">Attributes</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th>Description</th>\n<th>Required</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>team_id</td>\n<td>STRING</td>\n<td>Located in <strong>API Settings</strong> tab. Example:</td>\n<td>✅</td>\n</tr>\n<tr>\n<td>secret</td>\n<td>STRING</td>\n<td>Located in <strong>API Settings</strong> tab. Example:</td>\n<td>✅</td>\n</tr>\n<tr>\n<td>foreign_id</td>\n<td>STRING</td>\n<td>Identifier in your system, passed back in webhook. Max 256 chars. Example:</td>\n<td>Optional</td>\n</tr>\n<tr>\n<td>brand_id</td>\n<td>STRING</td>\n<td>Located in <strong>Trust Center</strong> tab. Example:</td>\n<td>✅</td>\n</tr>\n<tr>\n<td>recording_id</td>\n<td>STRING</td>\n<td>ID of audio recording (from <strong>Recordings</strong> tab). Example: <code>15552223333</code></td>\n<td>Conditional</td>\n</tr>\n<tr>\n<td>voice_id</td>\n<td>STRING</td>\n<td>ID of Mimic AITM voice (from <strong>Voices</strong> tab). Must be used with <code>tts_body</code>. Example:</td>\n<td>Conditional</td>\n</tr>\n<tr>\n<td>tts_body</td>\n<td>STRING</td>\n<td>Text for Mimic AITM to convert to speech. Example: <code>\"Hey Joe, this is Bob...\"</code></td>\n<td>Conditional</td>\n</tr>\n<tr>\n<td>audio_url</td>\n<td>STRING</td>\n<td>URL of hosted voicemail audio (mp3/wav). Requires special approval. Example: <code>https://example.com/file.mp3</code></td>\n<td>Conditional</td>\n</tr>\n<tr>\n<td>audio_type</td>\n<td>STRING</td>\n<td>File type of <code>audio_url</code>. <code>mp3</code> or <code>wav</code>.</td>\n<td>Conditional</td>\n</tr>\n<tr>\n<td>phone_number</td>\n<td>STRING</td>\n<td>Recipient phone number (E.164). Example: <code>+15552223333</code></td>\n<td>✅</td>\n</tr>\n<tr>\n<td>forwarding_number</td>\n<td>STRING</td>\n<td>Forwarding number for replies (E.164). Example: <code>+15557778888</code></td>\n<td>Optional</td>\n</tr>\n<tr>\n<td>phone_ivr_id</td>\n<td>STRING</td>\n<td>Optional IVR ID (from <strong>Phone IVR</strong> tab). Example:</td>\n<td>Optional</td>\n</tr>\n<tr>\n<td>pool_id</td>\n<td>STRING</td>\n<td>Private number pool ID. Defaults to public shared pool.</td>\n<td>Optional</td>\n</tr>\n<tr>\n<td>postal_code</td>\n<td>STRING</td>\n<td>Contact postal/zip for TCPA compliance. Example: <code>90210</code></td>\n<td>Optional</td>\n</tr>\n<tr>\n<td>callback_url</td>\n<td>STRING</td>\n<td>Override default webhook URL in settings. Example: <code>http://example.com</code></td>\n<td>Optional</td>\n</tr>\n<tr>\n<td>byoc</td>\n<td>OBJECT</td>\n<td>Wholesale option: SIP Trunks and STIR/SHAKEN credentials. <em>Contact support for details.</em></td>\n<td>Optional</td>\n</tr>\n</tbody>\n</table>\n</div><hr />\n<h2 id=\"example-requests\">Example Requests</h2>\n<h3 id=\"pre-recorded-audio-recording_id\">Pre-recorded Audio (<code>recording_id</code>)</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-bash\">curl --header \"Content-Type: application/json\" \n--data '{\"team_id\":\"\",\"secret\":\"\",\"brand_id\":\"00000000-0000-0000-0000-000000000000\",\"recording_id\":\"00000000-0000-0000-0000-000000000000\",\"phone_number\":\"+15552223333\",\"forwarding_number\":\"+15557778888\",\"foreign_id\":\"\"}' \nhttps://api.dropcowboy.com/v1/rvm\n\n</code></pre>\n<h3 id=\"mimic-ai-voice-voice_idtts_body\">Mimic AI Voice (<code>voice_id</code>+<code>tts_body</code>)</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-bash\">curl --header \"Content-Type: application/json\" \\\n--data &amp;#x27;{\"team_id\":\"&lt;your team_id&gt;\",\"secret\":\"&lt;your secret&gt;\",\"brand_id\":\"00000000-0000-0000-0000-000000000000\",\"voice_id\":\"00000000-0000-0000-0000-000000000000\",\"tts_body\":\"Hello Jane, this is John from Brand calling about...\",\"phone_number\":\"+15552223333\",\"forwarding_number\":\"+15557778888\",\"foreign_id\":\"&lt;your system value&gt;\"}&amp;#x27; \\\nhttps://api.dropcowboy.com/v1/rvm\n\n</code></pre>\n<h3 id=\"hosted-audio-audio_url\">Hosted Audio (<code>audio_url</code>)</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-bash\">curl --header \"Content-Type: application/json\" \\\n--data &amp;#x27;{\"team_id\":\"&lt;your team_id&gt;\",\"secret\":\"&lt;your secret&gt;\",\"brand_id\":\"00000000-0000-0000-0000-000000000000\",\"audio_url\":\"https://example.com/your-file.mp3\",\"audio_type\":\"mp3\",\"phone_number\":\"+15552223333\",\"forwarding_number\":\"+15557778888\",\"foreign_id\":\"&lt;your system value&gt;\"}&amp;#x27; \\\nhttps://api.dropcowboy.com/v1/rvm\n\n</code></pre>\n<hr />\n<h2 id=\"results-callback-webhook\">Results (Callback Webhook)</h2>\n<h3 id=\"success-example\">Success Example</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"drop_id\": \"5c8eb7940a057a4ab0823e1a\",\n  \"phone_number\": \"+15552224444\",\n  \"attempt_date\": \"2019-03-17T21:10:26.000Z\",\n  \"status\": \"success\",\n  \"reason\": \"\",\n  \"dnc\": false,\n  \"product_cost\": 0.099,\n  \"compliance_fee\": 0.0029,\n  \"tts_fee\": 0.03,\n  \"network\": {\n    \"name\": \"Verizon Wireless:6006 - SVR/2\",\n    \"type\": \"wireless\"\n  },\n  \"foreign_id\": \"&lt;your system value&gt;\"\n}\n\n</code></pre>\n<h3 id=\"failure-example\">Failure Example</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"drop_id\": \"5c8ee427a8d9ef4758bfaca5\",\n  \"phone_number\": \"+15552224444\",\n  \"attempt_date\": \"2019-03-18T00:20:26.000Z\",\n  \"status\": \"failure\",\n  \"reason\": \"VoiceMail NotDetected\",\n  \"dnc\": false,\n  \"product_cost\": 0,\n  \"compliance_fee\": 0.0029,\n  \"tts_fee\": 0.03,\n  \"network\": {\n    \"name\": \"Verizon Wireless:6006 - SVR/2\",\n    \"type\": \"wireless\"\n  },\n  \"foreign_id\": \"&lt;your system value&gt;\"\n}\n\n</code></pre>\n<hr />\n<h2 id=\"possible-error-reasons\">Possible Error Reasons</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Name</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Error from SIP Server</td>\n<td>Number unreachable, usually out of service.</td>\n</tr>\n<tr>\n<td>Temporarily unreachable</td>\n<td>Localized carrier outage.</td>\n</tr>\n<tr>\n<td>VoiceMail NotDetected</td>\n<td>Number has no voicemail capability.</td>\n</tr>\n<tr>\n<td>No Funds</td>\n<td>Insufficient account balance.</td>\n</tr>\n<tr>\n<td>Known Litigator</td>\n<td>Number flagged as TCPA litigator.</td>\n</tr>\n<tr>\n<td>Not Mobile</td>\n<td>Landline detected (UI only, not API).</td>\n</tr>\n<tr>\n<td>User Busy</td>\n<td>Carrier actively rejected voicemail attempt (e.g., spam filtered).</td>\n</tr>\n<tr>\n<td>Internal DNC</td>\n<td>Number is in your Drop Cowboy DNC list.</td>\n</tr>\n<tr>\n<td>TCPA Hours</td>\n<td>Attempt outside of TCPA compliant hours.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["rvm"],"host":["https://api.dropcowboy.com/v1"],"query":[],"variable":[]}},"response":[{"id":"60acae15-658c-49c3-bef7-e4ee6cb179a0","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"team_id\": \"<your team_id>\",\r\n    \"secret\": \"<your secret>\",\r\n    \"brand_id\": \"00000000-0000-0000-0000-000000000000\",\r\n    \"recording_id\": \"00000000-0000-0000-0000-000000000000\",\r\n    \"phone_number\": \"+15552223333\",\r\n    \"forwarding_number\": \"+15557778888\",\r\n    \"foreign_id\": \"<your system value>\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dropcowboy.com/v1/rvm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{ \"status\": \"queued\" }"}],"_postman_id":"a3e64c0f-f32a-4954-8d05-58858c3d1400"}],"id":"3aba240c-91ff-44ec-a238-cc4da0faf65e","description":"<h1 id=\"sending-ringless-voicemail-via-api\">Sending Ringless Voicemail via API</h1>\n<p>Directly integrate <strong>ringless voicemail delivery</strong> into your software.<br />Successful deliveries are deducted from your account balance based on the rate dictated by your monthly subscription plan.</p>\n<p>Invoke the Drop Cowboy API from your application by sending an HTTP <strong>POST</strong> containing a JSON document with the attributes listed below.</p>\n<p>Once delivery is attempted, you will receive a callback containing the delivery status to the webhook specified in your API settings.</p>\n","_postman_id":"3aba240c-91ff-44ec-a238-cc4da0faf65e"},{"name":"SMS (Text Messages)","item":[{"name":"Send SMS Text Messages","event":[{"listen":"test","script":{"id":"6e6a2b49-7f1a-43d6-bed2-dac826326263","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"0dc93340-26a2-4a0c-a0ab-4b40880e6bf7","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"team_id\": \"<your team_id>\",\r\n    \"secret\": \"<your secret>\",\r\n    \"brand_id\": \"00000000-0000-0000-0000-000000000000\",\r\n    \"sms_body\": \"Hello world!\",\r\n    \"opt_in\": true,\r\n    \"phone_number\": \"+15552223333\",\r\n    \"caller_id\": \"+15557778888\",\r\n    \"foreign_id\": \"<your system value>\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dropcowboy.com/v1/sms","description":"<h2 id=\"attributes\">Attributes</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th>Description</th>\n<th>Required</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>team_id</td>\n<td>STRING</td>\n<td>Located in <strong>API Settings</strong> tab. Example: <code>&lt;Your Account&gt;</code></td>\n<td>✅</td>\n</tr>\n<tr>\n<td>secret</td>\n<td>STRING</td>\n<td>Located in <strong>API Settings</strong> tab. Example: <code>&lt;Your Secret&gt;</code></td>\n<td>✅</td>\n</tr>\n<tr>\n<td>phone_number</td>\n<td>STRING</td>\n<td>Your contact's phone number in E.164 format.  <br />Example: <code>15552223333</code></td>\n<td>✅</td>\n</tr>\n<tr>\n<td>caller_id</td>\n<td>STRING</td>\n<td>The phone number to forward calls and texts to when the contact replies to your message. Must be in E.164 format.  <br />Example: <code>15557778888</code></td>\n<td>✅</td>\n</tr>\n<tr>\n<td>pool_id</td>\n<td>STRING</td>\n<td>The ID of the private number pool you registered to send SMS messages.</td>\n<td>✅</td>\n</tr>\n<tr>\n<td>sms_body</td>\n<td>STRING</td>\n<td>Plain text containing your message. Character limit is 160.  <br />Example: <code>Hello world</code></td>\n<td>✅</td>\n</tr>\n<tr>\n<td>opt_in</td>\n<td>BOOLEAN</td>\n<td>Confirmation that you obtained OPT-IN permission to send SMS to the recipient as required by law.  <br />Example: <code>true</code></td>\n<td>✅</td>\n</tr>\n<tr>\n<td>callback_url</td>\n<td>STRING</td>\n<td>Override the default RVM webhook url that you specified in your API settings.  <br />Example: <code>https://example.com</code></td>\n<td>Optional</td>\n</tr>\n<tr>\n<td>foreign_id</td>\n<td>STRING</td>\n<td>A value to identify this drop in your system. Will be passed through to you in the webhook callback. Max length 256 characters.  <br />Example: <code>&lt;Your system's ID&gt;</code></td>\n<td>Optional</td>\n</tr>\n</tbody>\n</table>\n</div><hr />\n<h2 id=\"example\">Example</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-bash\">curl --header \"Content-Type: application/json\"\n--data \"{\"team_id\": \"&lt;your team_id&gt;\", \"secret\": \"&lt;your secret&gt;\", \"brand_id\": \"00000000-0000-0000-0000-000000000000\", \"sms_body\": \"Hello world!\", \"opt_in\": true, \"phone_number\": \"+15552223333\", \"caller_id\":\"+15557778888\", \"foreign_id\": \"&lt;your system value&gt;\"}\"\nhttps://api.dropcowboy.com/v1/sms\n\n</code></pre>\n<hr />\n<h2 id=\"results-callback-webhook\">Results (Callback Webhook)</h2>\n<h3 id=\"success-example\">Success Example</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"drop_id\": \"5c8eb7940a057a4ab0823e1a\",\n    \"phone_number\": \"+15552224444\",\n    \"attempt_date\": \"2019-03-17T21:10:26.000Z\",\n    \"status\": \"success\",\n    \"reason\": \"\",\n    \"dnc\": false,\n    \"spam\": false,\n    \"product_cost\": 0.099,\n    \"compliance_fee\": 0.0029,\n    \"tts_fee\": 0,\n    \"network\": {\n        \"name\": \"Verizon Wireless:6006 - SVR/2\",\n        \"type\": \"wireless\"\n    },\n    \"foreign_id\": \"&lt;your system&amp;#x27;s id&gt;\"\n}\n\n</code></pre>\n<h3 id=\"failure-example\">Failure Example</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"drop_id\": \"5c8ee427a8d9ef4758bfaca5\",\n    \"phone_number\": \"+15552224444\",\n    \"attempt_date\": \"2019-03-18T00:20:26.000Z\",\n    \"status\": \"failure\",\n    \"reason\": \"Invalid message\",\n    \"dnc\": false,\n    \"spam\": false,\n    \"product_cost\": 0,\n    \"compliance_fee\": 0.0029,\n    \"tts_fee\": 0,\n    \"network\": {\n        \"name\": \"Verizon Wireless:6006 - SVR/2\",\n        \"type\": \"wireless\"\n    },\n    \"foreign_id\": \"&lt;your system&amp;#x27;s id&gt;\"\n}\n\n</code></pre>\n<hr />\n<h2 id=\"possible-error-reasons\">Possible Error Reasons</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Name</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Invalid message</td>\n<td>The contents of your SMS message are not acceptable or violate S.H.A.F.T</td>\n</tr>\n<tr>\n<td>Spam detected</td>\n<td>The phone carrier determined your message is spam.</td>\n</tr>\n<tr>\n<td>Invalid caller ID or not SMS enabled</td>\n<td>SMS does not support arbitrary caller IDs. You must use a phone number rented from Drop Cowboy as your caller ID.</td>\n</tr>\n<tr>\n<td>No Funds</td>\n<td>Insufficient account balance.</td>\n</tr>\n<tr>\n<td>Known Litigator</td>\n<td>Number flagged as TCPA litigator.</td>\n</tr>\n<tr>\n<td>Prohibited by carrier or not SMS enabled</td>\n<td>The phone number does not support SMS or the carrier blocked delivery of your message.</td>\n</tr>\n<tr>\n<td>Message too long</td>\n<td>Your message must be less than 160 characters in length.</td>\n</tr>\n<tr>\n<td>Opted out</td>\n<td>The phone number opted-out from receiving SMS from you.</td>\n</tr>\n<tr>\n<td>Internal DNC</td>\n<td>Number is in your Drop Cowboy DNC list.</td>\n</tr>\n<tr>\n<td>Temporarily unreachable</td>\n<td>The phone number is experiencing a localized service outage.</td>\n</tr>\n<tr>\n<td>Too Many</td>\n<td>You tried to send to the same phone number more than 3 times in 3 days.</td>\n</tr>\n<tr>\n<td>Unregistered Brand</td>\n<td>You didn't pass brand_id or your brand is not registered yet.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["sms"],"host":["https://api.dropcowboy.com/v1"],"query":[],"variable":[]}},"response":[{"id":"4354a3ab-3435-4c78-9db1-806404893fea","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"team_id\": \"<your team_id>\",\r\n    \"secret\": \"<your secret>\",\r\n    \"brand_id\": \"00000000-0000-0000-0000-000000000000\",\r\n    \"sms_body\": \"Hello world!\",\r\n    \"opt_in\": true,\r\n    \"phone_number\": \"+15552223333\",\r\n    \"caller_id\": \"+15557778888\",\r\n    \"foreign_id\": \"<your system value>\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dropcowboy.com/v1/sms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{ \"status\": \"queued\" }"}],"_postman_id":"0dc93340-26a2-4a0c-a0ab-4b40880e6bf7"}],"id":"773b099c-0311-4568-a3dc-88f5f3f98d7a","description":"<p>Invoke our api from your application by sending an HTTP POST containing a json document with the attributes listed below. Once delivery is attempted, you will receive a callback containing the delivery status to the webhook you specified in your api settings.</p>\n","_postman_id":"773b099c-0311-4568-a3dc-88f5f3f98d7a"},{"name":"Recordings","item":[{"name":"Listing Recordings (Legacy)","id":"8733981c-d12c-440c-a19f-aa664acbaefc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-team-id","value":"","description":"<p>REQUIRED | The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -&gt; API page.</p>\n","type":"text"},{"key":"x-secret","value":"","description":"<p>REQUIRED | The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -&gt; API page.</p>\n","type":"text"}],"url":"https://api.dropcowboy.com/v1/media","description":"<h2 id=\"get-media-legacy\">Get Media (Legacy)</h2>\n<p>This endpoint retrieves a list of media items from the server.</p>\n<p><strong>*Note:</strong> This route is <strong>legacy</strong> and will <strong>no longer receive updates</strong>. Please use the <strong>current route</strong> (<code>/recording</code>) for all future implementations.</p>\n<h3 id=\"request\">Request</h3>\n<ul>\n<li><p><strong>Method</strong>: GET</p>\n</li>\n<li><p><strong>Endpoint</strong>: <code>https://api.dropcowboy.com/v1/media</code></p>\n</li>\n</ul>\n<h3 id=\"response\">Response</h3>\n<p>The response is a JSON array containing media objects with the following structure:</p>\n<ul>\n<li><p><strong>media_id</strong> (string): A unique identifier for the media item.</p>\n</li>\n<li><p><strong>name</strong> (string): The name of the media item.</p>\n</li>\n<li><p><strong>created_at</strong> (integer): A timestamp indicating when the media item was created.</p>\n</li>\n<li><p><strong>api_allowed</strong> (boolean): A flag indicating whether the API allows access to this media item.</p>\n</li>\n</ul>\n<h3 id=\"example-response\">Example Response</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n    {\n        \"media_id\": \"\",\n        \"name\": \"\",\n        \"created_at\": 0,\n        \"api_allowed\": true\n    }\n]\n\n</code></pre>\n","urlObject":{"path":["media"],"host":["https://api.dropcowboy.com/v1"],"query":[],"variable":[]}},"response":[{"id":"6b304831-25dc-4465-9b16-6e65b870db37","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-team-id","value":"","type":"text"},{"key":"x-secret","value":"","type":"text"}],"url":"https://api.dropcowboy.com/v1/media"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n    {\n        \"media_id\": \"abcace9b-471c-4c77-8c07-0bcba83f9abc\",\n        \"name\": \"My Audio Recording\",\n        \"created_at\": 1719344977000,\n        \"api_allowed\": false\n    },\n    {\n        \"media_id\": \"ba2ace9b-471c-4c77-8c07-0bcba83f9xyz\",\n        \"name\": \"Another Recording\",\n        \"created_at\": 1719344977000,\n        \"api_allowed\": true\n    }\n]"}],"_postman_id":"8733981c-d12c-440c-a19f-aa664acbaefc"},{"name":"Listing Recordings (Current)","id":"37cd832a-ba83-4227-8b2c-8d5e7d877eb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-team-id","value":"","description":"<p>REQUIRED | The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -&gt; API page.</p>\n","type":"text"},{"key":"x-secret","value":"","description":"<p>REQUIRED | The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -&gt; API page.</p>\n","type":"text"}],"url":"https://api.dropcowboy.com/v1/recording","description":"<h2 id=\"get-recordings\">Get Recordings</h2>\n<p>This endpoint retrieves a list of recording items from the server.</p>\n<h3 id=\"request\">Request</h3>\n<ul>\n<li><p><strong>Method</strong>: GET</p>\n</li>\n<li><p><strong>Endpoint</strong>: <code>https://api.dropcowboy.com/v1/recording</code></p>\n</li>\n</ul>\n<h3 id=\"response\">Response</h3>\n<p>The response is a JSON array containing media objects with the following structure:</p>\n<ul>\n<li><p><strong>media_id</strong> (string): A unique identifier for the media item.</p>\n</li>\n<li><p><strong>name</strong> (string): The name of the media item.</p>\n</li>\n<li><p><strong>created_at</strong> (integer): A timestamp indicating when the media item was created.</p>\n</li>\n<li><p><strong>api_allowed</strong> (boolean): A flag indicating whether the API allows access to this media item.</p>\n</li>\n</ul>\n<h3 id=\"example-response\">Example Response</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n    {\n        \"media_id\": \"\",\n        \"name\": \"\",\n        \"created_at\": 0,\n        \"api_allowed\": true\n    }\n]\n\n</code></pre>\n","urlObject":{"path":["recording"],"host":["https://api.dropcowboy.com/v1"],"query":[{"disabled":true,"description":{"content":"<p>Filter results by whether recordings are API-approved</p>\n","type":"text/plain"},"key":"api_allowed","value":""}],"variable":[]}},"response":[{"id":"a36ebe4a-7933-40d7-bc78-a13e6e56fc77","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-team-id","value":"","type":"text"},{"key":"x-secret","value":"","type":"text"}],"url":{"raw":"https://api.dropcowboy.com/v1/recording","host":["https://api.dropcowboy.com/v1"],"path":["recording"],"query":[{"key":"api_allowed","value":null,"description":"Filter results by whether recordings are API-approved","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n    {\n        \"media_id\": \"abcace9b-471c-4c77-8c07-0bcba83f9abc\",\n        \"name\": \"My Audio Recording\",\n        \"created_at\": 1719344977000,\n        \"api_allowed\": false\n    },\n    {\n        \"media_id\": \"ba2ace9b-471c-4c77-8c07-0bcba83f9xyz\",\n        \"name\": \"Another Recording\",\n        \"created_at\": 1719344977000,\n        \"api_allowed\": true\n    }\n]"}],"_postman_id":"37cd832a-ba83-4227-8b2c-8d5e7d877eb2"}],"id":"95b726ba-ff2e-4996-a5fa-68572982bbeb","description":"<p>Invoke our recordings api from your application by sending an HTTP GET containing with the attributes listed below.</p>\n","_postman_id":"95b726ba-ff2e-4996-a5fa-68572982bbeb"},{"name":"Brands","item":[{"name":"Listing Brands","id":"fc19e829-8b4a-431e-908a-6d00f34b8e57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-team-id","value":"","description":"<p>REQUIRED | The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -&gt; API page.</p>\n","type":"text"},{"key":"x-secret","value":"","description":"<p>REQUIRED | The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -&gt; API page.</p>\n","type":"text"}],"url":"https://api.dropcowboy.com/v1/brand","description":"<h2 id=\"endpoint-get-baseurlbrand\">Endpoint: <code>GET https://api.dropcowboy.com/v1/brand</code></h2>\n<p>This endpoint retrieves a list of brands from the server. It is used to obtain information about various brands, including their identifiers and associated company details.</p>\n<h3 id=\"request-parameters\">Request Parameters</h3>\n<p>This endpoint does not require any input parameters. The request is made using the HTTP GET method, and it is expected to return a collection of brand information.</p>\n<h3 id=\"response-structure\">Response Structure</h3>\n<p>The response will be in JSON format and contains an array of objects, where each object represents a brand. The structure of each brand object includes the following fields:</p>\n<ul>\n<li><p><strong>brand_id</strong>: (string) A unique identifier for the brand.</p>\n</li>\n<li><p><strong>company_name</strong>: (string) The name of the company associated with the brand.</p>\n</li>\n<li><p><strong>dba_name</strong>: (string) The \"Doing Business As\" name for the brand, if applicable.</p>\n</li>\n<li><p><strong>registered</strong>: (boolean) A boolean reflecting if the brand has been registered or not.</p>\n</li>\n<li><p><strong>api_allowed</strong>: (boolean) A boolean reflecting if the brand has been approved to be used for api access or not.</p>\n</li>\n</ul>\n<h3 id=\"example-response\">Example Response</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n    {\n        \"brand_id\": \"\",\n        \"company_name\": \"\",\n        \"dba_name\": \"\",\n        \"registered\": true,\n        \"api_allowed\": true\n    }\n]\n\n</code></pre>\n","urlObject":{"path":["brand"],"host":["https://api.dropcowboy.com/v1"],"query":[],"variable":[]}},"response":[{"id":"4661584e-d0e0-4884-8e05-ed3a62e08b63","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-team-id","value":"","description":"REQUIRED | The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.","type":"text"},{"key":"x-secret","value":"","description":"REQUIRED | The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.","type":"text"}],"url":"https://api.dropcowboy.com/v1/brand"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n    {\n        \"brand_id\": \"ba2ace9b-471c-4c77-8c07-0bcba83f9xyz\",\n        \"company_name\": \"Legal Name Brand #1\",\n        \"dba_name\": \"Other Name Brand #1\",\n        \"registered\": true,\n        \"api_allowed\": true\n    },\n    {\n        \"brand_id\": \"ba2ace9b-471c-4c77-8c07-0bcba83f9xye\",\n        \"company_name\": \"Legal Name Brand #2\",\n        \"dba_name\": \"Other Name Brand #2\",\n        \"registered\": false,\n        \"api_allowed\": false\n    }\n]"}],"_postman_id":"fc19e829-8b4a-431e-908a-6d00f34b8e57"}],"id":"400c4f8f-eff7-4965-8ced-e7420e06cf88","description":"<p>Invoke our brand api from your application by sending an HTTP GET containing with the attributes listed.</p>\n","_postman_id":"400c4f8f-eff7-4965-8ced-e7420e06cf88"},{"name":"Number Pools","item":[{"name":"Listing Number Pools","id":"40451e3c-8e7c-4efa-8520-5bb559050c11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-team-id","value":"","description":"<p>REQUIRED | The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -&gt; API page.</p>\n","type":"text"},{"key":"x-secret","value":"","description":"<p>REQUIRED | The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -&gt; API page.</p>\n","type":"text"}],"url":"https://api.dropcowboy.com/v1/pool","description":"<h2 id=\"get-baseurlpool\">GET https://api.dropcowboy.com/v1/pool</h2>\n<p>This endpoint retrieves a list of pools available in the system.</p>\n<h3 id=\"request-method\">Request Method</h3>\n<ul>\n<li><strong>GET</strong></li>\n</ul>\n<h3 id=\"endpoint\">Endpoint</h3>\n<ul>\n<li><code>https://api.dropcowboy.com/v1/pool</code></li>\n</ul>\n<h3 id=\"response-format\">Response Format</h3>\n<p>The response is returned in JSON format and contains an array of pool objects. Each object includes the following fields:</p>\n<ul>\n<li><p><strong>pool_id</strong>: A unique identifier for the pool (string).</p>\n</li>\n<li><p><strong>brand_id</strong>: The identifier for the brand associated with the pool (string).</p>\n</li>\n<li><p><strong>name</strong>: The name of the pool (string).</p>\n</li>\n<li><p><strong>service_type</strong>: The type of service provided by the pool (string).</p>\n</li>\n<li><p><strong>number_count</strong>: The count of numbers associated with the pool (integer).</p>\n</li>\n</ul>\n<h3 id=\"example-response\">Example Response</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n    {\n        \"pool_id\": \"\",\n        \"brand_id\": \"\",\n        \"name\": \"\",\n        \"service_type\": \"\",\n        \"number_count\": 0\n    }\n]\n\n</code></pre>\n","urlObject":{"path":["pool"],"host":["https://api.dropcowboy.com/v1"],"query":[],"variable":[]}},"response":[{"id":"cf54bc80-3d93-4d1f-835e-a921f63d24c7","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-team-id","value":"","description":"REQUIRED | The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.","type":"text"},{"key":"x-secret","value":"","description":"REQUIRED | The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.","type":"text"}],"url":"https://api.dropcowboy.com/v1/pool"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n    {\n        \"pool_id\": \"abcace9b-471c-4c77-8c07-0bcba83f9abc\",\n        \"brand_id\": \"ba2ace9b-471c-4c77-8c07-0bcba83f9xyz\",\n        \"name\": \"Number Pool #1\",\n        \"service_type\": \"sms\",\n        \"number_count\": 1\n    },\n    {\n        \"pool_id\": \"deface9b-471c-4c77-8c07-0bcba83f9def\",\n        \"brand_id\": \"ba2ace9b-471c-4c77-8c07-0bcba83f9xye\",\n        \"name\": \"Example Pool #2\",\n        \"service_type\": \"rvm\",\n        \"number_count\": 19\n    }\n]"}],"_postman_id":"40451e3c-8e7c-4efa-8520-5bb559050c11"}],"id":"737ce7de-af08-4edf-a1c2-fb1c3abf543c","description":"<p>Invoke our number pool api from your application by sending an HTTP GET containing with the attributes listed below.</p>\n","_postman_id":"737ce7de-af08-4edf-a1c2-fb1c3abf543c"},{"name":"Contact Lists","item":[{"name":"Create Contact List","id":"1aff7736-af58-4be8-8b7a-d763fe1ec647","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-team-id","value":"","description":"<p>REQUIRED | The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -&gt; API page.</p>\n","type":"text"},{"key":"x-secret","value":"","description":"<p>REQUIRED | The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -&gt; API page.</p>\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"list_name\": \"My List Name\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dropcowboy.com/v1/list","description":"<h2 id=\"create-contact-list\">Create Contact List</h2>\n<p>This endpoint allows users to create a new list by providing a name for the list.</p>\n<h3 id=\"request\">Request</h3>\n<ul>\n<li><p><strong>Method:</strong> POST</p>\n</li>\n<li><p><strong>Endpoint:</strong> <code>https://api.dropcowboy.com/v1/list</code></p>\n</li>\n<li><p><strong>Request Body (JSON):</strong></p>\n<ul>\n<li><code>list_name</code> (string): The name of the list to be created. This parameter is required.</li>\n</ul>\n</li>\n</ul>\n<p><strong>Example Request:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"list_name\": \"My List Name\"\n}\n\n</code></pre>\n<h3 id=\"response\">Response</h3>\n<p>Upon successful creation of the list, the API will return a JSON object containing the following fields:</p>\n<ul>\n<li><p><code>list_id</code> (string): The UUID of the list. Use this value in other calls to the contact list api endpoints. It is safe to cache this value client side in your app.</p>\n</li>\n<li><p><code>list_name</code> (string): A string containing the name of the list.</p>\n</li>\n<li><p><code>created_at</code> (integer): Milliseconds since epoch of when the list was created.</p>\n</li>\n</ul>\n<p><strong>Example Response:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"list_id\": \"\",\n  \"list_name\": \"\",\n  \"created_at\": 0\n}\n\n</code></pre>\n<h3 id=\"notes\">Notes</h3>\n<ul>\n<li>Ensure that the <code>list_name</code> is unique to avoid conflicts with existing lists.</li>\n</ul>\n","urlObject":{"path":["list"],"host":["https://api.dropcowboy.com/v1"],"query":[],"variable":[]}},"response":[{"id":"5f4934c8-24cb-4141-a79a-3922c7ae4372","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"x-team-id","value":"","description":"REQUIRED | The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.","type":"text"},{"key":"x-secret","value":"","description":"REQUIRED | The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.\n\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"list_name\": \"My List Name\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dropcowboy.com/v1/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"list_id\": \"ba2ace9b-471c-4c77-8c07-0bcba83f9xyze\",\n    \"list_name\": \"api test 5\",\n    \"created_at\": 1587424720775\n}"}],"_postman_id":"1aff7736-af58-4be8-8b7a-d763fe1ec647"},{"name":"Rename Contact List","id":"f755605b-750e-4097-8920-1b0522057340","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-team-id","value":"","description":"<p>REQUIRED | The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -&gt; API page.</p>\n","type":"text"},{"key":"x-secret","value":"","description":"<p>REQUIRED | The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -&gt; API page.</p>\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"list_name\": \"My Updated List Name\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dropcowboy.com/v1/list/{{list_id}}","description":"<h2 id=\"rename-contact-list\">Rename Contact List</h2>\n<p>This endpoint allows you to update the details of a specific list identified by <code>list_id</code>. By sending a POST request to <code>https://api.dropcowboy.com/v1/list/{{list_id}}</code>, you can modify the name of an existing list.</p>\n<h3 id=\"request-format\">Request Format</h3>\n<ul>\n<li><p><strong>Method</strong>: POST</p>\n</li>\n<li><p><strong>URL</strong>: <code>https://api.dropcowboy.com/v1/list/{{list_id}}</code></p>\n</li>\n<li><p><strong>Request Body</strong>: The body of the request should be in JSON format and must include the following parameter:</p>\n<ul>\n<li><code>list_name</code> (string): The new name for the list.</li>\n</ul>\n</li>\n</ul>\n<h4 id=\"example-request-body\">Example Request Body</h4>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"list_name\": \"My Updated List Name\"\n}\n\n</code></pre>\n<h3 id=\"response-structure\">Response Structure</h3>\n<p>Upon a successful update, the server will respond with a confirmation message indicating that the list has been updated.</p>\n<h3 id=\"expected-response\">Expected Response</h3>\n<ul>\n<li><strong>Status Code</strong>: 200 OK (on success)</li>\n</ul>\n","urlObject":{"path":["list","{{list_id}}"],"host":["https://api.dropcowboy.com/v1"],"query":[],"variable":[]}},"response":[{"id":"79aa84de-b1fc-4bfa-8c75-66ca1e6f771c","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"x-team-id","value":"","description":"REQUIRED | The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.","type":"text"},{"key":"x-secret","value":"","description":"REQUIRED | The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.\n\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"list_name\": \"My Updated List Name\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dropcowboy.com/v1/list/{{list_id}}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"f755605b-750e-4097-8920-1b0522057340"},{"name":"Append Contacts To List","id":"758eced2-b888-4c2c-a2df-10e6274a30a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-team-id","value":"","description":"<p>REQUIRED | The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -&gt; API page.</p>\n","type":"text"},{"key":"x-secret","value":"","description":"<p>REQUIRED | The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -&gt; API page.</p>\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"region\": \"US\",\r\n    \"fields\": [\r\n        \"record_id\",\r\n        \"first_name\",\r\n        \"last_name\",\r\n        \"company\",\r\n        \"email\",\r\n        \"phone\",\r\n        \"phone\",\r\n        \"phone\",\r\n        \"address1\",\r\n        \"address2\",\r\n        \"city\",\r\n        \"state\",\r\n        \"postal\",\r\n        \"country\",\r\n        \"custom1\",\r\n        \"custom2\",\r\n        \"custom3\",\r\n        \"custom4\",\r\n        \"custom5\"\r\n    ],\r\n    \"values\": [\r\n        [\r\n            \"ExternalID123\",\r\n            \"bob\",\r\n            \"doe\",\r\n            \"bobs company\",\r\n            \"bob@example.com\",\r\n            \"555-111-1111\",\r\n            \"(555) 222-2222\",\r\n            \"+15553334444\",\r\n            \"123 Very Long Name St.\",\r\n            \"Apartment 12345\",\r\n            \"Phoenix\",\r\n            \"AZ\",\r\n            \"85020\",\r\n            \"US\",\r\n            \"Under $500,000\",\r\n            \"Green\",\r\n            \"3 Kids\",\r\n            \"1 Dog\",\r\n            \"Next 6 Months\"\r\n        ]\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dropcowboy.com/v1/list/{{list_id}}/contacts","description":"<h2 id=\"append-contacts-to-a-list\">Append Contacts to a List</h2>\n<p>This endpoint allows you to add contacts to a specific list identified by <code>list_id</code>. The request requires a JSON payload that specifies the region, the fields to be populated, and the values for those fields.</p>\n<h3 id=\"request-body-format\">Request Body Format</h3>\n<p>The request body must be in JSON format and include the following parameters:</p>\n<ul>\n<li><p><strong>region</strong> (string): Array of strings that define the data types being passed in the Values attribute. It is acceptable to have repeat field types specified if your contacts have multiple phone numbers, pass in the value of “phone” multiple times in this array. Possible field types are: <code>record_id</code>, <code>first_name</code>, <code>last_name</code>, <code>company</code>, <code>email</code>, <code>phone</code>, <code>address1</code>, <code>address2</code>, <code>city</code>, <code>state</code>, <code>postal</code>, <code>country</code>, <code>custom1</code>, <code>custom2</code>, <code>custom3</code>, <code>custom4</code>, <code>custom5</code>.</p>\n</li>\n<li><p><strong>fields</strong> (array of strings): An array specifying the fields that will be populated for each contact (e.g., [\"record_id\"]).</p>\n</li>\n<li><p><strong>values</strong> (array of arrays): An array of arrays. Inner arrays contain the values associated with the field types you specify in the fields attribute. You may pass in up to 10,000 contacts per api call.</p>\n</li>\n</ul>\n<p><strong>Example Request Body:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"region\": \"US\",\n  \"fields\": [\"record_id\"],\n  \"values\": [[\"ExternalID123\"]]\n}\n\n</code></pre>\n<h3 id=\"expected-response-format\">Expected Response Format</h3>\n<p>The response will be in JSON format and will include the following fields:</p>\n<ul>\n<li><p><strong>accepted_count</strong> (integer): The number of contacts appended to the list.</p>\n</li>\n<li><p><strong>rejected</strong> (array): An array of objects containing the index of the rejected contact from the value array that you passed to the api and the reason that contact was rejected, where each object contains:</p>\n<ul>\n<li><p><strong>index</strong> (integer): The index of the rejected contact in the original request.</p>\n</li>\n<li><p><strong>reason</strong> (string): The reason for rejection (if applicable).</p>\n</li>\n</ul>\n</li>\n</ul>\n<p><strong>Example Response:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accepted_count\": 0,\n  \"rejected\": [\n    {\n      \"index\": 0,\n      \"reason\": \"\"\n    }\n  ]\n}\n\n</code></pre>\n","urlObject":{"path":["list","{{list_id}}","contacts"],"host":["https://api.dropcowboy.com/v1"],"query":[],"variable":[]}},"response":[{"id":"c05c7b53-07db-46c9-b68f-436f4dbf82f1","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"x-team-id","value":"","description":"REQUIRED | The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.","type":"text"},{"key":"x-secret","value":"","description":"REQUIRED | The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.\n\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"region\": \"US\",\r\n    \"fields\": [\r\n        \"record_id\",\r\n        \"first_name\",\r\n        \"last_name\",\r\n        \"company\",\r\n        \"email\",\r\n        \"phone\",\r\n        \"phone\",\r\n        \"phone\",\r\n        \"address1\",\r\n        \"address2\",\r\n        \"city\",\r\n        \"state\",\r\n        \"postal\",\r\n        \"country\",\r\n        \"custom1\",\r\n        \"custom2\",\r\n        \"custom3\",\r\n        \"custom4\",\r\n        \"custom5\"\r\n    ],\r\n    \"values\": [\r\n        [\r\n            \"ExternalID123\",\r\n            \"bob\",\r\n            \"doe\",\r\n            \"bobs company\",\r\n            \"bob@example.com\",\r\n            \"555-111-1111\",\r\n            \"(555) 222-2222\",\r\n            \"+15553334444\",\r\n            \"123 Very Long Name St.\",\r\n            \"Apartment 12345\",\r\n            \"Phoenix\",\r\n            \"AZ\",\r\n            \"85020\",\r\n            \"US\",\r\n            \"Under $500,000\",\r\n            \"Green\",\r\n            \"3 Kids\",\r\n            \"1 Dog\",\r\n            \"Next 6 Months\"\r\n        ]\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dropcowboy.com/v1/list/{{list_id}}/contacts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"accepted_count\": 10479,\n    \"rejected\": [\n        {\n            \"index\": 0,\n            \"reason\": \"Not a valid US,CA phone number\"\n        },\n        {\n            \"index\": 229,\n            \"reason\": \"Not a valid US,CA phone number\"\n        },\n        {\n            \"index\": 301,\n            \"reason\": \"Not a valid US,CA phone number\"\n        }\n    ]\n}"}],"_postman_id":"758eced2-b888-4c2c-a2df-10e6274a30a0"},{"name":"Get Contact List Details","id":"bbdcf2b0-f57a-482e-9b59-aaf1b3784ab9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-team-id","value":"","description":"<p>REQUIRED | The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -&gt; API page.</p>\n","type":"text"},{"key":"x-secret","value":"","description":"<p>REQUIRED | The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -&gt; API page.</p>\n","type":"text"}],"url":"https://api.dropcowboy.com/v1/list/{{list_id}}","description":"<h2 id=\"get-contact-list-details\">Get Contact List Details</h2>\n<p>This endpoint retrieves the details of a specific list identified by the <code>list_id</code>.</p>\n<h3 id=\"request\">Request</h3>\n<ul>\n<li><p><strong>Method</strong>: GET</p>\n</li>\n<li><p><strong>URL</strong>: <code>https://api.dropcowboy.com/v1/list/{{list_id}}</code></p>\n</li>\n<li><p><strong>Path Parameters</strong>:</p>\n<ul>\n<li><code>list_id</code> (string): Is the UUID value returned in the api results when creating a list or getting a list from the /list endpoint.</li>\n</ul>\n</li>\n</ul>\n<h3 id=\"response\">Response</h3>\n<p>On successful retrieval, the response will contain the following structure:</p>\n<ul>\n<li><p><code>list_id</code> (string): The UUID of the list. Use this value in other calls to the contact list api endpoints. It is safe to cache this value client side in your app.</p>\n</li>\n<li><p><code>list_name</code> (string): A string containing the name of the list.</p>\n</li>\n<li><p><code>created_at</code> (integer): Milliseconds since epoch of when the list was created.</p>\n</li>\n<li><p><code>contact_count</code> (integer): The total number of contacts in the list.</p>\n</li>\n</ul>\n<h3 id=\"example-response\">Example Response</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"list_id\": \"\",\n  \"list_name\": \"\",\n  \"created_at\": 0,\n  \"contact_count\": 0\n}\n\n</code></pre>\n","urlObject":{"path":["list","{{list_id}}"],"host":["https://api.dropcowboy.com/v1"],"query":[],"variable":[]}},"response":[{"id":"9402c99d-6c84-46a0-81b7-4e1493392b36","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"x-team-id","value":"","description":"REQUIRED | The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.","type":"text"},{"key":"x-secret","value":"","description":"REQUIRED | The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.","type":"text"}],"url":"https://api.dropcowboy.com/v1/list/{{list_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"list_id\": \"ba2ace9b-471c-4c77-8c07-0bcba83f9xyz\",\n    \"list_name\": \"My List Name\",\n    \"created_at\": 1587424720775,\n    \"contact_count\": 10482\n}"}],"_postman_id":"bbdcf2b0-f57a-482e-9b59-aaf1b3784ab9"},{"name":"Delete Contact List","id":"139c28b1-d469-468c-9441-6e84078e02bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-team-id","value":"","description":"<p>REQUIRED | The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -&gt; API page.</p>\n","type":"text"},{"key":"x-secret","value":"","description":"<p>REQUIRED | The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -&gt; API page.</p>\n","type":"text"}],"url":"https://api.dropcowboy.com/v1/list/{{list_id}}","description":"<h2 id=\"delete-contact-list\">Delete Contact List</h2>\n<p>This endpoint allows users to delete a specific list by providing the unique identifier of the list.</p>\n<h3 id=\"request-format\">Request Format</h3>\n<ul>\n<li><p><strong>Method</strong>: DELETE</p>\n</li>\n<li><p><strong>URL</strong>: <code>https://api.dropcowboy.com/v1/list/{{list_id}}</code></p>\n</li>\n<li><p><strong>Path Parameter</strong>:</p>\n<ul>\n<li><code>list_id</code> (string): The unique identifier of the list that you wish to delete.</li>\n</ul>\n</li>\n</ul>\n<h3 id=\"response-structure\">Response Structure</h3>\n<p>Upon successful deletion, the server will respond with a confirmation message indicating that the item has been removed. The expected response will typically include:</p>\n<ul>\n<li><p>A status code indicating the result of the operation (e.g., <code>200</code> for a successful deletion).</p>\n</li>\n<li><p>An object with the <code>list_id</code> of the item deleted.</p>\n</li>\n</ul>\n<h3 id=\"notes\">Notes</h3>\n<ul>\n<li><p>No request body is required for this DELETE request.</p>\n</li>\n<li><p>Ensure that the <code>list_id</code> provided corresponds to an existing list.</p>\n</li>\n</ul>\n","urlObject":{"path":["list","{{list_id}}"],"host":["https://api.dropcowboy.com/v1"],"query":[],"variable":[]}},"response":[{"id":"66e8c1e8-80d3-40d5-a234-cfe220474615","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"x-team-id","value":"","description":"REQUIRED | The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.","type":"text"},{"key":"x-secret","value":"","description":"REQUIRED | The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.","type":"text"}],"url":"https://api.dropcowboy.com/v1/list/{{list_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"list_id\": \"00000000-0000-0000-0000-000000000000\"\r\n}"}],"_postman_id":"139c28b1-d469-468c-9441-6e84078e02bb"}],"id":"6896f9b6-ff50-4187-9240-c29482d3a1a1","description":"<p>Interact with your Drop Cowboy contact lists from your application via API.</p>\n","_postman_id":"6896f9b6-ff50-4187-9240-c29482d3a1a1"}],"event":[{"listen":"prerequest","script":{"id":"ab7d76c5-e0a4-471d-a20b-21badded3a92","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"7c46f3a0-d3a9-48d7-b8be-a6310e18c083","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.dropcowboy.com/v1"},{"key":"team_id","value":""},{"key":"secret","value":"","type":"default"}]}