The Allbound API enables you to programmatically access data stored in your Allbound instance. We're excited to collaborate with you in unleashing the power of relationships! For further information, visit Allbound Developers.
\nThe API has rate limits to keep our API reliable and to help third-party developers responsibly use the API. The APIs will start returning 406 if the requests exceed 20 RPM.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"9377010","collectionId":"08f17608-1277-4c21-9f57-c143c30c1d98","publishedId":"2sA3dviXbL","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-01T08:12:33.000Z"},"item":[{"name":"Authorization","item":[],"id":"8e9869a9-1bcc-40f2-87fa-9ca671313fd6","description":"Allbound API uses API key based authentication and authorization. You can get the API key for your instance from your system administrator.
\nIf you are a system administrator, you can create the keys in your Allbound instance.
\nThe API key/credentials will only appear in plain text at the time of creation. After saving, it will always appear masked on the Authentication list, but you can delete and generate a new key/credentials if you forgot to copy.
\nNote: You can always add or remove permissions for each key/credential by clicking Edit Permission.
\nStructure of permissions: The permissions can be selected from the dropdown and the values are in a format actions.read, where actions is the name of the resource and read is the access.\nThe other possible values are create, manage, edit. The manage permission includes all permissions: read, write, edit, delete.
In order to successfully talk to the Allbound API you need to specify the tenant header as follows
\nNote: You can get the value of the instance from Account settings > Account identifier
\n","_postman_id":"8e9869a9-1bcc-40f2-87fa-9ca671313fd6"},{"name":"Users","item":[{"name":"List users","id":"bc63a110-fb4a-4ad0-9f17-9c05c560afcc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"(Required)
\n","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required)
\n","key":"instance","value":"cloudrocket"},{"key":"Accept","value":"application/json"}],"url":"https://api.allbound.com/v1/users?page=1&limit=1&sort=-name&search=abc&filters[ids]=1,2,3&filters[status]=active&filters[user_type]=subscriber&filters[last_login_date]=02/11/2024-02/16/2024&filters[primary_company_info.id]=1&filters[primary_company_info.role]=sales&filters[primary_company_info.status]=active&filters[primary_company_info.website]=www.example.com","description":"This endpoint allows you to fetch a list of users based on specified criteria. Users can be filtered based on various parameters such as page number, item limit per page, sorting column, search keywords, and various filters including user IDs, status, \nuser types, last login dates, and primary company details.
\nTo authenticate the request, include the x-api-key header and ensure your API credentials have the users.read or users.manage permission.
The response includes essential metadata indicating total counts and pages, along with detailed information about each user. User details encompass MongoDB ID (m_id), user Allbound ID (id), name, email, user type, admin permissions, status, creation and update dates, last login date, profile picture URL, and primary company information.
\nAdditionally, users' primary company details such as ID, name, role, legacy ID, status, website, and associated metadata like CRM ID are provided.
\n","urlObject":{"path":["users"],"host":["https://api.allbound.com/v1"],"query":[{"description":{"content":"Page number
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Limit of items per page
\n","type":"text/plain"},"key":"limit","value":"1"},{"description":{"content":"Name of the sorting column, starts with - for desc
\n","type":"text/plain"},"key":"sort","value":"-name"},{"description":{"content":"Search keyword for searching on first name, last name, email, or first name + last name (concatenated with space in between)
\n","type":"text/plain"},"key":"search","value":"abc"},{"description":{"content":"Filter on the user id field (titled Allbound ID in the UI). Give comma separated for multiple.
Filter on the status field. Possible values are {pending, active, inactive}.
Filter on the user_type field. Give comma separated for multiple. Possible values are {subscriber, administrator}.
Filter on the last_login_date field.
Filter on the primary_company_info.id field (Allbound ID of the user's primary company)
Filter on user's primary_company_info.role in primary company. Possible values are {executive, manager, sales}.
Filter on user's primary_company_info.status field. Possible values are {pending, active, inactive}.
Filter on user's primary_company_info.website field
(Required)
\n","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required)
\n","key":"instance","value":"cloudrocket"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"input\": [\n {\n \"first_name\": \"Rajeev\",\n \"status\": \"active\",\n \"user_type\": \"subscriber\",\n \"email\": \"rajeevdubey@barcomp.com\",\n \"last_name\": \"Dubey\",\n \"job_title\": \"Senior Engineer\",\n \"office_phone\": \"pariatur aliqua \",\n \"mobile_phone\": \"Excepteur voluptate fugiat est\",\n \"crm_id\": \"0035x00003NrCJjAAN\",\n \"linkedin_url\": \"https://www.linkedin.com/johndoe/\",\n \"twitter_handle\": \"https://twitter.com/johndoe/\",\n \"facebook_url\": \"https://www.facebook.com/johndoe/\"\n },\n {\n \"first_name\": \"Rajeev\",\n \"status\": \"active\",\n \"user_type\": \"subscriber\",\n \"email\": \"rajeevdubey@barcomp.com\",\n \"last_name\": \"Dubey\",\n \"job_title\": \"Senior Engineer\",\n \"office_phone\": \"culpa Duis pariatur\",\n \"mobile_phone\": \"exercitation\",\n \"crm_id\": \"0035x00003NrCJjAAN\",\n \"linkedin_url\": \"https://www.linkedin.com/johndoe/\",\n \"twitter_handle\": \"https://twitter.com/johndoe/\",\n \"facebook_url\": \"https://www.facebook.com/johndoe/\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.allbound.com/v1/users","description":"This endpoint allows the creation of one or multiple users within the system. \nUsers can be created with various attributes including their first name, last name, \nemail address, user type, status, job title, contact numbers, CRM ID, and social media profiles.
\nTo authenticate the request, include the x-api-key header and ensure your API credentials have the users.manage permission.
The request should be formatted as a JSON array containing objects, with each object representing \na user to be created.
\nRequired fields for each user include first_name, status,user_type, and email.
Validations:
\nstatus must be one of the following values {active, pending, inactive}.
user_type must be one of the following values {subscriber, administrator}.
email must be unique.
Upon successful creation, the response will include the IDs and creation dates of the newly created \nuser(s), along with a success code. In case of validation errors or malformed requests, appropriate \nerror messages and status codes will be returned.
\nMulti-select fields are currently not supported.
\nAfter creating a user, add it to a primary company using the POST Add user to company endpoint. Failure to add a user to a primary company will result in limited functionality for the user.
(Required)
\n","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required)
\n","key":"instance","value":"cloudrocket"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"input\": [\n {\n \"id\": \"123\",\n \"status\": \"active\",\n \"first_name\": \"Rajeev\",\n \"last_name\": \"Dubey\",\n \"email\": \"rajeevdubey@barcomp.com\",\n \"user_type\": \"subscriber\",\n \"job_title\": \"Senior Engineer\",\n \"office_phone\": \"dolore\",\n \"mobile_phone\": \"officia do aliqua nostrud\",\n \"crm_id\": \"0035x00003NrCJjAAN\",\n \"linkedin_url\": \"https://www.linkedin.com/johndoe/\",\n \"twitter_handle\": \"https://twitter.com/johndoe/\",\n \"facebook_url\": \"https://www.facebook.com/johndoe/\"\n },\n {\n \"id\": \"123\",\n \"status\": \"active\",\n \"first_name\": \"Rajeev\",\n \"last_name\": \"Dubey\",\n \"email\": \"rajeevdubey@barcomp.com\",\n \"user_type\": \"subscriber\",\n \"job_title\": \"Senior Engineer\",\n \"office_phone\": \"Ut\",\n \"mobile_phone\": \"officia aute dolore \",\n \"crm_id\": \"0035x00003NrCJjAAN\",\n \"linkedin_url\": \"https://www.linkedin.com/johndoe/\",\n \"twitter_handle\": \"https://twitter.com/johndoe/\",\n \"facebook_url\": \"https://www.facebook.com/johndoe/\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.allbound.com/v1/users","description":"This endpoint allows updating one or multiple user profiles within the system. \nUsers can be updated with various attributes such as their status, name, email, \ncontact information, job title, and other user meta fields. Use the GET List user fields endpoint to get a list of custom fields available per user record.
To authenticate the request, include the x-api-key header and ensure your API credentials have the users.manage permission.
The request should contain an array of user objects, where each object represents \na user to be updated. The id field is required for each user object.
Upon successful update, the response will include details of the updated users, \nincluding their IDs and the date of update. In case of users not found or other \nerrors, appropriate error messages and status codes will be returned.
\nMulti-select fields are currently not supported.
\n","urlObject":{"path":["users"],"host":["https://api.allbound.com/v1"],"query":[],"variable":[]}},"response":[{"id":"a7bb2da3-6983-441b-9f9d-bb571de87e05","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"input\": [\n {\n \"id\": \"123\",\n \"status\": \"active\",\n \"first_name\": \"Rajeev\",\n \"last_name\": \"Dubey\",\n \"email\": \"rajeevdubey@barcomp.com\",\n \"user_type\": \"subscriber\",\n \"job_title\": \"Senior Engineer\",\n \"office_phone\": \"dolore\",\n \"mobile_phone\": \"officia do aliqua nostrud\",\n \"crm_id\": \"0035x00003NrCJjAAN\",\n \"linkedin_url\": \"https://www.linkedin.com/johndoe/\",\n \"twitter_handle\": \"https://twitter.com/johndoe/\",\n \"facebook_url\": \"https://www.facebook.com/johndoe/\"\n },\n {\n \"id\": \"123\",\n \"status\": \"active\",\n \"first_name\": \"Rajeev\",\n \"last_name\": \"Dubey\",\n \"email\": \"rajeevdubey@barcomp.com\",\n \"user_type\": \"subscriber\",\n \"job_title\": \"Senior Engineer\",\n \"office_phone\": \"Ut\",\n \"mobile_phone\": \"officia aute dolore \",\n \"crm_id\": \"0035x00003NrCJjAAN\",\n \"linkedin_url\": \"https://www.linkedin.com/johndoe/\",\n \"twitter_handle\": \"https://twitter.com/johndoe/\",\n \"facebook_url\": \"https://www.facebook.com/johndoe/\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.allbound.com/v1/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"success\": true,\n \"data\": {\n \"updated\": [\n {\n \"updated_date\": \"2024-01-31 12:08:47\",\n \"id\": \"1638\"\n },\n {\n \"updated_date\": \"2024-01-31 12:08:47\",\n \"id\": \"1639\"\n },\n {\n \"updated_date\": \"2024-02-15 11:53:20\",\n \"id\": \"403\"\n }\n ],\n \"not_updated\": [\n {\n \"error\": \"User not found\",\n \"id\": \"4343\"\n }\n ]\n }\n}"},{"id":"4c4a26b1-7f31-4295-afe4-1b9614bc93f5","name":"Bad request","originalRequest":{"method":"PUT","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"input\": [\n {\n \"id\": \"123\",\n \"status\": \"active\",\n \"first_name\": \"Rajeev\",\n \"last_name\": \"Dubey\",\n \"email\": \"rajeevdubey@barcomp.com\",\n \"user_type\": \"subscriber\",\n \"job_title\": \"Senior Engineer\",\n \"office_phone\": \"dolore\",\n \"mobile_phone\": \"officia do aliqua nostrud\",\n \"crm_id\": \"0035x00003NrCJjAAN\",\n \"linkedin_url\": \"https://www.linkedin.com/johndoe/\",\n \"twitter_handle\": \"https://twitter.com/johndoe/\",\n \"facebook_url\": \"https://www.facebook.com/johndoe/\"\n },\n {\n \"id\": \"123\",\n \"status\": \"active\",\n \"first_name\": \"Rajeev\",\n \"last_name\": \"Dubey\",\n \"email\": \"rajeevdubey@barcomp.com\",\n \"user_type\": \"subscriber\",\n \"job_title\": \"Senior Engineer\",\n \"office_phone\": \"Ut\",\n \"mobile_phone\": \"officia aute dolore \",\n \"crm_id\": \"0035x00003NrCJjAAN\",\n \"linkedin_url\": \"https://www.linkedin.com/johndoe/\",\n \"twitter_handle\": \"https://twitter.com/johndoe/\",\n \"facebook_url\": \"https://www.facebook.com/johndoe/\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.allbound.com/v1/users"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"errors\": [\n {\n \"message\": \"id: id is required\",\n \"key\": \"body.input\"\n }\n ],\n \"success\": {}\n}"},{"id":"c5c7fd62-58a3-4ebb-ac34-c39f689e976f","name":"Not found","originalRequest":{"method":"PUT","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"input\": [\n {\n \"id\": \"123\",\n \"status\": \"active\",\n \"first_name\": \"Rajeev\",\n \"last_name\": \"Dubey\",\n \"email\": \"rajeevdubey@barcomp.com\",\n \"user_type\": \"subscriber\",\n \"job_title\": \"Senior Engineer\",\n \"office_phone\": \"dolore\",\n \"mobile_phone\": \"officia do aliqua nostrud\",\n \"crm_id\": \"0035x00003NrCJjAAN\",\n \"linkedin_url\": \"https://www.linkedin.com/johndoe/\",\n \"twitter_handle\": \"https://twitter.com/johndoe/\",\n \"facebook_url\": \"https://www.facebook.com/johndoe/\"\n },\n {\n \"id\": \"123\",\n \"status\": \"active\",\n \"first_name\": \"Rajeev\",\n \"last_name\": \"Dubey\",\n \"email\": \"rajeevdubey@barcomp.com\",\n \"user_type\": \"subscriber\",\n \"job_title\": \"Senior Engineer\",\n \"office_phone\": \"Ut\",\n \"mobile_phone\": \"officia aute dolore \",\n \"crm_id\": \"0035x00003NrCJjAAN\",\n \"linkedin_url\": \"https://www.linkedin.com/johndoe/\",\n \"twitter_handle\": \"https://twitter.com/johndoe/\",\n \"facebook_url\": \"https://www.facebook.com/johndoe/\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.allbound.com/v1/users"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 404,\n \"errors\": {\n \"not_updated\": [\n {\n \"error\": \"User not found\",\n \"id\": 123\n },\n {\n \"error\": \"User not found\",\n \"id\": 965\n }\n ],\n \"updated\": {}\n },\n \"success\": {}\n}"}],"_postman_id":"4fdb62bc-bf7f-46f3-8c19-72a7b51b5268"},{"name":"Delete users by IDs","id":"3842b1bc-da0e-458b-8d1a-7b3a8b2a8ea7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"(Required)
\n","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required)
\n","key":"instance","value":"cloudrocket"},{"key":"Accept","value":"application/json"}],"url":"https://api.allbound.com/v1/users?ids=3445,3544,4323,4355","description":"This endpoint allows administrators to deactivate users by their IDs. It accepts a comma-separated string of user IDs as a query parameter, and upon successful deactivation, returns information about the deleted users along with their deleted timestamps. References within the response refer to \"delete\" but they are deactivated. If any user IDs provided do not correspond to existing users, they are listed under the \"not_deleted\" \nsection with an error message indicating \"User not found\".
\nTo authenticate the request, include the x-api-key header and ensure your API credentials have the users.manage permission.
(Required) Comma-separated string of user IDs to delete (deactivate)
\n","type":"text/plain"},"key":"ids","value":"3445,3544,4323,4355"}],"variable":[]}},"response":[{"id":"c932c9b6-ccfa-49d1-be42-80bc7b747bcc","name":"OK","originalRequest":{"method":"DELETE","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.allbound.com/v1/users?ids=3445,3544,4323,4355","host":["https://api.allbound.com/v1"],"path":["users"],"query":[{"description":"(Required) Comma-separated string of user IDs to delete (deactivate)","key":"ids","value":"3445,3544,4323,4355"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"success\": true,\n \"data\": {\n \"deleted\": [\n {\n \"deleted_date\": \"2024-01-31 12:08:47\",\n \"id\": \"3445\"\n },\n {\n \"deleted_date\": \"2024-01-31 12:08:47\",\n \"id\": \"3544\"\n },\n {\n \"deleted_date\": \"2024-02-15 11:53:20\",\n \"id\": \"4323\"\n }\n ],\n \"not_deleted\": [\n {\n \"error\": \"User not found\",\n \"id\": \"4355\"\n }\n ]\n }\n}"},{"id":"723e3031-cf3c-4593-a16b-cdd670fbcce0","name":"Bad request","originalRequest":{"method":"DELETE","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.allbound.com/v1/users?ids=3445,3544,4323,4355","host":["https://api.allbound.com/v1"],"path":["users"],"query":[{"description":"(Required) Comma-separated string of user IDs to delete (deactivate)","key":"ids","value":"3445,3544,4323,4355"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400\n}"},{"id":"4cef2c2e-d783-4910-9bf9-5d4d7540a81e","name":"Not found","originalRequest":{"method":"DELETE","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.allbound.com/v1/users?ids=3445,3544,4323,4355","host":["https://api.allbound.com/v1"],"path":["users"],"query":[{"description":"(Required) Comma-separated string of user IDs to delete (deactivate)","key":"ids","value":"3445,3544,4323,4355"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 404,\n \"errors\": {\n \"not_deleted\": [\n {\n \"error\": \"User not found\",\n \"id\": 167\n },\n {\n \"error\": \"User not found\",\n \"id\": 985\n }\n ],\n \"deleted\": {}\n },\n \"success\": {}\n}"}],"_postman_id":"3842b1bc-da0e-458b-8d1a-7b3a8b2a8ea7"},{"name":"Add user to company","id":"f434452e-8c47-4d31-9c7e-0dca796dbb46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"(Required)
\n","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required)
\n","key":"instance","value":"cloudrocket"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"input\": [\n {\n \"company_id\": 1694,\n \"user_id\": 457,\n \"role\": \"manager\",\n \"primary_relationship\": 1\n },\n {\n \"company_id\": 1693,\n \"user_id\": 457,\n \"role\": \"sales\",\n \"primary_relationship\": 0\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.allbound.com/v1/users/companies","description":"This endpoint allows users to be added to companies within the system. \nUsers can be assigned roles such as sales, manager, executive, or owner, \nwith an indication of whether the relationship is primary.
\nTo authenticate the request, include the x-api-key header and ensure your API credentials have the users.manage permission.
The request must include the company_id, user_id, role, and \nprimary_relationship fields in the JSON body. The role field must \nbe one of {sales, manager, executive, owner}.
Validations:
\nowner role can only be applied to non-primary companies, for users whose primary company is the vendor company (owner of the portal) as this role is reserved for Account Owners (aka Channel Account Managers or Partner Account Managers) .Upon successful addition, the response will include the updated date, \nalong with the IDs of the user and the company involved, and a success code. \nIn case of validation errors or user not found, appropriate error messages \nand status codes will be returned.
\n","urlObject":{"path":["users","companies"],"host":["https://api.allbound.com/v1"],"query":[],"variable":[]}},"response":[{"id":"b316ac3a-be29-430d-83d2-49f8d5542c2d","name":"OK","originalRequest":{"method":"POST","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"input\": [\n {\n \"company_id\": 1694,\n \"user_id\": 457,\n \"role\": \"manager\",\n \"primary_relationship\": 1\n },\n {\n \"company_id\": 1693,\n \"user_id\": 457,\n \"role\": \"sales\",\n \"primary_relationship\": 0\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.allbound.com/v1/users/companies"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"updated_date\": \"2024-01-31 23:19:31\",\n \"user_id\": \"6243\",\n \"company_id\": \"6290\"\n }\n ],\n \"success\": true,\n \"code\": 200\n}"},{"id":"0e80e866-5e05-46c3-95cc-10b4002b9a9c","name":"Bad request","originalRequest":{"method":"POST","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"input\": [\n {\n \"company_id\": 1694,\n \"user_id\": 457,\n \"role\": \"manager\",\n \"primary_relationship\": 1\n },\n {\n \"company_id\": 1693,\n \"user_id\": 457,\n \"role\": \"sales\",\n \"primary_relationship\": 0\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.allbound.com/v1/users/companies"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"errors\": [\n {\n \"message\": \"role: Invalid value. Expected one of: sales, manager, executive, owner\",\n \"key\": \"body.input\"\n }\n ],\n \"success\": {}\n}"},{"id":"63f2398d-9ce4-4303-bba7-1fbf706dbcca","name":"Not found","originalRequest":{"method":"POST","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"input\": [\n {\n \"company_id\": 1694,\n \"user_id\": 457,\n \"role\": \"manager\",\n \"primary_relationship\": 1\n },\n {\n \"company_id\": 1693,\n \"user_id\": 457,\n \"role\": \"sales\",\n \"primary_relationship\": 0\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.allbound.com/v1/users/companies"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 404,\n \"success\": {},\n \"errors\": {\n \"not_added\": [\n {\n \"error\": \"User not found.\",\n \"company_id\": \"6281\",\n \"user_id\": \"6243\"\n }\n ],\n \"added\": {}\n }\n}"}],"_postman_id":"f434452e-8c47-4d31-9c7e-0dca796dbb46"},{"name":"Delete one or multiple users from company","id":"2c067ec0-e453-4664-a66e-06201d998cc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"(Required)
\n","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required)
\n","key":"instance","value":"cloudrocket"},{"key":"Accept","value":"application/json"}],"url":"https://api.allbound.com/v1/users/:user_id/companies/:company_id","description":"This endpoint allows the removal of a list of users from a particular company identified \nby their unique user IDs and the company ID. The user IDs are provided as a comma-separated \nstring in the path parameter user_id, while the company ID is specified in the company_id \npath parameter.
To authenticate the request, include the x-api-key header and ensure your API credentials have the users.manage permission.
Upon successful deletion, the response will indicate the status of the operation, including \nany users that were not successfully removed along with the reason for each failure.
\nThis endpoint returns a 200 status code upon successful execution, along with a detailed \nresponse indicating which users were successfully removed and any errors encountered during \nthe process. In case of a bad request or if the specified company or user is not found, \nappropriate error responses with status codes 400 and 404 will be returned respectively.
\n","urlObject":{"path":["users",":user_id","companies",":company_id"],"host":["https://api.allbound.com/v1"],"query":[],"variable":[{"id":"fbf4ec8f-71a7-4da2-82c4-1cfd689f1ac0","description":{"content":"(Required) Comma-separated string of user ids
\n","type":"text/plain"},"type":"any","value":"123,456","key":"user_id"},{"id":"4d421c67-3d45-4058-98c0-0febc4d7f997","description":{"content":"(Required) The id of the company
\n","type":"text/plain"},"type":"any","value":"665","key":"company_id"}]}},"response":[{"id":"cd8720d9-2fda-4e14-b610-9e743ae6c85d","name":"OK","originalRequest":{"method":"DELETE","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.allbound.com/v1/users/:user_id/companies/:company_id","host":["https://api.allbound.com/v1"],"path":["users",":user_id","companies",":company_id"],"variable":[{"key":"user_id"},{"key":"company_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"not_removed\": [\n {\n \"company_id\": \"665\",\n \"user_id\": \"123\",\n \"error\": \"User not found.\"\n }\n ],\n \"removed\": [\n {\n \"company_id\": \"665\",\n \"updated_date\": \"2024-02-15 12:06:09\",\n \"user_id\": \"456\"\n }\n ]\n },\n \"code\": 200,\n \"success\": true\n}"},{"id":"d9862601-62c5-43cc-b438-a629eabfb587","name":"Bad request","originalRequest":{"method":"DELETE","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.allbound.com/v1/users/:user_id/companies/:company_id","host":["https://api.allbound.com/v1"],"path":["users",":user_id","companies",":company_id"],"variable":[{"key":"user_id"},{"key":"company_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400\n}"},{"id":"806bde8a-ff44-46d0-95a8-bc6e2b2f513b","name":"Not found","originalRequest":{"method":"DELETE","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.allbound.com/v1/users/:user_id/companies/:company_id","host":["https://api.allbound.com/v1"],"path":["users",":user_id","companies",":company_id"],"variable":[{"key":"user_id"},{"key":"company_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 404,\n \"errors\": {\n \"not_removed\": [\n {\n \"error\": \"User not found\",\n \"user_id\": 123,\n \"company_id\": 665\n },\n {\n \"error\": \"User not found\",\n \"user_id\": 456,\n \"company_id\": 665\n }\n ],\n \"removed\": {}\n },\n \"success\": {}\n}"}],"_postman_id":"2c067ec0-e453-4664-a66e-06201d998cc8"},{"name":"List user fields","id":"99acc279-141f-4b80-bce9-9fdeebdceb67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"(Required)
\n","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required)
\n","key":"instance","value":"cloudrocket"},{"key":"Accept","value":"application/json"}],"url":"https://api.allbound.com/v1/users/fields","description":"This endpoint retrieves a list of user fields available in the system. User fields provide \nadditional information about users and can include various types such as text areas, checkboxes, \nand select dropdowns. The response includes details about each field, such as whether it is \nrequired, its type, placeholder text, unique key, label, and description.
\nTo authenticate the request, include the x-api-key header and ensure your API credentials have the users.read or users.manage permission.
The response contains an object with the following properties:
\ndata: An array of objects representing each user field, including details like whether \nit's required, its type, placeholder text, unique key, label, and description.code: The HTTP status code, indicating the success of the request.success: A boolean value indicating whether the request was successful.The Allbound Users API encompasses a variety of endpoints designed to streamline user management within our application. Covering a range of functionalities, these endpoints facilitate operations such as user retrieval, creation, updates, and deletions. Serving as a centralized hub for user-related activities, this module ensures an efficient and user-friendly experience. Whether retrieving a list of users, creating new user profiles, or updating existing information, the encapsulated endpoints deliver a cohesive and versatile solution for effective user administration.
\n","_postman_id":"1fa080e1-e4d5-4202-8fe5-fa0138368385"},{"name":"Companies","item":[{"name":"List companies","id":"de151c06-2ff8-44d9-8704-b320b7e14836","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"(Required)
\n","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required)
\n","key":"instance","value":"cloudrocket"},{"key":"Accept","value":"application/json"}],"url":"https://api.allbound.com/v1/companies?page=1&limit=10&sort=-status&search=mycomp&filters[status]=active&filters[last_updated_date]=02/15/2024,02/17/2024&filters[account_owners]=65436dbd2aa2069908073373,25436dbd2dd2069908073371&filters[ids]=124,564&filters[names]=starlink|myventure&filters[meta.*]=DEF2232D","description":"This endpoint retrieves a paginated list of companies based on various filters and search criteria. \nUsers can specify the page number, limit of items per page, sorting order, and search queries to \nnarrow down the results. Additionally, filters can be applied based on company attributes such as \nstatus, last updated date, account owners, IDs, meta fields, and more.
\nTo authenticate the request, include the x-api-key header and ensure your API credentials have the users.read or users.manage permission.
The response includes detailed information about each company, including its status, Allbound ID, creation and last updated dates, address, website, name, logo, and additional meta fields. \nAccount-related details such as partner type, CRM ID, user count, and \ncontact information are also provided.
\nResponse meta-information includes the total count of companies and the total number of pages \navailable based on the specified pagination parameters.
\n","urlObject":{"path":["companies"],"host":["https://api.allbound.com/v1"],"query":[{"description":{"content":"Page number
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Limit of items per page
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Name of the sorting column, start with - for desc
\n","type":"text/plain"},"key":"sort","value":"-status"},{"description":{"content":"Search keyword for searching on name, account_owners, address, cam_email, or website
\n","type":"text/plain"},"key":"search","value":"mycomp"},{"description":{"content":"Filter on the status field. Possible values are {pending, active, inactive}
Filter on the last_updated_date field.
Filter on the account_owners field using user's m_id. Give comma separated for multiple.
Filter on the company Allbound id field. Give comma separated for multiple.
Filter on the name field. It should always be url encoded and name separated by |
Filter on any of the meta fields. Here example is for filters[meta.crm_id]=DEF2232D
(Required)
\n","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required)
\n","key":"instance","value":"cloudrocket"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"input\": [\n {\n \"name\": \"Halloween Corp\",\n \"website\": \"www.halloweencorp.com\",\n \"status\": \"active\",\n \"logo\": \"path/to/logo.png\",\n \"street_address\": \"123 Main St\",\n \"address_line_2\": \"Additional address information\",\n \"city\": \"culpa\",\n \"state_province\": \"California\",\n \"zip_postal\": \"244001\",\n \"country\": \"USA\",\n \"crm_id\": \"123457532\",\n \"ab_account_type\": \"partner\",\n \"phone\": \"76786779997\"\n },\n {\n \"name\": \"Halloween Corp\",\n \"website\": \"www.halloweencorp.com\",\n \"status\": \"active\",\n \"logo\": \"path/to/logo.png\",\n \"street_address\": \"123 Main St\",\n \"address_line_2\": \"Additional address information\",\n \"city\": \"an\",\n \"state_province\": \"California\",\n \"zip_postal\": \"244001\",\n \"country\": \"USA\",\n \"crm_id\": \"123457532\",\n \"ab_account_type\": \"partner\",\n \"phone\": \"76786779997\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.allbound.com/v1/companies","description":"This endpoint enables the creation of one or multiple companies within the Allbound system. \nCompanies can be created with various attributes including their name, website, logo, status, \naddress details, CRM ID, account type, and phone number.
\nTo authenticate the request, include the x-api-key header and ensure your API credentials have the users.manage permission.
The request should be formatted as a JSON array containing objects, with each object representing \na company to be created.
\nRequired fields for each company include name, website, and status.
Validations:
\nstatus must be one of the following values {pending, active, inactive}. ab_account_type must be one of the following values {partner, partner_2}.Upon successful creation, the response will include the ID and creation date of the newly created \ncompany(s), along with a success code. In case of validation errors or malformed requests, \nappropriate error messages and status codes will be returned.
\n","urlObject":{"path":["companies"],"host":["https://api.allbound.com/v1"],"query":[],"variable":[]}},"response":[{"id":"4bde7de6-7c74-4e36-8d50-55af7d713402","name":"OK","originalRequest":{"method":"POST","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"input\": [\n {\n \"name\": \"Halloween Corp\",\n \"website\": \"www.halloweencorp.com\",\n \"status\": \"active\",\n \"logo\": \"path/to/logo.png\",\n \"street_address\": \"123 Main St\",\n \"address_line_2\": \"Additional address information\",\n \"city\": \"culpa\",\n \"state_province\": \"California\",\n \"zip_postal\": \"244001\",\n \"country\": \"USA\",\n \"crm_id\": \"123457532\",\n \"ab_account_type\": \"partner\",\n \"phone\": \"76786779997\"\n },\n {\n \"name\": \"Halloween Corp\",\n \"website\": \"www.halloweencorp.com\",\n \"status\": \"active\",\n \"logo\": \"path/to/logo.png\",\n \"street_address\": \"123 Main St\",\n \"address_line_2\": \"Additional address information\",\n \"city\": \"an\",\n \"state_province\": \"California\",\n \"zip_postal\": \"244001\",\n \"country\": \"USA\",\n \"crm_id\": \"123457532\",\n \"ab_account_type\": \"partner\",\n \"phone\": \"76786779997\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.allbound.com/v1/companies"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"created_date\": \"2024-01-31 23:00:37\",\n \"id\": 1696\n }\n ],\n \"success\": true,\n \"code\": 200\n}"},{"id":"1e733041-5196-497c-b69d-0b797f84a4c9","name":"Bad request","originalRequest":{"method":"POST","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"input\": [\n {\n \"name\": \"Halloween Corp\",\n \"website\": \"www.halloweencorp.com\",\n \"status\": \"active\",\n \"logo\": \"path/to/logo.png\",\n \"street_address\": \"123 Main St\",\n \"address_line_2\": \"Additional address information\",\n \"city\": \"culpa\",\n \"state_province\": \"California\",\n \"zip_postal\": \"244001\",\n \"country\": \"USA\",\n \"crm_id\": \"123457532\",\n \"ab_account_type\": \"partner\",\n \"phone\": \"76786779997\"\n },\n {\n \"name\": \"Halloween Corp\",\n \"website\": \"www.halloweencorp.com\",\n \"status\": \"active\",\n \"logo\": \"path/to/logo.png\",\n \"street_address\": \"123 Main St\",\n \"address_line_2\": \"Additional address information\",\n \"city\": \"an\",\n \"state_province\": \"California\",\n \"zip_postal\": \"244001\",\n \"country\": \"USA\",\n \"crm_id\": \"123457532\",\n \"ab_account_type\": \"partner\",\n \"phone\": \"76786779997\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.allbound.com/v1/companies"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"errors\": [\n {\n \"message\": \"ab_account_type: Invalid value. Expected one of: partner, partner_2\",\n \"key\": \"body.input\"\n }\n ],\n \"success\": {}\n}"}],"_postman_id":"227b238e-2358-4683-8731-50cebd1be653"},{"name":"Update one or multiple companies","id":"64581fed-4d4f-417f-9ef1-b7eb10f55736","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"description":"(Required)
\n","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required)
\n","key":"instance","value":"cloudrocket"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"input\": [\n {\n \"name\": \"Halloween Corp\",\n \"website\": \"www.halloweencorp.com\",\n \"status\": \"active\",\n \"id\": 869,\n \"logo\": \"path/to/logo.png\",\n \"street_address\": \"123 Main St\",\n \"address_line_2\": \"Additional address information\",\n \"city\": \"magna cillum deseru\",\n \"state_province\": \"California\",\n \"zip_postal\": \"244001\",\n \"country\": \"USA\",\n \"crm_id\": \"123457532\",\n \"ab_account_type\": \"partner\",\n \"phone\": \"76786779997\"\n },\n {\n \"name\": \"Halloween Corp\",\n \"website\": \"www.halloweencorp.com\",\n \"status\": \"active\",\n \"id\": 869,\n \"logo\": \"path/to/logo.png\",\n \"street_address\": \"123 Main St\",\n \"address_line_2\": \"Additional address information\",\n \"city\": \"ea\",\n \"state_province\": \"California\",\n \"zip_postal\": \"244001\",\n \"country\": \"USA\",\n \"crm_id\": \"123457532\",\n \"ab_account_type\": \"partner\",\n \"phone\": \"76786779997\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.allbound.com/v1/companies","description":"This endpoint allows for the update of one or multiple existing companies within the Allbound system. \nCompanies can be updated with various attributes including their name, website, logo, status, address details, \nCRM ID, account type, and phone number.
\nNote: Although this is a PUT request it functions as a PATCH.
\nTo authenticate the request, include the x-api-key header and ensure your API credentials have the users.manage permission.
The request should be formatted as a JSON array containing objects, with each object representing \na company to be updated.
\nRequired fields for each company include id, name, website, and status.
Validations:
\nstatus must be one of the following values {pending, active, inactive}.ab_account_type must be one of the following values {partner, partner_2}.Upon successful update, the response will include the ID and updated date of the affected company/companies \nalong with a success code. If any companies fail to be updated due to not being found, appropriate error \nmessages will be returned for those companies, along with their IDs.
\n","urlObject":{"path":["companies"],"host":["https://api.allbound.com/v1"],"query":[],"variable":[]}},"response":[{"id":"949b19f5-0feb-45ed-afc1-8a7e7b3b7d59","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"input\": [\n {\n \"name\": \"Halloween Corp\",\n \"website\": \"www.halloweencorp.com\",\n \"status\": \"active\",\n \"id\": 869,\n \"logo\": \"path/to/logo.png\",\n \"street_address\": \"123 Main St\",\n \"address_line_2\": \"Additional address information\",\n \"city\": \"magna cillum deseru\",\n \"state_province\": \"California\",\n \"zip_postal\": \"244001\",\n \"country\": \"USA\",\n \"crm_id\": \"123457532\",\n \"ab_account_type\": \"partner\",\n \"phone\": \"76786779997\"\n },\n {\n \"name\": \"Halloween Corp\",\n \"website\": \"www.halloweencorp.com\",\n \"status\": \"active\",\n \"id\": 869,\n \"logo\": \"path/to/logo.png\",\n \"street_address\": \"123 Main St\",\n \"address_line_2\": \"Additional address information\",\n \"city\": \"ea\",\n \"state_province\": \"California\",\n \"zip_postal\": \"244001\",\n \"country\": \"USA\",\n \"crm_id\": \"123457532\",\n \"ab_account_type\": \"partner\",\n \"phone\": \"76786779997\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.allbound.com/v1/companies"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"success\": true,\n \"data\": {\n \"updated\": [\n {\n \"updated_date\": \"2024-01-31 12:08:47\",\n \"id\": \"138\"\n },\n {\n \"updated_date\": \"2024-01-31 12:08:47\",\n \"id\": \"163\"\n },\n {\n \"updated_date\": \"2024-02-15 11:53:20\",\n \"id\": \"403\"\n }\n ],\n \"not_updated\": [\n {\n \"error\": \"Company not found\",\n \"id\": \"324\"\n }\n ]\n }\n}"},{"id":"048936c6-b516-42e5-9cc8-18bac09ea155","name":"Bad request","originalRequest":{"method":"PUT","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"input\": [\n {\n \"name\": \"Halloween Corp\",\n \"website\": \"www.halloweencorp.com\",\n \"status\": \"active\",\n \"id\": 869,\n \"logo\": \"path/to/logo.png\",\n \"street_address\": \"123 Main St\",\n \"address_line_2\": \"Additional address information\",\n \"city\": \"magna cillum deseru\",\n \"state_province\": \"California\",\n \"zip_postal\": \"244001\",\n \"country\": \"USA\",\n \"crm_id\": \"123457532\",\n \"ab_account_type\": \"partner\",\n \"phone\": \"76786779997\"\n },\n {\n \"name\": \"Halloween Corp\",\n \"website\": \"www.halloweencorp.com\",\n \"status\": \"active\",\n \"id\": 869,\n \"logo\": \"path/to/logo.png\",\n \"street_address\": \"123 Main St\",\n \"address_line_2\": \"Additional address information\",\n \"city\": \"ea\",\n \"state_province\": \"California\",\n \"zip_postal\": \"244001\",\n \"country\": \"USA\",\n \"crm_id\": \"123457532\",\n \"ab_account_type\": \"partner\",\n \"phone\": \"76786779997\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.allbound.com/v1/companies"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"errors\": [\n {\n \"message\": \"ab_account_type: Invalid value. Expected one of: partner, partner_2\",\n \"key\": \"body.input\"\n }\n ],\n \"success\": {}\n}"},{"id":"cdcaf079-c8b2-421c-8fe4-4496dc61e4c7","name":"Not found","originalRequest":{"method":"PUT","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"input\": [\n {\n \"name\": \"Halloween Corp\",\n \"website\": \"www.halloweencorp.com\",\n \"status\": \"active\",\n \"id\": 869,\n \"logo\": \"path/to/logo.png\",\n \"street_address\": \"123 Main St\",\n \"address_line_2\": \"Additional address information\",\n \"city\": \"magna cillum deseru\",\n \"state_province\": \"California\",\n \"zip_postal\": \"244001\",\n \"country\": \"USA\",\n \"crm_id\": \"123457532\",\n \"ab_account_type\": \"partner\",\n \"phone\": \"76786779997\"\n },\n {\n \"name\": \"Halloween Corp\",\n \"website\": \"www.halloweencorp.com\",\n \"status\": \"active\",\n \"id\": 869,\n \"logo\": \"path/to/logo.png\",\n \"street_address\": \"123 Main St\",\n \"address_line_2\": \"Additional address information\",\n \"city\": \"ea\",\n \"state_province\": \"California\",\n \"zip_postal\": \"244001\",\n \"country\": \"USA\",\n \"crm_id\": \"123457532\",\n \"ab_account_type\": \"partner\",\n \"phone\": \"76786779997\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.allbound.com/v1/companies"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 404,\n \"errors\": {\n \"not_updated\": [\n {\n \"error\": \"Company not found\",\n \"id\": 123\n },\n {\n \"error\": \"Company not found\",\n \"id\": 965\n }\n ],\n \"updated\": {}\n },\n \"success\": {}\n}"}],"_postman_id":"64581fed-4d4f-417f-9ef1-b7eb10f55736"},{"name":"Delete companies by IDs","id":"f8e0a7ca-1fe3-4676-95f9-38faf2f4890c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"(Required)
\n","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required)
\n","key":"instance","value":"cloudrocket"},{"key":"Accept","value":"application/json"}],"url":"https://api.allbound.com/v1/companies?ids=123,345,321,654","description":"This endpoint allows the deletion of companies based on their IDs. It accepts a comma separated string of company IDs \nas input and deletes the corresponding companies from the system. If a company is successfully deleted, \nits ID along with the deletion timestamp will be returned in the response. If a company is not found \nor cannot be deleted for any reason, an appropriate error message will be provided.
\nTo authenticate the request, include the x-api-key header and ensure your API credentials have the users.manage permission.
To use this endpoint, provide the list of company IDs to be deleted as a comma-separated string in \nthe query parameter ids.
Note: To prevent orphaned users, please ensure that the company has no active users associated to the company (as a primary company) before deleting.
\n","urlObject":{"path":["companies"],"host":["https://api.allbound.com/v1"],"query":[{"description":{"content":"(Required) Comma-separated string of company ids to delete
\n","type":"text/plain"},"key":"ids","value":"123,345,321,654"}],"variable":[]}},"response":[{"id":"d51e3d3b-9d3e-4fc9-9f46-1c4d1857da4d","name":"OK","originalRequest":{"method":"DELETE","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.allbound.com/v1/companies?ids=123,345,321,654","host":["https://api.allbound.com/v1"],"path":["companies"],"query":[{"description":"(Required) Comma-separated string of company ids to delete","key":"ids","value":"123,345,321,654"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"success\": true,\n \"data\": {\n \"deleted\": [\n {\n \"deleted_date\": \"2024-01-31 12:08:47\",\n \"id\": \"123\"\n },\n {\n \"deleted_date\": \"2024-01-31 12:08:47\",\n \"id\": \"345\"\n },\n {\n \"deleted_date\": \"2024-02-15 11:53:20\",\n \"id\": \"321\"\n }\n ],\n \"not_deleted\": [\n {\n \"error\": \"Company not found\",\n \"id\": \"654\"\n }\n ]\n }\n}"},{"id":"5264e636-da94-417a-95a9-5c4c283051ca","name":"Bad request","originalRequest":{"method":"DELETE","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.allbound.com/v1/companies?ids=123,345,321,654","host":["https://api.allbound.com/v1"],"path":["companies"],"query":[{"description":"(Required) Comma-separated string of company ids to delete","key":"ids","value":"123,345,321,654"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400\n}"},{"id":"68c88cc4-0a4a-46e4-9bfa-a69efec9ea64","name":"Not found","originalRequest":{"method":"DELETE","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.allbound.com/v1/companies?ids=123,345,321,654","host":["https://api.allbound.com/v1"],"path":["companies"],"query":[{"description":"(Required) Comma-separated string of company ids to delete","key":"ids","value":"123,345,321,654"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 404,\n \"errors\": {\n \"not_deleted\": [\n {\n \"error\": \"Company not found\",\n \"id\": 123\n },\n {\n \"error\": \"Company not found\",\n \"id\": 965\n }\n ],\n \"deleted\": {}\n },\n \"success\": {}\n}"}],"_postman_id":"f8e0a7ca-1fe3-4676-95f9-38faf2f4890c"},{"name":"List users associated with a company","id":"abfa26cc-b429-4137-9305-8df3c370fcc1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"(Required)
\n","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required)
\n","key":"instance","value":"cloudrocket"},{"key":"Accept","value":"application/json"}],"url":"https://api.allbound.com/v1/companies/:company_id/users?filters[company_role]=sales","description":"This endpoint retrieves a list of users associated with a specific company identified by its legacy ID. \nOptionally, you can filter the users based on their roles within the company using the filters[company_role] query parameter.
The response includes detailed information about each user, such as their ID, email address, \ncreation date, company details, role, name, job title, MDF request permission, and status.
\nTo authenticate the request, include the x-api-key header and ensure your API credentials have the companies.read or companies.manage permission.
Filter on the User's role in company. Possible values are {owner, executive, manager, sales}
(Required) Company Allbound ID
\n","type":"text/plain"},"type":"any","value":"1234","key":"company_id"}]}},"response":[{"id":"850cdafb-7b0f-49bb-906a-405cdb9d9ae1","name":"OK","originalRequest":{"method":"GET","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.allbound.com/v1/companies/:company_id/users?filters[company_role]=sales","host":["https://api.allbound.com/v1"],"path":["companies",":company_id","users"],"query":[{"description":"Filter on the `User's role in company`. Possible values are {owner, executive, manager, sales}","key":"filters[company_role]","value":"sales"}],"variable":[{"key":"company_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5f8b7a57e8f22b1f3450837d\",\n \"legacy_id\": \"3452\",\n \"user_email\": \"mail@example.com\",\n \"created_date\": \"2020-04-24 12:53:48\",\n \"legacy_company_id\": \"1234\",\n \"company_name\": \"Aaron Innovations\",\n \"company_role\": \"sales\",\n \"first_name\": \"Rohan\",\n \"last_name\": \"Bhardwaj\",\n \"job_title\": \"Senior Engineer\",\n \"can_request_mdf\": \"1\",\n \"status\": \"active\"\n },\n {\n \"id\": \"5f8b7a57e8f22b1f3450837d\",\n \"legacy_id\": \"3452\",\n \"user_email\": \"mail@example.com\",\n \"created_date\": \"2020-04-24 12:53:48\",\n \"legacy_company_id\": \"1234\",\n \"company_name\": \"Aaron Innovations\",\n \"company_role\": \"sales\",\n \"first_name\": \"Rohan\",\n \"last_name\": \"Bhardwaj\",\n \"job_title\": \"Senior Engineer\",\n \"can_request_mdf\": \"1\",\n \"status\": \"active\"\n }\n ],\n \"code\": 200,\n \"success\": false\n}"}],"_postman_id":"abfa26cc-b429-4137-9305-8df3c370fcc1"},{"name":"List company fields","id":"a084c35e-52c8-45c5-8e7f-45fa8aa52dba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"(Required)
\n","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required)
\n","key":"instance","value":"cloudrocket"},{"key":"Accept","value":"application/json"}],"url":"https://api.allbound.com/v1/companies/fields","description":"This endpoint retrieves a list of fields associated with companies. These fields include \ninformation such as the key, label, values, type, and whether they are filterable or not.
\nTo authenticate the request, include the x-api-key header and ensure your API credentials have the companies.read or companies.manage permission.
The response includes an array of objects, each representing a company field. Each field \nobject contains details such as the key, label, values, type, and a boolean indicating \nwhether it is filterable.
\nAlongside the list of company fields, the response also includes metadata such as the HTTP \nstatus code and a boolean indicating the success of the request.
\n","urlObject":{"path":["companies","fields"],"host":["https://api.allbound.com/v1"],"query":[],"variable":[]}},"response":[{"id":"f4e32996-dfff-4137-b212-63b9cdff4221","name":"OK","originalRequest":{"method":"GET","header":[{"description":"(Required) ","key":"x-api-key","value":"2c18d054-0075-48bb-ab1a-5dfdfd3dsds"},{"description":"(Required) ","key":"instance","value":"cloudrocket"},{"key":"Accept","value":"application/json"}],"url":"https://api.allbound.com/v1/companies/fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"key\": \"ID\",\n \"label\": \"ID\",\n \"values\": \"12345\",\n \"type\": \"number\",\n \"filterable\": false\n },\n {\n \"key\": \"ID\",\n \"label\": \"ID\",\n \"values\": \"12345\",\n \"type\": \"number\",\n \"filterable\": false\n }\n ],\n \"code\": 200,\n \"success\": true\n}"}],"_postman_id":"a084c35e-52c8-45c5-8e7f-45fa8aa52dba"}],"id":"9ea191b1-0f61-4146-8eef-44a04aacae6b","description":"The Allbound Companies API constitute a collection of endpoints crafted to streamline company management within our application. Encompassing a spectrum of functionalities, these endpoints facilitate operations such as company retrieval, creation, updates, and deletions. Serving as a centralized hub for company-related activities, this module ensures an efficient and user-friendly experience. Whether obtaining a list of companies, creating new company profiles, or updating existing information, the encapsulated endpoints provide a cohesive and versatile solution for effective company administration.
\n","_postman_id":"9ea191b1-0f61-4146-8eef-44a04aacae6b"},{"name":"Actions","item":[{"name":"Retrieve a list of all actions for a customer","id":"0058c671-ce65-4545-b86f-e4b74181f33c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"(Required)
\n","key":"x-api-key","value":"deserunt ut quis dolore"},{"description":"(Required)
\n","key":"instance","value":"deserunt ut quis dolore"},{"key":"Accept","value":"application/json"}],"url":"https://api.allbound.com/v1/v1/actions?filters[resourceId]=91123&filters[userId]=223&filters[action]=logged_in&filters[actionTime$lte]=2023-07-01 or 2023-07-01T00:00:00.000Z&filters[actionTime$gte]=2023-01-01 or 2023-01-01T00:00:00.000Z&limit=10&page=1&fields=id,action","urlObject":{"path":["v1","actions"],"host":["https://api.allbound.com/v1"],"query":[{"description":{"content":"Filter for resources by id, allowed resources are deal, lead, mdf, content
\n","type":"text/plain"},"key":"filters[resourceId]","value":"91123"},{"description":{"content":"Filtering actions by userId, the user id is the legacy id of the user in the system
\n","type":"text/plain"},"key":"filters[userId]","value":"223"},{"description":{"content":"Filter for name of the action
\n","type":"text/plain"},"key":"filters[action]","value":"logged_in"},{"description":{"content":"Filter for actions that took place in the system before the date/timestamp
\n","type":"text/plain"},"key":"filters[actionTime$lte]","value":"2023-07-01 or 2023-07-01T00:00:00.000Z"},{"description":{"content":"Filter for actions that took place in the system after the date/timestamp
\n","type":"text/plain"},"key":"filters[actionTime$gte]","value":"2023-01-01 or 2023-01-01T00:00:00.000Z"},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Page number
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Comma-separated list of properties to fetch in the response. Allowed values are: id, action, userId, gamificationPoints, actionTime
\n","type":"text/plain"},"key":"fields","value":"id,action"}],"variable":[]}},"response":[{"id":"e426fa6a-f525-48c0-a28f-bcbc0896f9f9","name":"OK","originalRequest":{"method":"GET","header":[{"description":"(Required) ","key":"x-api-key","value":"deserunt ut quis dolore"},{"description":"(Required) ","key":"instance","value":"deserunt ut quis dolore"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.allbound.com/v1/v1/actions?filters[resourceId]=91123&filters[userId]=223&filters[action]=logged_in&filters[actionTime$lte]=2023-07-01 or 2023-07-01T00:00:00.000Z&filters[actionTime$gte]=2023-01-01 or 2023-01-01T00:00:00.000Z&limit=10&page=1&fields=id,action","host":["https://api.allbound.com/v1"],"path":["v1","actions"],"query":[{"description":"Filter for resources by id, allowed resources are deal, lead, mdf, content","key":"filters[resourceId]","value":"91123"},{"description":"Filtering actions by userId, the user id is the legacy id of the user in the system","key":"filters[userId]","value":"223"},{"description":"Filter for name of the action","key":"filters[action]","value":"logged_in"},{"description":"Filter for actions that took place in the system before the date/timestamp","key":"filters[actionTime$lte]","value":"2023-07-01 or 2023-07-01T00:00:00.000Z"},{"description":"Filter for actions that took place in the system after the date/timestamp","key":"filters[actionTime$gte]","value":"2023-01-01 or 2023-01-01T00:00:00.000Z"},{"description":"Number of items per page","key":"limit","value":"10"},{"description":"Page number","key":"page","value":"1"},{"description":"Comma-separated list of properties to fetch in the response. Allowed values are: id, action, userId, gamificationPoints, actionTime","key":"fields","value":"id,action"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 0,\n \"action\": \"string\",\n \"actionUser\": {\n \"id\": \"61518bca0273856c8b22925d\",\n \"legacyId\": 10223,\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\"\n },\n \"resource\": {\n \"id\": 974,\n \"type\": \"learning_track\",\n \"title\": \"The importance of learning and management in a PRM ecosystem\",\n \"url\": \"https://cloudrocket.allbound.com/learning_tracks/The_Importance_LMS\",\n \"status\": \"published\"\n },\n \"actionTime\": \"2023-04-11T17:13:56.625Z\",\n \"gamificationPoints\": 82247270.2114237\n },\n {\n \"id\": 0,\n \"action\": \"string\",\n \"actionUser\": {\n \"id\": \"61518bca0273856c8b22925d\",\n \"legacyId\": 10223,\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\"\n },\n \"resource\": {\n \"id\": 974,\n \"type\": \"learning_track\",\n \"title\": \"The importance of learning and management in a PRM ecosystem\",\n \"url\": \"https://cloudrocket.allbound.com/learning_tracks/The_Importance_LMS\",\n \"status\": \"published\"\n },\n \"actionTime\": \"2023-04-11T17:13:56.625Z\",\n \"gamificationPoints\": -14662880.195527524\n }\n ],\n \"meta\": {\n \"total_count\": 25600,\n \"total_pages\": 256,\n \"next\": \"https://api-public.allbound.com/v1/actions?page=3&limit=100\",\n \"previous\": \"https://api-public.allbound.com/v1/actions?page=1&limit=100\"\n }\n}"},{"id":"b141196d-5942-45e7-a46c-8ef3ac7ab273","name":"Something went wrong! Contact support","originalRequest":{"method":"GET","header":[{"description":"(Required) ","key":"x-api-key","value":"deserunt ut quis dolore"},{"description":"(Required) ","key":"instance","value":"deserunt ut quis dolore"}],"url":{"raw":"https://api.allbound.com/v1/v1/actions?filters[resourceId]=91123&filters[userId]=223&filters[action]=logged_in&filters[actionTime$lte]=2023-07-01 or 2023-07-01T00:00:00.000Z&filters[actionTime$gte]=2023-01-01 or 2023-01-01T00:00:00.000Z&limit=10&page=1&fields=id,action","host":["https://api.allbound.com/v1"],"path":["v1","actions"],"query":[{"description":"Filter for resources by id, allowed resources are deal, lead, mdf, content","key":"filters[resourceId]","value":"91123"},{"description":"Filtering actions by userId, the user id is the legacy id of the user in the system","key":"filters[userId]","value":"223"},{"description":"Filter for name of the action","key":"filters[action]","value":"logged_in"},{"description":"Filter for actions that took place in the system before the date/timestamp","key":"filters[actionTime$lte]","value":"2023-07-01 or 2023-07-01T00:00:00.000Z"},{"description":"Filter for actions that took place in the system after the date/timestamp","key":"filters[actionTime$gte]","value":"2023-01-01 or 2023-01-01T00:00:00.000Z"},{"description":"Number of items per page","key":"limit","value":"10"},{"description":"Page number","key":"page","value":"1"},{"description":"Comma-separated list of properties to fetch in the response. Allowed values are: id, action, userId, gamificationPoints, actionTime","key":"fields","value":"id,action"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0058c671-ce65-4545-b86f-e4b74181f33c"}],"id":"727c9002-d3e3-4917-aa5a-f5804995942d","_postman_id":"727c9002-d3e3-4917-aa5a-f5804995942d","description":""}],"variable":[{"id":"a187e500-d676-4589-8f2f-efe9cb76f449","key":"baseUrl","value":"https://api.allbound.com/v1"}]}