The Outseta REST API enables customers to perform a variety of powerful tasks such as creating and updating people, accounts, subscriptions and invoices. Outseta uses standard HTTP protocols within a compliant architecture that is simple to integrate. You can use the API both on the client or the server side; see instructions for authorization for each scenario in the getting started section.
\nThe easiest way to get started with the API is to click the Run in Postman button present at the top of the documentation page and use the Postman App to send requests. Make sure to update the Outseta environment information at the top right corner of Postman so that it can be applied automatically when you send requests.
\nYou need to include a valid authorization token to send requests to the API endpoints.
\nTo construct the authorization token you need to create an API key under Settings >> Integrations >> API Keys. Make sure to record the secret key when you create the new API Key. Then construct the token as follows:
\n\"Outseta [APIKey]:[SecretKey]\"
\nExample:
\nOutseta ce08fd5a-e1ee-4472-9c5f-b7575d8369b2:74fc1d2242a4eb7336d34b0e40cfbc5f
\nIf you plan to use the API from the client side do NOT use the API keys as those are unsecure on the client side and can be easily copied. Instead construct the authorization token by calling the Get Auth API from the server side with your Outseta username and password. Then construct the authorization token as follows:
\n\"bearer [access_token]\"
\nExample:
\nbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6InhObnZiLWxaWDJWNHdKTFctaVdreXBSR0cwVSJ9.eyJ1bmlxdWVfbmFtZSI6ImRpbWl0cmlzQG91dHNldGEuY29tIiwiZ2l2ZW5fbmFtZSI6IkRpbWl0cmlzIiwiZmFtaWx5X25hbWUiOiJHZW9yZ2Frb3BvdWxvcyIsImVtYWlsIjoiZGltaXRyaXNAb3V0c2V0YS5jb20iLCJuYW1laWQiOiI0WFFZcVFQQiIsIm91dHNldGE6YWNjb3VudFVpZCI6IndabU5abTJPIiwib3V0c2V0YTphY2NvdW50Q2xpZW50SWRlbnRpZmllciI6IjEiLCJ
\nFor the URL use your outseta domain name and append /api/v1 https://[yourdomain].outseta.com/api/v1
\nThe API will only respond to secured communication done over HTTPS. HTTP requests will be sent a 301 redirect to corresponding HTTPS resources.
\nResponse to every request is sent in JSON format. In case the API request results in an error, it is represented by an \"error\": {} key in the JSON response.
\nThe request method (verb) determines the nature of action you intend to perform. A request made using the GET method implies that you want to fetch something from Outseta, and POST implies you want to save something new to Outseta.
\nThe API calls will respond with appropriate HTTP status codes for all requests. A 200 OK indicates all went well, while 4XX or 5XX response codes indicate an error from the requesting client or our API servers respectively.
\nUse \"donotlog=1\" as part of the querystring on any API call where you don't want to trigger the action performed being logged in the activity log.
\nYou can apply filtering by adding additional information on the querystring on the methods that retrieve all the entities in a domain (e.g., Get all accounts, Get all people). The conventions are as follows:
\nWhen you make an API request, you'll automatically get all the basic information from the main object and its immediate child objects. Think of it as getting the \"standard package\" of data.
\nChange this behaviour by using the fields query param:
Go deeper: Want information that's nested further down? The fields param lets you request fields lower down in the object tree: ?fields=CurrentSubscription.Plan.*
Go lighter: Want just the essentials for faster performance? The fields param lets you request only the root-level information: ?fields=Uid,Name
Or do a combination: ?fields=Uid,Name,CurrentSubscription.Plan.Uid
Wildcard: Use * to get all fields in an object: ?fields=* or ?fields=CurrentSubscription.Plan.*
<!-- Get the current subscription plan uid -->\nGET https://[your-domain].outseta.com/api/v1/crm/accounts/[uid-of-an-account]?fields=CurrentSubscription.Plan.Uid\n\n<!-- Get the account UID and the plan UID for a list of accounts -->\nGET https://[your-domain].outseta.com/api/v1/crm/accounts?fields=Uid,CurrentSubscription.Plan.Uid\n\n<!-- Get the full plan object for an account's current subscription -->\nGET https://[your-domain].outseta.com/api/v1/crm/accounts/[uid-of-an-account]?fields=CurrentSubscription.Plan.*\n\n<!-- Get the account UID and the plan UID for a person's current subscription(s) -->\nGET https://[your-domain].outseta.com/api/v1/crm/people/[uid-of-a-person]?fields=Uid,PersonAccount.Account.CurrentSubscription.Plan.Uid\noffset=defines which page to start \nlimit=number of records to return for each page\n?offset=0&limit=20 (returns results 1-20)\n?offset=1&limit=20 (returns results 21-40)\n\nIf your request includes fields from a child object you will be limited to retrieving 25 items in a single request. The maximum number of results returned in requests not requesting child object fields is 100 items.
\nSorts the resultset based on the property and sort clause defined\n?orderBy=PropertyName+DESC\n\nFilter your data using query parameters to find specific records. You can use exact matches or comparison operators for more advanced filtering scenarios.
\nFilter on any field using the field as the query parameters: ?Email=john@example.com
For advanced filtering, append comparison operators to field names:
\n<!-- Date Filtering -->\nGET https://[your-domain].outseta.com/api/v1/crm/accounts?Created__gt=2024-01-01\nGET https://[your-domain].outseta.com/api/v1/billing/subscriptions?EndDate__lt=2024-08-01\n\n<!-- Numeric Filtering -->\nGET https://[your-domain].outseta.com/api/v1/billing/invoices?Amount__gte=1000\nGET https://[your-domain].outseta.com/api/v1/billing/plans?MonthlyRate__lt=50\n\n<!-- Status Filtering -->\nGET https://[your-domain].outseta.com/api/v1/crm/accounts?AccountStageLabel__ne=Cancelled\n\n<!-- Null Value Filtering -->\nGET https://[your-domain].outseta.com/api/v1/crm/people?ProfileImageS3Url__isnull=true\nGET https://[your-domain].outseta.com/api/v1/crm/accounts?ClientIdentifier__isnull=false\n\n<!-- Multiple Filters -->\nGET https://[your-domain].outseta.com/api/v1/billing/subscriptions?\n StartDate__gte=2024-01-01&\n Rate__lt=100&\n DiscountCode__isnull=false\n\n<!-- Complex Example with Field Selection -->\nGET https://[your-domain].outseta.com/api/v1/billing/subscriptions?\n Rate__gte=500&\n DiscountCode__isnull=false&\n fields=Uid,Amount,StartDate,DiscountCode,Plan.Name\nRequests authorized by an API Key should not exceed 4 requests/second.
\nFor help regarding the Outseta API please email support@outseta.com
\nRetrieves all the people associated with your account.
\n","urlObject":{"path":["crm","people"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"789fe0d0-597a-9107-f403-cbe4ecf6c44b","name":"Get all people","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"•••••••"},{"key":"Content-Type","value":"application/json"}],"url":"https://webflow-demo.outseta.com/api/v1/crm/people"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"16919","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 26 Jan 2018 20:30:18 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcRGV2ZWxvcG1lbnRcT3V0c2V0YVxPdXRzZXRhLldlYi5DbGllbnRcYXBpXHYxXGNybVxwZW9wbGU=?=","name":"X-SourceFiles","description":""}],"cookie":[],"responseTime":"2440","body":"{\n \"metadata\": {\n \"limit\": 100,\n \"offset\": 0,\n \"total\": 2\n },\n \"items\": [\n {\n \"Email\": \"example@outseta.com\",\n \"FirstName\": \"My\",\n \"LastName\": \"example\",\n \"MailingAddress\": null,\n \"PhoneMobile\": \"\",\n \"PhoneWork\": \"\",\n \"Timezone\": null,\n \"EmailBounceDateTime\": null,\n \"EmailSpamDateTime\": null,\n \"EmailUnsubscribeDateTime\": null,\n \"EmailLastDeliveredDateTime\": null,\n \"PersonAccount\": [],\n \"FullName\": \"example@outseta.com\",\n \"Uid\": \"qrm0A4QX\",\n \"Created\": \"2017-04-05T11:23:56\",\n \"Updated\": \"2017-04-05T11:23:56\"\n },\n {\n \"Email\": \"second@yahoo.com\",\n \"FirstName\": \"Second\",\n \"LastName\": \"Example\",\n \"MailingAddress\": {\n \"AddressLine1\": \"1 main street\",\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"City\": \"Brookline\",\n \"State\": \"MA\",\n \"PostalCode\": \"02446\",\n \"Uid\": \"Kj9bxomn\",\n \"Created\": \"2017-03-17T15:53:14\",\n \"Updated\": \"2017-03-17T15:53:49\"\n },\n \"PhoneMobile\": \"\",\n \"PhoneWork\": \"\",\n \"Timezone\": null,\n \"EmailBounceDateTime\": null,\n \"EmailSpamDateTime\": null,\n \"EmailUnsubscribeDateTime\": null,\n \"EmailLastDeliveredDateTime\": null,\n \"FullName\": \"My Example\",\n \"Uid\": \"bB9l5DW8\",\n \"Created\": \"2017-01-23T08:54:06\",\n \"Updated\": \"2017-03-31T16:29:05\"\n }\n ]\n}"}],"_postman_id":"68021219-0038-0214-2df5-d4a781cdbdf2"},{"name":"Get person","id":"71b4b9ba-b8d3-0d57-2d3b-5caf7e6395d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{url}}/crm/people/[personUid]","description":"Retrieves a person.
\n","urlObject":{"path":["crm","people","[personUid]"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"10f33560-15eb-db21-385f-6b1bcaeacca6","name":"Get person","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"•••••••"},{"key":"Content-Type","value":"application/json"}],"url":"https://webflow-demo.outseta.com/api/v1/crm/people/[personUid]"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"397","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 26 Jan 2018 20:32:00 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcRGV2ZWxvcG1lbnRcT3V0c2V0YVxPdXRzZXRhLldlYi5DbGllbnRcYXBpXHYxXGNybVxwZW9wbGVccXJtMEE0UVg=?=","name":"X-SourceFiles","description":""}],"cookie":[],"responseTime":"298","body":"{\n \"Email\": \"example@outseta.com\",\n \"FirstName\": \"My\",\n \"LastName\": \"Example\",\n \"MailingAddress\": null,\n \"PhoneMobile\": \"\",\n \"PhoneWork\": \"\",\n \"Timezone\": null,\n \"EmailBounceDateTime\": null,\n \"EmailSpamDateTime\": null,\n \"EmailUnsubscribeDateTime\": null,\n \"EmailLastDeliveredDateTime\": null,\n \"PersonAccount\": [],\n \"FullName\": \"My example\",\n \"Uid\": \"qrm0A4QX\",\n \"Created\": \"2017-04-05T11:23:56\",\n \"Updated\": \"2017-04-05T11:23:56\"\n}"}],"_postman_id":"71b4b9ba-b8d3-0d57-2d3b-5caf7e6395d1"},{"name":"Add person","id":"26b724e6-9a76-2156-c4dd-b40f3d53fc70","request":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Email\": \"example@me.com\",\n \"FirstName\": \"My\",\n \"LastName\": \"example\",\n \"MailingAddress\": {\n \"AddressLine1\": \"new line\",\n \"AddressLine2\": \"new line2\",\n \"AddressLine3\": null,\n \"City\": \"City\",\n \"State\": \"State\",\n \"PostalCode\": \"02446\"\n }\n}"},"url":"{{url}}/crm/people","urlObject":{"path":["crm","people"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"fbf7d4e4-1b82-02b7-370a-6a4ae64b8057","name":"Add person","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Email\": \"example@me.com\",\n \"FirstName\": \"My\",\n \"LastName\": \"example\",\n \"MailingAddress\": {\n \"AddressLine1\": \"new line\",\n \"AddressLine2\": \"new line2\",\n \"AddressLine3\": null,\n \"City\": \"City\",\n \"State\": \"State\",\n \"PostalCode\": \"02446\"\n }\n}"},"url":"{{url}}/crm/people"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"634","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 29 Jan 2018 16:25:52 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcRGV2ZWxvcG1lbnRcT3V0c2V0YVxPdXRzZXRhLldlYi5DbGllbnRcYXBpXHYxXGNybVxwZW9wbGU=?=","name":"X-SourceFiles","description":""}],"cookie":[],"responseTime":"1617","body":"{\"Email\":\"example@me.com\",\"FirstName\":\"My\",\"LastName\":\"example\",\"MailingAddress\":{\"AddressLine1\":\"new line\",\"AddressLine2\":\"new line2\",\"AddressLine3\":null,\"City\":\"City\",\"State\":\"State\",\"PostalCode\":\"02446\",\"Uid\":\"y7mar2QE\",\"Created\":\"2018-01-29T11:25:52.4923813-05:00\",\"Updated\":\"2018-01-29T11:25:52.4923813-05:00\"},\"PhoneMobile\":\"\",\"PhoneWork\":\"\",\"Timezone\":null,\"EmailBounceDateTime\":null,\"EmailSpamDateTime\":null,\"EmailUnsubscribeDateTime\":null,\"EmailLastDeliveredDateTime\":null,\"PersonAccount\":[],\"FullName\":\"My example\",\"Uid\":\"GnmDrY9y\",\"Created\":\"2018-01-29T11:25:52.4923813-05:00\",\"Updated\":\"2018-01-29T11:25:52.4923813-05:00\"}"}],"_postman_id":"26b724e6-9a76-2156-c4dd-b40f3d53fc70"},{"name":"Update person","id":"3c8dbc29-fe01-e053-3b01-35514e85d86e","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Email\": \"example@example.com\",\n \"FirstName\": \"My\",\n \"LastName\": \"example\",\n \"MailingAddress\": {\n \"Uid\": \"exmewp9V\",\n \"AddressLine1\": \"new line\",\n \"AddressLine2\": \"new line2\",\n \"AddressLine3\": null,\n \"City\": \"City\",\n \"State\": \"State\",\n \"PostalCode\": \"02446\"\n }\n}"},"url":"{{url}}/crm/people/[personUid]","description":"Update a person record. You can update one or multiple properties on the object. Any property that you include in the json schema will be updated. To update custom properties just include them in the same way that they are included when you do a get on the object.
\n","urlObject":{"path":["crm","people","[personUid]"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3c8dbc29-fe01-e053-3b01-35514e85d86e"},{"name":"Delete person","id":"cfc920b9-1ea6-355e-504a-e5b46f84c9d9","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/crm/people/[personUid]","description":"Delete a person record.
\n","urlObject":{"path":["crm","people","[personUid]"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cfc920b9-1ea6-355e-504a-e5b46f84c9d9"},{"name":"Set temporary password","id":"c47b9dff-0b25-64ff-0acd-7eb3029a88df","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"temporaryPassword\": \"gas-knew-shoe-danger\"\n}"},"url":"{{url}}/crm/people/[personUid]/setTemporaryPassword","description":"Set a temporary password for a user. The user needs to update the password with the next login.
\n","urlObject":{"path":["crm","people","[personUid]","setTemporaryPassword"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c47b9dff-0b25-64ff-0acd-7eb3029a88df"},{"name":"Initiate password reset","id":"0b6615e7-75ff-4e6c-9227-ef654db0f1f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Email\": \"person@example.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/crm/people/forgotPassword?parentUrl={{parentUrl}}","description":"Initiate the forgot password flow by sending an email to the user with a link to a page where they can reset their password. The reset password token in the link is valid for 30 minutes.
\n","urlObject":{"path":["crm","people","forgotPassword"],"host":["{{url}}"],"query":[{"description":{"content":"If this optional parameter is provided, the link for the user to set a new password will use this URL and add a querystring parameter for the reset token. Pages that have the Outseta script loaded will read this token and show the UI for setting a new password.
\nIf this parameter is not provided, the link will be for a page that Outseta provides for resetting the password.
\n","type":"text/plain"},"key":"parentUrl","value":"{{parentUrl}}"}],"variable":[]}},"response":[],"_postman_id":"0b6615e7-75ff-4e6c-9227-ef654db0f1f4"},{"name":"Send confirmation email to primary person on an account","id":"ea6f071e-db7b-4750-ab16-b42bb6dd712d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorizationtoken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/crm/accounts/{{accountUid}}/send-confirmation-email","urlObject":{"path":["crm","accounts","{{accountUid}}","send-confirmation-email"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ea6f071e-db7b-4750-ab16-b42bb6dd712d"},{"name":"Send confirmation email to specific person on an account","id":"3bcbc4cb-f814-499e-a428-fa3c7ac40aae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorizationtoken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/crm/accounts/{{accountUid}}/send-confirmation-email?personUid={{personUid}}","urlObject":{"path":["crm","accounts","{{accountUid}}","send-confirmation-email"],"host":["{{url}}"],"query":[{"key":"personUid","value":"{{personUid}}"}],"variable":[]}},"response":[],"_postman_id":"3bcbc4cb-f814-499e-a428-fa3c7ac40aae"},{"name":"Send confirmation email to all people on an account","id":"29d90504-0d17-47ea-aa5f-654822c796b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorizationtoken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/crm/accounts/{{accountUid}}/send-confirmation-email?personUid=*","urlObject":{"path":["crm","accounts","{{accountUid}}","send-confirmation-email"],"host":["{{url}}"],"query":[{"key":"personUid","value":"*"}],"variable":[]}},"response":[],"_postman_id":"29d90504-0d17-47ea-aa5f-654822c796b2"}],"id":"5c2c923a-b325-4d4b-bc60-ed01140859d6","_postman_id":"5c2c923a-b325-4d4b-bc60-ed01140859d6","description":""},{"name":"Accounts","item":[{"name":"Get account","id":"05e0dfbe-4413-6d3a-5e13-0f2f0f72fc55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{url}}/crm/accounts/[accountUid]","description":"Retrieves all the information related to an account.
\nAccount stages
\nThese stages are authomatically tracked for each account when accounts are tied to a subscription. Accounts set to demo are not billed for the subscriptions that are tied to them.
\n| Name | Value |
|---|---|
| Trialing | 2 |
| Subscribing | 3 |
| Cancelling | 4 |
| Expired | 5 |
| Trial expired | 6 |
| Past due | 7 |
Retrieves account information.
\n","urlObject":{"path":["crm","accounts",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"ebe46ac6-cdd9-d277-a63d-1fac7fbafe97","name":"Get all accounts","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://webflow-demo.outseta.com/api/v1/crm/accounts/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"34796","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 29 Jan 2018 15:43:18 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcRGV2ZWxvcG1lbnRcT3V0c2V0YVxPdXRzZXRhLldlYi5DbGllbnRcYXBpXHYxXGNybVxhY2NvdW50c1w=?=","name":"X-SourceFiles","description":""}],"cookie":[],"responseTime":"3569","body":"{\n \"metadata\": {\n \"limit\": 100,\n \"offset\": 0,\n \"total\": 2\n },\n \"items\": [\n {\n \"Name\": \"First example account\",\n \"ClientIdentifier\": null,\n \"BillingAddress\": {\n \"AddressLine1\": \"billing new line\",\n \"AddressLine2\": \"new line2\",\n \"AddressLine3\": null,\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"\",\n \"Uid\": \"aOW4pYWg\",\n \"Created\": \"2017-12-15T09:45:53\",\n \"Updated\": \"2017-12-15T09:45:53\"\n },\n \"MailingAddress\": {\n \"AddressLine1\": \"mailing new line\",\n \"AddressLine2\": \"new line2\",\n \"AddressLine3\": null,\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"\",\n \"Uid\": \"4XQY2q9P\",\n \"Created\": \"2017-12-15T09:45:53\",\n \"Updated\": \"2017-12-15T09:45:53\"\n },\n \"AccountStage\": 6,\n \"PaymentInformation\": null,\n \"PersonAccount\": [\n {\n \"Person\": null,\n \"Account\": null,\n \"IsPrimary\": true,\n \"Uid\": \"wDQ2w9V6\",\n \"Created\": \"2017-12-15T09:45:53\",\n \"Updated\": \"2017-12-15T09:45:53\"\n }\n ],\n \"Subscriptions\": [\n {\n \"BillingRenewalTerm\": 1,\n \"Account\": null,\n \"Plan\": null,\n \"Quantity\": null,\n \"StartDate\": \"2017-12-15T14:45:00\",\n \"EndDate\": \"2018-01-15T14:45:00\",\n \"RenewalDate\": null,\n \"NewRequiredQuantity\": null,\n \"IsPlanUpgradeRequired\": false,\n \"PlanUpgradeRequiredMessage\": null,\n \"SubscriptionAddOns\": null,\n \"Uid\": \"By9q589A\",\n \"Created\": \"2017-12-15T09:45:53\",\n \"Updated\": \"2018-01-22T11:48:50\"\n }\n ],\n \"Uid\": \"KaWx1mVr\",\n \"Created\": \"2017-12-15T09:45:53\",\n \"Updated\": \"2018-01-22T11:48:50\"\n },\n {\n \"Name\": \"Second account example\",\n \"ClientIdentifier\": null,\n \"BillingAddress\": {\n \"AddressLine1\": \"billing new line\",\n \"AddressLine2\": \"new line2\",\n \"AddressLine3\": null,\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"\",\n \"Uid\": \"3wQXLwQK\",\n \"Created\": \"2017-12-15T09:47:55\",\n \"Updated\": \"2017-12-15T09:47:55\"\n },\n \"MailingAddress\": {\n \"AddressLine1\": \"mailing new line\",\n \"AddressLine2\": \"new line2\",\n \"AddressLine3\": null,\n \"City\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"\",\n \"Uid\": \"pL9P5OWJ\",\n \"Created\": \"2017-12-15T09:47:55\",\n \"Updated\": \"2017-12-15T09:47:55\"\n },\n \"AccountStage\": 2,\n \"PaymentInformation\": null,\n \"PersonAccount\": [\n {\n \"Person\": null,\n \"Account\": null,\n \"IsPrimary\": true,\n \"Uid\": \"KL9ngWZG\",\n \"Created\": \"2017-12-15T09:47:55\",\n \"Updated\": \"2017-12-15T09:47:55\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"7c31f27f-bbeb-40e4-1cf7-39de1ea59a8c"},{"name":"Get all trialing accounts","id":"abfa7433-3255-f72f-9d00-04523729e3fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{url}}/crm/accounts?AccountStage=2","description":"Retrieves account information and filters for trialers. You can update the account stage to retrieve accounts in other stages (e.g. Demo, Subscribing, etc).
\n","urlObject":{"path":["crm","accounts"],"host":["{{url}}"],"query":[{"key":"AccountStage","value":"2"}],"variable":[]}},"response":[],"_postman_id":"abfa7433-3255-f72f-9d00-04523729e3fb"},{"name":"Add account with existing person","id":"cf32f02d-896c-1835-f4a1-a9c13b3fbd72","request":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"First API account\",\n \"AccountStage\": \"2\",\n \"MailingAddress\": \n {\n \"AddressLine1\": \"mailing new line\",\n \"AddressLine2\": \"new line2\",\n \"City\": \"new city\",\n \"State\": \"state\",\n \"PostalCode\": \"02440\"\n },\n \"BillingAddress\": \n {\n \"AddressLine1\": \"billing new line\",\n \"AddressLine2\": \"new line2\",\n \"City\": \"new city\",\n \"State\": \"state\",\n \"PostalCode\": \"02440\"\n },\n \"PersonAccount\": [\n {\n \"Person\": {\"Uid\": \"owmjxl9V\"},\n \"IsPrimary\": \"true\"\n }\n ]\n}"},"url":"{{url}}/crm/accounts","description":"Add a new account with an existing person.
\n","urlObject":{"path":["crm","accounts"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"cfd1bc57-897c-9490-031a-efdb325e0105","name":"Add account with existing person","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Name\": \"First API account\",\n \"AccountStage\": \"2\",\n \"MailingAddress\": \n {\n \"AddressLine1\": \"mailing new line\",\n \"AddressLine2\": \"new line2\",\n \"City\": \"new city\",\n \"State\": \"state\",\n \"PostalCode\": \"02440\"\n },\n \"BillingAddress\": \n {\n \"AddressLine1\": \"billing new line\",\n \"AddressLine2\": \"new line2\",\n \"City\": \"new city\",\n \"State\": \"state\",\n \"PostalCode\": \"02440\"\n },\n \"PersonAccount\": [\n {\n \"Person\": {\"Uid\": \"owmjxl9V\"},\n \"IsPrimary\": \"true\"\n }\n ]\n}"},"url":"{{url}}/crm/accounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"926","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 29 Jan 2018 16:42:25 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcRGV2ZWxvcG1lbnRcT3V0c2V0YVxPdXRzZXRhLldlYi5DbGllbnRcYXBpXHYxXGNybVxhY2NvdW50cw==?=","name":"X-SourceFiles","description":""}],"cookie":[],"responseTime":"747","body":"{\"Name\":\"First API account\",\"ClientIdentifier\":null,\"BillingAddress\":{\"AddressLine1\":\"billing new line\",\"AddressLine2\":\"new line2\",\"AddressLine3\":null,\"City\":\"new city\",\"State\":\"state\",\"PostalCode\":\"02440\",\"Uid\":\"4XQY2X9P\",\"Created\":\"2018-01-29T11:42:25.5834244-05:00\",\"Updated\":\"2018-01-29T11:42:25.5834244-05:00\"},\"MailingAddress\":{\"AddressLine1\":\"mailing new line\",\"AddressLine2\":\"new line2\",\"AddressLine3\":null,\"City\":\"new city\",\"State\":\"state\",\"PostalCode\":\"02440\",\"Uid\":\"3wQXLlQK\",\"Created\":\"2018-01-29T11:42:25.5834244-05:00\",\"Updated\":\"2018-01-29T11:42:25.5834244-05:00\"},\"AccountStage\":2,\"PaymentInformation\":null,\"PersonAccount\":[{\"Person\":null,\"Account\":null,\"IsPrimary\":true,\"Uid\":\"owmjl9V6\",\"Created\":\"2018-01-29T11:42:25.5834244-05:00\",\"Updated\":\"2018-01-29T11:42:25.5834244-05:00\"}],\"Subscriptions\":[],\"Uid\":\"jLmJ6mPo\",\"Created\":\"2018-01-29T11:42:25.5834244-05:00\",\"Updated\":\"2018-01-29T11:42:25.5834244-05:00\"}"}],"_postman_id":"cf32f02d-896c-1835-f4a1-a9c13b3fbd72"},{"name":"Add account with new person","id":"c6aff6a7-b01f-975e-efa8-73db343abcfa","request":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"First API account\",\n \"AccountStage\": \"2\",\n \"MailingAddress\": \n {\n \"AddressLine1\": \"mailing new line\",\n \"AddressLine2\": \"new line2\",\n \"City\": \"new city\",\n \"State\": \"state\",\n \"PostalCode\": \"02440\"\n },\n \"BillingAddress\": \n {\n \"AddressLine1\": \"billing new line\",\n \"AddressLine2\": \"new line2\",\n \"City\": \"new city\",\n \"State\": \"state\",\n \"PostalCode\": \"02440\"\n },\n \"PersonAccount\": [\n {\n \"Person\": {\"Email\": \"new@example.com\", \"FirstName\": \"New\", \"LastName\": \"Person\"},\n \"IsPrimary\": \"true\"\n }\n ]\n}"},"url":"{{url}}/crm/accounts?sendConfirmationEmail=true/false","description":"Add a new account with a new person.
\n","urlObject":{"path":["crm","accounts"],"host":["{{url}}"],"query":[{"description":{"content":"Boolean value for whether a confirmation email is sent to the newly added person on the account. Defaults to false when the parameter is not present.
\n","type":"text/plain"},"key":"sendConfirmationEmail","value":"true/false"}],"variable":[]}},"response":[{"id":"32f8d0bd-a5b3-9c62-2db0-120b7a2024be","name":"Add account with new person","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Name\": \"First API account\",\n \"AccountStage\": \"2\",\n \"MailingAddress\": \n {\n \"AddressLine1\": \"mailing new line\",\n \"AddressLine2\": \"new line2\",\n \"City\": \"new city\",\n \"State\": \"state\",\n \"PostalCode\": \"02440\"\n },\n \"BillingAddress\": \n {\n \"AddressLine1\": \"billing new line\",\n \"AddressLine2\": \"new line2\",\n \"City\": \"new city\",\n \"State\": \"state\",\n \"PostalCode\": \"02440\"\n },\n \"PersonAccount\": [\n {\n \"Person\": {\"Email\": \"new@example.com\", \"FirstName\": \"New\", \"LastName\": \"Person\"},\n \"IsPrimary\": \"true\"\n }\n ]\n}"},"url":"{{url}}/crm/accounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"926","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 29 Jan 2018 16:47:31 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcRGV2ZWxvcG1lbnRcT3V0c2V0YVxPdXRzZXRhLldlYi5DbGllbnRcYXBpXHYxXGNybVxhY2NvdW50cw==?=","name":"X-SourceFiles","description":""}],"cookie":[],"responseTime":"1207","body":"{\"Name\":\"First API account\",\"ClientIdentifier\":null,\"BillingAddress\":{\"AddressLine1\":\"billing new line\",\"AddressLine2\":\"new line2\",\"AddressLine3\":null,\"City\":\"new city\",\"State\":\"state\",\"PostalCode\":\"02440\",\"Uid\":\"pL9P5nWJ\",\"Created\":\"2018-01-29T11:47:31.4412132-05:00\",\"Updated\":\"2018-01-29T11:47:31.4412132-05:00\"},\"MailingAddress\":{\"AddressLine1\":\"mailing new line\",\"AddressLine2\":\"new line2\",\"AddressLine3\":null,\"City\":\"new city\",\"State\":\"state\",\"PostalCode\":\"02440\",\"Uid\":\"exmewP9V\",\"Created\":\"2018-01-29T11:47:31.4412132-05:00\",\"Updated\":\"2018-01-29T11:47:31.4412132-05:00\"},\"AccountStage\":2,\"PaymentInformation\":null,\"PersonAccount\":[{\"Person\":null,\"Account\":null,\"IsPrimary\":true,\"Uid\":\"gA93qm02\",\"Created\":\"2018-01-29T11:47:31.4412132-05:00\",\"Updated\":\"2018-01-29T11:47:31.4412132-05:00\"}],\"Subscriptions\":[],\"Uid\":\"wDQ2w9V6\",\"Created\":\"2018-01-29T11:47:31.4412132-05:00\",\"Updated\":\"2018-01-29T11:47:31.4412132-05:00\"}"}],"_postman_id":"c6aff6a7-b01f-975e-efa8-73db343abcfa"},{"name":"Add new person to existing account","id":"1f09cc80-9984-d51e-2f95-ce1a2c7d21a6","request":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Account\": {\"Uid\": \"wDQ2w9V6\"},\n \"Person\": {\"Email\": \"new@new.com\", \"FirstName\": \"New\", \"LastName\": \"Person\"},\n \"IsPrimary\": \"false\"\n}"},"url":"{{url}}/crm/accounts/wDQ2w9V6/memberships?sendWelcomeEmail=false","description":"Add a new person to an existing account.
\nSet sendWelcomeEmail=true if you'd like the system to send an welcome email to the person added on the account.
\n","urlObject":{"path":["crm","accounts","wDQ2w9V6","memberships"],"host":["{{url}}"],"query":[{"key":"sendWelcomeEmail","value":"false"}],"variable":[]}},"response":[{"id":"61fc6bb3-ffd7-c9a1-543c-21984925d009","name":"Add new person to existing account","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\t \"Account\": {\"Uid\": \"wDQ2w9V6\"},\n \"Person\": {\"Email\": \"new@new.com\", \"FirstName\": \"New\", \"LastName\": \"Person\"},\n \"IsPrimary\": \"false\"\n}"},"url":"{{url}}/crm/accounts/wDQ2w9V6/memberships"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"799","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 29 Jan 2018 17:03:13 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcRGV2ZWxvcG1lbnRcT3V0c2V0YVxPdXRzZXRhLldlYi5DbGllbnRcYXBpXHYxXGNybVxhY2NvdW50c1x3RFEydzlWNlxtZW1iZXJzaGlwcw==?=","name":"X-SourceFiles","description":""}],"cookie":[],"responseTime":"2909","body":"{\"Person\":{\"Email\":\"new@new.com\",\"FirstName\":\"New\",\"LastName\":\"Person\",\"MailingAddress\":null,\"PhoneMobile\":\"\",\"PhoneWork\":\"\",\"Timezone\":null,\"EmailBounceDateTime\":null,\"EmailSpamDateTime\":null,\"EmailUnsubscribeDateTime\":null,\"EmailLastDeliveredDateTime\":null,\"PersonAccount\":null,\"FullName\":\"New Person\",\"Uid\":\"ZBWzAP9E\",\"Created\":\"2018-01-29T12:03:12.2881933-05:00\",\"Updated\":\"2018-01-29T12:03:12.2881933-05:00\"},\"Account\":{\"Name\":null,\"ClientIdentifier\":null,\"BillingAddress\":null,\"MailingAddress\":null,\"AccountStage\":0,\"PaymentInformation\":null,\"PersonAccount\":null,\"Subscriptions\":null,\"Uid\":\"wDQ2w9V6\",\"Created\":\"0001-01-01T00:00:00\",\"Updated\":\"0001-01-01T00:00:00\"},\"IsPrimary\":false,\"Uid\":\"ZBWzyP9E\",\"Created\":\"2018-01-29T12:03:12.2881933-05:00\",\"Updated\":\"2018-01-29T12:03:12.2881933-05:00\"}"}],"_postman_id":"1f09cc80-9984-d51e-2f95-ce1a2c7d21a6"},{"name":"Add existing person to existing account","id":"93fb69e7-1fa2-9566-aeb4-6ef945334c10","request":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\t \"Account\": {\"Uid\": \"wDQ2w9V6\"},\n \"Person\": {\"Uid\": \"y7maBrQE\"},\n \"IsPrimary\": \"false\"\n}"},"url":"{{url}}/crm/accounts/wDQ2w9V6/memberships","description":"Add an existing person to an existing account.
\n","urlObject":{"path":["crm","accounts","wDQ2w9V6","memberships"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"913a3cf4-7ab5-4ad7-5539-72de5c1eb95b","name":"Add existing person to existing account","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}","disabled":false},{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\t \"Account\": {\"Uid\": \"wDQ2w9V6\"},\n \"Person\": {\"Uid\": \"y7maBrQE\"},\n \"IsPrimary\": \"false\"\n}"},"url":"{{url}}/crm/accounts/wDQ2w9V6/memberships"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"745","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 29 Jan 2018 16:54:37 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcRGV2ZWxvcG1lbnRcT3V0c2V0YVxPdXRzZXRhLldlYi5DbGllbnRcYXBpXHYxXGNybVxhY2NvdW50c1x3RFEydzlWNlxtZW1iZXJzaGlwcw==?=","name":"X-SourceFiles","description":""}],"cookie":[],"responseTime":"2047","body":"{\"Person\":{\"Email\":null,\"FirstName\":\"\",\"LastName\":\"\",\"MailingAddress\":null,\"PhoneMobile\":\"\",\"PhoneWork\":\"\",\"Timezone\":null,\"EmailBounceDateTime\":null,\"EmailSpamDateTime\":null,\"EmailUnsubscribeDateTime\":null,\"EmailLastDeliveredDateTime\":null,\"PersonAccount\":null,\"FullName\":null,\"Uid\":\"y7maBrQE\",\"Created\":\"0001-01-01T00:00:00\",\"Updated\":\"0001-01-01T00:00:00\"},\"Account\":{\"Name\":null,\"ClientIdentifier\":null,\"BillingAddress\":null,\"MailingAddress\":null,\"AccountStage\":0,\"PaymentInformation\":null,\"PersonAccount\":null,\"Subscriptions\":null,\"Uid\":\"wDQ2w9V6\",\"Created\":\"0001-01-01T00:00:00\",\"Updated\":\"0001-01-01T00:00:00\"},\"IsPrimary\":false,\"Uid\":\"GnmDYQyM\",\"Created\":\"2018-01-29T11:54:37.3258427-05:00\",\"Updated\":\"2018-01-29T11:54:37.3258427-05:00\"}"}],"_postman_id":"93fb69e7-1fa2-9566-aeb4-6ef945334c10"},{"name":"Add account with subscription","id":"9eee605b-e61c-5d4e-eaa0-ce4566a80379","request":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"Fourth API account\",\n \"MailingAddress\": {\n \"AddressLine1\": \"mailing new line\",\n \"AddressLine2\": \"new line2\",\n \"City\": \"new city\",\n \"State\": \"state\",\n \"PostalCode\": \"02440\"\n },\n \"BillingAddress\": {\n \"AddressLine1\": \"billing new line\",\n \"AddressLine2\": \"new line2\",\n \"City\": \"new city\",\n \"State\": \"state\",\n \"PostalCode\": \"02440\"\n },\n \"PersonAccount\": [\n {\n \"Person\": {\"Uid\": \"owmjxl9V\"},\n \"IsPrimary\": \"true\"\n }\n ],\n \"Subscriptions\":[ \n {\n \"Plan\": {\"Uid\": \"VdQG094Y\"},\n \"BillingRenewalTerm\": 1\n }\n ]\n}\n"},"url":"{{url}}/crm/accounts","description":"Add a new account with an existing person and a new subscription.
\n","urlObject":{"path":["crm","accounts"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9eee605b-e61c-5d4e-eaa0-ce4566a80379"},{"name":"Register Account","id":"6056bd40-c846-4ffe-b545-ae0923511676","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"Name\": \"ACME, LLC\",\n \"PersonAccount\": [\n {\n \"IsPrimary\": true,\n \"Person\": {\n \"Email\": \"jdoe@domain.com\"\n }\n }\n ],\n \"Subscriptions\": [\n {\n \"BillingRenewalTerm\": 2,\n \"Plan\": {\n \"Uid\": \"amRXjE9J\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/crm/registrations","description":"This is the same endpoint our sign up embed uses to create accounts. At a minimum you must pass one Primary Contact with an Email address and one Subscription record with a reference to a Plan. Other fields (e.g. Account Name, Billing Address, Payment Information, etc.) can be passed as desired. A confirmation email will be sent to the user unless you've specifically toggled this option off on the AUTH > SIGN UP AND LOGIN page.
\n","urlObject":{"path":["crm","registrations"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"48b09761-3279-4a05-ae98-644ebf6ddfc1","name":"Register Account","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"Name\": \"ACME, LLC\",\n \"PersonAccount\": [\n {\n \"IsPrimary\": true,\n \"Person\": {\n \"Email\": \"jdoe@domain.com\"\n }\n }\n ],\n \"Subscriptions\": [\n {\n \"BillingRenewalTerm\": 2,\n \"Plan\": {\n \"Uid\": \"amRXjE9J\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/crm/registrations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 11 Apr 2023 18:23:43 GMT"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Length","value":"1118"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"_objectType\": \"Account\",\n \"Name\": \"ACME, LLC\",\n \"ClientIdentifier\": null,\n \"InvoiceNotes\": null,\n \"IsDemo\": false,\n \"BillingAddress\": null,\n \"MailingAddress\": null,\n \"AccountStage\": 2,\n \"PaymentInformation\": null,\n \"PersonAccount\": [\n {\n \"_objectType\": \"PersonAccount\",\n \"Person\": null,\n \"Account\": null,\n \"IsPrimary\": true,\n \"ActivityEventData\": null,\n \"Uid\": \"7maPO31W\",\n \"Created\": \"2023-04-11T18:23:42.9482596Z\",\n \"Updated\": \"2023-04-11T18:23:42.9482596Z\"\n }\n ],\n \"Subscriptions\": [\n {\n \"_objectType\": \"Subscription\",\n \"BillingRenewalTerm\": 2,\n \"Account\": null,\n \"Plan\": null,\n \"Quantity\": null,\n \"StartDate\": \"2023-04-11T18:23:42.9069142Z\",\n \"EndDate\": null,\n \"ExpirationDate\": null,\n \"RenewalDate\": \"2024-04-11T18:23:42.9069142Z\",\n \"NewRequiredQuantity\": null,\n \"IsPlanUpgradeRequired\": false,\n \"PlanUpgradeRequiredMessage\": null,\n \"SubscriptionAddOns\": null,\n \"DiscountCouponSubscriptions\": null,\n \"DiscountCode\": null,\n \"LatestInvoice\": null,\n \"Rate\": 0,\n \"ActivityEventData\": null,\n \"Uid\": \"zWZLYrdQ\",\n \"Created\": \"2023-04-11T18:23:42.9482596Z\",\n \"Updated\": \"2023-04-11T18:23:42.9482596Z\"\n }\n ],\n \"Deals\": [],\n \"LastLoginDateTime\": null,\n \"AccountSpecificPageUrl1\": null,\n \"AccountSpecificPageUrl2\": null,\n \"AccountSpecificPageUrl3\": null,\n \"AccountSpecificPageUrl4\": null,\n \"AccountSpecificPageUrl5\": null,\n \"AccountSpecificPageUrl6\": null,\n \"AccountSpecificPageUrl7\": null,\n \"AccountSpecificPageUrl8\": null,\n \"AccountSpecificPageUrl9\": null,\n \"AccountSpecificPageUrl10\": null,\n \"RewardFulReferralId\": null,\n \"HasLoggedIn\": false,\n \"AccountStageLabel\": \"Trialing\",\n \"DomainName\": null,\n \"LatestSubscription\": {\n \"_objectType\": \"Subscription\",\n \"BillingRenewalTerm\": 2,\n \"Account\": null,\n \"Plan\": null,\n \"Quantity\": null,\n \"StartDate\": \"2023-04-11T18:23:42.9069142Z\",\n \"EndDate\": null,\n \"ExpirationDate\": null,\n \"RenewalDate\": \"2024-04-11T18:23:42.9069142Z\",\n \"NewRequiredQuantity\": null,\n \"IsPlanUpgradeRequired\": false,\n \"PlanUpgradeRequiredMessage\": null,\n \"SubscriptionAddOns\": null,\n \"DiscountCouponSubscriptions\": null,\n \"DiscountCode\": null,\n \"LatestInvoice\": null,\n \"Rate\": 0,\n \"ActivityEventData\": null,\n \"Uid\": \"zWZLYrdQ\",\n \"Created\": \"2023-04-11T18:23:42.9482596Z\",\n \"Updated\": \"2023-04-11T18:23:42.9482596Z\"\n },\n \"CurrentSubscription\": {\n \"_objectType\": \"Subscription\",\n \"BillingRenewalTerm\": 2,\n \"Account\": null,\n \"Plan\": null,\n \"Quantity\": null,\n \"StartDate\": \"2023-04-11T18:23:42.9069142Z\",\n \"EndDate\": null,\n \"ExpirationDate\": null,\n \"RenewalDate\": \"2024-04-11T18:23:42.9069142Z\",\n \"NewRequiredQuantity\": null,\n \"IsPlanUpgradeRequired\": false,\n \"PlanUpgradeRequiredMessage\": null,\n \"SubscriptionAddOns\": null,\n \"DiscountCouponSubscriptions\": null,\n \"DiscountCode\": null,\n \"LatestInvoice\": null,\n \"Rate\": 0,\n \"ActivityEventData\": null,\n \"Uid\": \"zWZLYrdQ\",\n \"Created\": \"2023-04-11T18:23:42.9482596Z\",\n \"Updated\": \"2023-04-11T18:23:42.9482596Z\"\n },\n \"PrimaryContact\": {\n \"_objectType\": \"Person\",\n \"Email\": \"jdoe@domain.com\",\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"MailingAddress\": null,\n \"PasswordLastUpdated\": null,\n \"PasswordMustChange\": false,\n \"PhoneMobile\": \"\",\n \"PhoneWork\": \"\",\n \"ProfileImageS3Url\": null,\n \"Title\": null,\n \"Timezone\": null,\n \"Language\": null,\n \"IPAddress\": \"54.86.50.139\",\n \"Referer\": null,\n \"UserAgent\": \"PostmanRuntime/7.31.3\",\n \"LastLoginDateTime\": null,\n \"OAuthGoogleProfileId\": null,\n \"PersonAccount\": null,\n \"DealPeople\": null,\n \"LeadFormSubmissions\": null,\n \"EmailListPerson\": null,\n \"Account\": null,\n \"AccountUids\": null,\n \"FullName\": \"jdoe@domain.com\",\n \"HasLoggedIn\": false,\n \"OAuthIntegrationStatus\": 0,\n \"UserAgentPlatformBrowser\": \"Unknown (Unknown)\",\n \"HasUnsubscribed\": false,\n \"DiscordUser\": null,\n \"IsConnectedToDiscord\": false,\n \"ActivityEventData\": null,\n \"Uid\": \"zWZbMyqW\",\n \"Created\": \"2023-04-11T18:23:43\",\n \"Updated\": \"2023-04-11T18:23:43.559072Z\"\n },\n \"PrimarySubscription\": null,\n \"RecaptchaToken\": null,\n \"LifetimeRevenue\": 0,\n \"ActivityEventData\": null,\n \"Uid\": \"y9qxpV3Q\",\n \"Created\": \"2023-04-11T18:23:42.9482596Z\",\n \"Updated\": \"2023-04-11T18:23:42.9482596Z\"\n}"}],"_postman_id":"6056bd40-c846-4ffe-b545-ae0923511676"},{"name":"Update account","id":"32e49541-1725-ac20-5c6c-c8c55b821692","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Name\": \"First API account\",\n \"AccountStage\": \"3\",\n \"MailingAddress\": {\n \"Uid\": \"GEWBer9r\",\n \"AddressLine1\": \"mailing new line\",\n \"AddressLine2\": \"new line2\"\n },\n \"BillingAddress\": {\n \"Uid\": \"KjW7e4Qq\",\n \"AddressLine1\": \"billing new line\",\n \"AddressLine2\": \"new line2\"\n }\n}"},"url":"{{url}}/crm/accounts/[accountUid]","description":"Update account information. You can update one or multiple properties on the object. Any property that you include in the json schema will be updated. To update custom properties just include them in the same way that they are included when you do a get on the object.
\n","urlObject":{"path":["crm","accounts","[accountUid]"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"32e49541-1725-ac20-5c6c-c8c55b821692"},{"name":"Cancel account","id":"5da3dde8-6d29-ec28-5cce-eb32f3da640a","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"CancelationReason\": \"Too expensive\",\n \"Comment\": \"I don't want to use the software for now.\",\n \"Account\": { \"Uid\": \"wDQ2w9V6\" }\n}"},"url":"{{url}}/crm/accounts/cancellation/[accountUid]","description":"Add a cancellantion request to an account. The account needs to be in subscribing stage. The stage will authomatically change over to cancelling. If the account has a subscription attached to it then at the subscription renewal the subscription will end and the account will be automatically set to expired.
\n","urlObject":{"path":["crm","accounts","cancellation","[accountUid]"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5da3dde8-6d29-ec28-5cce-eb32f3da640a"},{"name":"Remove cancelation ","id":"74ccfd8c-4209-3035-ed18-5194658b92a1","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/crm/accounts/removecancellation/[accountUid]","description":"Remove a previous cancelation request.
\n","urlObject":{"path":["crm","accounts","removecancellation","[accountUid]"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"74ccfd8c-4209-3035-ed18-5194658b92a1"},{"name":"Update person account membership","id":"a447c5da-9d59-433d-ab95-3f5189e9d371","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Account\": {\"Uid\": \"abcd1234\"},\n \"Person\": {\"Uid\": \"abcd1234\"},\n \"IsPrimary\": \"true\"\n}"},"url":"{{url}}/crm/accounts/[accountUid]/memberships/[membershipUid]","description":"Update an account membership. This is the method by which you can change the primary contact of an account.
\n","urlObject":{"path":["crm","accounts","[accountUid]","memberships","[membershipUid]"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a447c5da-9d59-433d-ab95-3f5189e9d371"},{"name":"Delete account","id":"76bb3d52-f2d2-f8c3-72db-471d1d0d6859","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/crm/accounts/[accountUid]","description":"Delete an account record.
\n","urlObject":{"path":["crm","accounts","[accountUid]"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"76bb3d52-f2d2-f8c3-72db-471d1d0d6859"},{"name":"Remove person from account","id":"d0b38826-d2e4-4ee0-9233-81065adde4ff","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/crm/accounts/[accountUid]/memberships/[membershipUid]","description":"Remove a person from an account. Note that you cannot remove the primary contact of an account.
\n","urlObject":{"path":["crm","accounts","[accountUid]","memberships","[membershipUid]"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d0b38826-d2e4-4ee0-9233-81065adde4ff"}],"id":"8f92f7ed-ea9a-4496-a579-d9091c481b4e","_postman_id":"8f92f7ed-ea9a-4496-a579-d9091c481b4e","description":""},{"name":"Activities","item":[{"name":"Get all activities","id":"8ccf44fe-51bc-e994-fd95-f521e1983556","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{url}}/activities?ActivityType=100&EntityType=1&offset=0&orderBy=ActivityDateTime+DESC","description":"Retrieves all the activites. One or multiple paraneters can be defined to filter the results.
\nActivity Types\n
\n Custom = 10,\n Note = 50,\n Email = 51,\n PhoneCall = 52,\n Meeting = 53,\n AccountCreated = 100,\n AccountUpdated = 101,\n AccountAddPerson = 102,\n AccountStageUpdated = 103,\n AccountDeleted=104,\n AccountBillingInformationUpdated=105,\n PersonCreated = 200,\n PersonUpdated = 201,\n PersonDeleted = 202,\n PersonLogin = 203,\n PersonListSubscribed = 204,\n PersonListUnsubscribed = 205,\n PersonSegmentAdded = 206,\n PersonSegmentRemoved = 207,\n PersonEmailOpened = 208,\n PersonEmailClicked = 209,\n PersonEmailBounce = 210,\n PersonEmailSpam = 211,\n PersonSupportTicketCreated = 212,\n PersonSupportTicketUpdated = 213,\n DealCreated = 300,\n DealUpdated = 301,\n DealAddPerson = 302,\n DealAddAccount = 303
\nEntity Types\n
\n Account = 1,\n Person = 2,\n Deal = 3
The page number of the results to return
\n","type":"text/plain"},"key":"offset","value":"0"},{"key":"orderBy","value":"ActivityDateTime+DESC"}],"variable":[]}},"response":[{"id":"6c40c081-3c75-28cf-ea06-d6814448a8a0","name":"Get all activities","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/activities?ActivityType=100&EntityType=1&offset=0&orderBy=ActivityDateTime+DESC","host":["{{url}}"],"path":["activities"],"query":[{"key":"ActivityType","value":"100"},{"key":"EntityType","value":"1"},{"key":"offset","value":"0","description":"The page number of the results to return"},{"key":"orderBy","value":"ActivityDateTime+DESC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"10412","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 21 Sep 2018 15:21:18 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"169","body":"{\n \"metadata\": {\n \"limit\": 100,\n \"offset\": 0,\n \"total\": 1\n },\n \"items\": [\n {\n \"Title\": \"Account created\",\n \"Description\": \"New Deal Match created\",\n \"ActivityData\": null,\n \"ActivityDateTime\": \"2018-04-25T14:26:56\",\n \"ActivityType\": 100,\n \"EntityType\": 1,\n \"EntityUid\": \"aOW4JYQg\",\n \"Uid\": \"4XQYAgQP\",\n \"Created\": \"2018-04-25T10:26:56\",\n \"Updated\": \"2018-04-25T10:26:56\"\n }\n \n ]\n}"}],"_postman_id":"8ccf44fe-51bc-e994-fd95-f521e1983556"},{"name":"Add custom activity","id":"1b90499b-691b-82b8-ff63-f937f9dd7819","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Title\": \"New custom activity for an account\",\n \"Description\": \"Custom activity description\",\n \"ActivityData\": \"A string, can be used to store store serialized JSON\",\n \"EntityType\": 1,\n \"EntityUid\": \"4XQYqQPB\"\n}"},"url":"{{url}}/activities/customactivity","description":"This method allows you to record custom events associated to an account, people or deal. These activities would then show up on the activity feed of the corresponding entity and can be leveraged to trigger drip campaigns and other automation.
\nFor integration with drip campaigns make sure that what you pass in the Title property matches the start / stop value specified for the campaign.
\n","urlObject":{"path":["activities","customactivity"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"09e5fc06-78be-dd09-3e9b-928e11a06706","name":"Add custom activity","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":" {\n \"Title\": \"New custom activity for an account\",\n \"Description\": \"Custom activity description\",\n \"ActivityData\": \"A string, can be used to store store serialized JSON\",\n \"EntityType\": 1,\n \"EntityUid\": \"4XQYqQPB\"\n}"},"url":"{{url}}/activities/customactivity"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","description":""},{"key":"Content-Length","value":"314","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","description":""},{"key":"Date","value":"Wed, 12 Dec 2018 20:02:35 GMT","description":""},{"key":"Expires","value":"-1","description":""},{"key":"Pragma","value":"no-cache","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","description":""},{"key":"X-Powered-By","value":"ASP.NET","description":""},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcRGV2ZWxvcG1lbnRcT3V0c2V0YVxPdXRzZXRhLldlYi5DbGllbnRcYXBpXHYxXGFjdGl2aXRpZXNcY3VzdG9tYWN0aXZpdHk=?=","description":""}],"cookie":[],"responseTime":"2522","body":"{\n \"Title\": \"New custom activity for an account\",\n \"Description\": \"Custom activity description\",\n \"ActivityData\": \"A string, can be used to store store serialized JSON\",\n \"EntityType\": 1,\n \"EntityUid\": \"4XQYqQPB\"\n}"}],"_postman_id":"1b90499b-691b-82b8-ff63-f937f9dd7819"}],"id":"124f8b75-dc80-4de4-a38c-0e0cac5604f4","_postman_id":"124f8b75-dc80-4de4-a38c-0e0cac5604f4","description":""},{"name":"Deals","item":[{"name":"Get all deals","id":"1a11d7f7-c4fd-cb3c-4d58-28ad0de39ee1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{url}}/crm/deals","description":"Retrieves all the deals associated with your account.
\n","urlObject":{"path":["crm","deals"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1a11d7f7-c4fd-cb3c-4d58-28ad0de39ee1"},{"name":"Get deal","id":"82f1248b-40ee-2cae-6f2b-26765f16d58c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{url}}/crm/deals/[dealUid]","description":"Retrieves one deal associated with your account.
\n","urlObject":{"path":["crm","deals","[dealUid]"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"82f1248b-40ee-2cae-6f2b-26765f16d58c"},{"name":"Add deal ","id":"115dec74-85a4-f825-ff76-f12adddb652c","request":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"New\",\n \"DealPipelineStage\": {\"Uid\": \"4XQYqQPB\"},\n \"Amount\": 12,\n \"AssignedToPersonClientIdentifier\": \"xxxxxxx\",\n \"Account\": {\"Uid\": \"4XQYqQPB\"},\n \"DealPeople\": [\n {\n \"Person\": {\"Uid\": \"8vWy1Wbw\"}\n }\n ]\n}"},"url":"{{url}}/crm/deals","urlObject":{"path":["crm","deals"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"115dec74-85a4-f825-ff76-f12adddb652c"},{"name":"Delete deal ","id":"4f52d891-0d78-f8dc-0ce4-2b0bdc430b79","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/crm/deals/[dealUid]","urlObject":{"path":["crm","deals","[dealUid]"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4f52d891-0d78-f8dc-0ce4-2b0bdc430b79"},{"name":"Update deal ","id":"c050a5b1-cd2f-2252-cff9-bcba23dc91c1","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"Test\",\n \"DealPipelineStage\": {\"Uid\": \"wZmNZm2O\"},\n \"Amount\": 12,\n \"AssignedToPersonClientIdentifier\": \"xxxxxxx\",\n \"Account\": {\"Uid\": \"4XQYqQPB\"},\n \"Uid\": \"[dealUid]\",\n \"DealPeople\": [\n {\n \"Person\": {\"Uid\": \"4XQYqQPB\"}\n }\n ]\n}"},"url":"{{url}}/crm/deals/[dealUid]","urlObject":{"path":["crm","deals","[dealUid]"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c050a5b1-cd2f-2252-cff9-bcba23dc91c1"}],"id":"8e0f703f-e8e9-4c4f-8cc9-4d1495b2db53","_postman_id":"8e0f703f-e8e9-4c4f-8cc9-4d1495b2db53","description":""}],"id":"206034c2-cc74-1b8f-2101-746d745c084d","_postman_id":"206034c2-cc74-1b8f-2101-746d745c084d","description":""},{"name":"Marketing","item":[{"name":"Get all subscribers to list","id":"c3c5765e-5a7a-518f-c774-e11608677ffb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorizationtoken}}"}],"url":"{{url}}/email/lists/exmepWVG/subscriptions","description":"Retrieves all the people subscribing to an email list.
\n","urlObject":{"path":["email","lists","exmepWVG","subscriptions"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"08124eb6-d5ce-2902-4292-f38858038b82","name":"Get all subscribers to list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorizationtoken}}","disabled":false}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/email/lists/[listId]/subscriptions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"2278","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 29 Jan 2018 19:14:55 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcRGV2ZWxvcG1lbnRcT3V0c2V0YVxPdXRzZXRhLldlYi5DbGllbnRcYXBpXHYxXGVtYWlsXGxpc3RzXGV4bWVwV1ZHXHN1YnNjcmlwdGlvbnM=?=","name":"X-SourceFiles","description":""}],"cookie":[],"responseTime":"797","body":"{\n \"metadata\": {\n \"limit\": 100,\n \"offset\": 0,\n \"total\": 2\n },\n \"items\": [\n {\n \"EmailList\": {\n \"Name\": \"My new list\",\n \"WelcomeSubject\": null,\n \"WelcomeBody\": \"Welcome\",\n \"WelcomeFromName\": null,\n \"WelcomeFromEmail\": null,\n \"EmailListPerson\": null,\n \"CountSubscriptionsActive\": 0,\n \"CountSubscriptionsBounce\": 0,\n \"CountSubscriptionsSpam\": 0,\n \"CountSubscriptionsUnsubscribed\": 0,\n \"Uid\": \"exmepWVG\",\n \"Created\": \"2017-09-11T12:28:56\",\n \"Updated\": \"2017-09-11T12:28:56\"\n },\n \"Person\": {\n \"Email\": \"new@subscriber.com\",\n \"FirstName\": \"New\",\n \"LastName\": \"Subscriber\",\n \"MailingAddress\": null,\n \"PhoneMobile\": \"\",\n \"PhoneWork\": \"\",\n \"Timezone\": null,\n \"EmailBounceDateTime\": null,\n \"EmailSpamDateTime\": null,\n \"EmailUnsubscribeDateTime\": null,\n \"EmailLastDeliveredDateTime\": null,\n \"PersonAccount\": null,\n \"FullName\": \"New Subscriber\",\n \"Uid\": \"wZmNDZ92\",\n \"Created\": \"2018-01-29T14:06:33\",\n \"Updated\": \"2018-01-29T14:06:33\"\n },\n \"EmailListSubscriberStatus\": 1,\n \"SubscribedDate\": \"2018-01-29T14:06:34\",\n \"ConfirmedDate\": null,\n \"UnsubscribedDate\": null,\n \"CleanedDate\": null,\n \"WelcomeEmailDeliverDateTime\": null,\n \"WelcomeEmailOpenDateTime\": null,\n \"UnsubscribeReason\": null,\n \"UnsubscribeReasonOther\": null,\n \"SendWelcomeEmail\": false,\n \"Uid\": \"KL9ngWZG\",\n \"Created\": \"2018-01-29T14:06:34\",\n \"Updated\": \"2018-01-29T14:06:34\"\n },\n {\n \"EmailList\": {\n \"Name\": \"My new list\",\n \"WelcomeSubject\": null,\n \"WelcomeBody\": \"Welcome\",\n \"WelcomeFromName\": null,\n \"WelcomeFromEmail\": null,\n \"EmailListPerson\": null,\n \"CountSubscriptionsActive\": 0,\n \"CountSubscriptionsBounce\": 0,\n \"CountSubscriptionsSpam\": 0,\n \"CountSubscriptionsUnsubscribed\": 0,\n \"Uid\": \"exmepWVG\",\n \"Created\": \"2017-09-11T12:28:56\",\n \"Updated\": \"2017-09-11T12:28:56\"\n },\n \"Person\": {\n \"Email\": \"new@example.com\",\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"MailingAddress\": null,\n \"PhoneMobile\": \"\",\n \"PhoneWork\": \"\",\n \"Timezone\": null,\n \"EmailBounceDateTime\": null,\n \"EmailSpamDateTime\": null,\n \"EmailUnsubscribeDateTime\": null,\n \"EmailLastDeliveredDateTime\": null,\n \"PersonAccount\": null,\n \"FullName\": \"admin@outsetaa.com\",\n \"Uid\": \"y7maBrQE\",\n \"Created\": \"2017-01-23T07:27:35\",\n \"Updated\": \"2017-03-31T15:53:15\"\n },\n \"EmailListSubscriberStatus\": 1,\n \"SubscribedDate\": \"2018-01-29T14:09:21\",\n \"ConfirmedDate\": null,\n \"UnsubscribedDate\": null,\n \"CleanedDate\": null,\n \"WelcomeEmailDeliverDateTime\": null,\n \"WelcomeEmailOpenDateTime\": null,\n \"UnsubscribeReason\": null,\n \"UnsubscribeReasonOther\": null,\n \"SendWelcomeEmail\": false,\n \"Uid\": \"dpWr3mnq\",\n \"Created\": \"2018-01-29T14:09:21\",\n \"Updated\": \"2018-01-29T14:09:21\"\n }\n ]\n}"}],"_postman_id":"c3c5765e-5a7a-518f-c774-e11608677ffb"},{"name":"Subscribe new person to list","id":"561b91b1-5821-5e5a-e61d-c37d10c38491","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{authorizationtoken}}"}],"body":{"mode":"raw","raw":"{\n\t\"EmailList\": {\"Uid\": \"exmepWVG\"},\n\t\"Person\": {\"Email\": \"new@subscriber.com\", \"FirstName\": \"New\", \"LastName\": \"Subscriber\" },\n \"SendWelcomeEmail\": \"true/false\"\n}"},"url":"{{url}}/email/lists/[listId]/subscriptions","description":"This method adds a new person as a subscriber to an existing email list. The SendWelcomeEmail property determines if the person added to the email list is sent a welcome email. The property defaults to false.
\n","urlObject":{"path":["email","lists","[listId]","subscriptions"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"561b91b1-5821-5e5a-e61d-c37d10c38491"},{"name":"Subscribe existing person to list","id":"00d17c23-016f-94a3-f506-adfcb2b232e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{authorizationtoken}}"}],"body":{"mode":"raw","raw":"{\n\t\"EmailList\": {\"Uid\": \"exmepWVG\"},\n\t\"Person\": {\"Uid\": \"y7maBrQE\" },\n \"SendWelcomeEmail\": \"true/false\"\n}"},"url":"{{url}}/email/lists/[listId]/subscriptions","description":"This method adds an existing person as a subscriber to an existing email list. The SendWelcomeEmail property determines if the person added to the email list is sent a welcome email. The property defaults to false.
\n","urlObject":{"path":["email","lists","[listId]","subscriptions"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"00d17c23-016f-94a3-f506-adfcb2b232e4"},{"name":"Remove subscriber from list","id":"d106a2b0-a046-5a60-f89f-87f1dd4cc351","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{authorizationtoken}}"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/email/lists/[listId]/subscriptions/KL9ngWZG","description":"This method removes a subscriber from an email list.
\n","urlObject":{"path":["email","lists","[listId]","subscriptions","KL9ngWZG"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"5a8fff09-81c3-6d5a-be12-7d5f0e32027f","name":"Remove subscriber from list","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{authorizationtoken}}"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/email/lists/[list_UID]/subscriptions/[subscription_UID]"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"0","name":"Content-Length","description":""},{"key":"Date","value":"Mon, 29 Jan 2018 19:17:35 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcRGV2ZWxvcG1lbnRcT3V0c2V0YVxPdXRzZXRhLldlYi5DbGllbnRcYXBpXHYxXGVtYWlsXGxpc3RzXGV4bWVwV1ZHXHN1YnNjcmlwdGlvbnNcS0w5bmdXWkc=?=","name":"X-SourceFiles","description":""}],"cookie":[],"responseTime":"636","body":""}],"_postman_id":"d106a2b0-a046-5a60-f89f-87f1dd4cc351"}],"id":"628ddd8e-1090-3c4c-a8a1-525c03ba0fa7","_postman_id":"628ddd8e-1090-3c4c-a8a1-525c03ba0fa7","description":""},{"name":"Support","item":[{"name":"Get all cases","id":"b801e1ac-2eed-1f33-8298-c0ddc57b1d17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{url}}/support/cases","description":"Case status
\n| Name | Value |
|---|---|
| Open | 1 |
| Closed | 2 |
Case source
\n| Name | Value |
|---|---|
| Website | 1 |
| 2 | |
| 3 | |
| 4 |
Retrieves all the cases from a person.
\n","urlObject":{"path":["support","cases"],"host":["{{url}}"],"query":[{"key":"FromPerson.Uid","value":"[personId]"}],"variable":[]}},"response":[],"_postman_id":"06fab782-2b2c-5ab0-45e1-86e1d2e08d1e"},{"name":"Get all cases by person email","id":"c4640efa-09c3-6206-b1fb-a4d1b479c294","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{url}}/support/cases?FromPerson.Email=new@example.com","description":"Retrieves all the cases from a person.
\n","urlObject":{"path":["support","cases"],"host":["{{url}}"],"query":[{"key":"FromPerson.Email","value":"new@example.com"}],"variable":[]}},"response":[],"_postman_id":"c4640efa-09c3-6206-b1fb-a4d1b479c294"},{"name":"Add case","id":"4736e277-bf04-6971-f80e-11d089e43fea","request":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"FromPerson\": {\"Uid\": \"bB9l5DW8\"},\n \"Subject\": \"This is the third case example\",\n \"Body\": \"This is the body\",\n \"Source\": 2\n \n}"},"url":"{{url}}/support/cases?sendAutoResponder=true","description":"Adds a case into the support system.
\nSet sendAutoResponder=false if you'd like the system not to send an automatic message that the ticket has been created.
\n","urlObject":{"path":["support","cases"],"host":["{{url}}"],"query":[{"key":"sendAutoResponder","value":"true"}],"variable":[]}},"response":[],"_postman_id":"4736e277-bf04-6971-f80e-11d089e43fea"},{"name":"Add client response","id":"5d659da8-5728-f9c4-aded-874dc6cc4545","request":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/support/cases/[caseUid]/clientresponse/[comment]","description":"Adds a response to the case from the person that opened the case.
\n","urlObject":{"path":["support","cases","[caseUid]","clientresponse","[comment]"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"6cd58bc7-ec69-9e34-9ebe-bd35f5d09ec7","name":"Add client response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/support/cases/wZmNZm2O/clientresponse/Thank you so much"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"0","name":"Content-Length","description":""},{"key":"Date","value":"Wed, 19 Jun 2019 13:45:50 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"2240","body":""}],"_postman_id":"5d659da8-5728-f9c4-aded-874dc6cc4545"},{"name":"Add reply","id":"9be8e48f-5ff7-5ca2-4ba1-474c916f8025","request":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"AgentName\": \"Agent A\",\n \"Case\": {\"Uid\": \"[caseUid]\"},\n \"Comment\": \"This is a reply\"\n}"},"url":"{{url}}/support/cases/[caseUid]/replies","description":"Adds a reply from an agent to a support case.
\n","urlObject":{"path":["support","cases","[caseUid]","replies"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9be8e48f-5ff7-5ca2-4ba1-474c916f8025"},{"name":"Get all knowledge base categories","id":"d3452be2-5266-4826-9d98-4ca11f203e83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/support/categories","urlObject":{"path":["support","categories"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d3452be2-5266-4826-9d98-4ca11f203e83"},{"name":"Get all knowledge base articles","id":"e63be439-aae3-4c89-bc82-066604f58b26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/support/articles","urlObject":{"path":["support","articles"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e63be439-aae3-4c89-bc82-066604f58b26"},{"name":"Get knowledge base article","id":"9fceeb83-c4cc-4c03-aceb-427f37e8128d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/support/articles/[articleUid]","urlObject":{"path":["support","articles","[articleUid]"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9fceeb83-c4cc-4c03-aceb-427f37e8128d"}],"id":"4d5107a8-844d-79bc-0e73-7545e72820bb","_postman_id":"4d5107a8-844d-79bc-0e73-7545e72820bb","description":""},{"name":"Billing","item":[{"name":"Plan Families","item":[{"name":"Get all plan families","id":"6770f7c4-bd9f-999d-47e3-86079b463ff7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{url}}/billing/planfamilies","urlObject":{"path":["billing","planfamilies"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6770f7c4-bd9f-999d-47e3-86079b463ff7"}],"id":"2b4c0209-7e52-4ade-a10c-b99ef5d11c70","_postman_id":"2b4c0209-7e52-4ade-a10c-b99ef5d11c70","description":""},{"name":"Plans","item":[{"name":"Get all plans","id":"7d97fa34-6b09-62fe-476d-5b2d521a5bc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{url}}/billing/plans","urlObject":{"path":["billing","plans"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7d97fa34-6b09-62fe-476d-5b2d521a5bc3"}],"id":"2e53d6b9-724b-4610-8ff5-2c188eff5cda","_postman_id":"2e53d6b9-724b-4610-8ff5-2c188eff5cda","description":""},{"name":"Add-ons","item":[{"name":"Add usage for add on","id":"5c0441d6-0b85-bfe0-e5da-bcc4e6544112","request":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"UsageDate\": \"2017-12-01T10:00:00\",\n\t\"Amount\": 10,\n\t\"SubscriptionAddOn\": {\t\"Uid\": \"KjW7e4Qq\" }\n \n}"},"url":"{{url}}/billing/usage","description":"This method adds a usage entry for an add on that bills for usage at the end of the month.
\n","urlObject":{"path":["billing","usage"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5c0441d6-0b85-bfe0-e5da-bcc4e6544112"}],"id":"9bb5768c-3725-4fdc-a0d1-62ee69be53bc","_postman_id":"9bb5768c-3725-4fdc-a0d1-62ee69be53bc","description":""},{"name":"Discounts","item":[{"name":"Add discount","id":"5ea080bb-8891-4b36-a6d2-a2c6088b0d35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UniqueIdentifier\": \"100OFF\",\n \"Name\": \"100% off\",\n \"IsActive\": true,\n \"AmountOff\": 15,\n \"PercentOff\": 100,\n \"Duration\": 1,\n \"DurationInMonths\": 5,\n \"MaxRedemptions\": 15,\n \"RedeemBy\": \"2034-12-31T00:00:00Z\",\n \"DiscountCouponPlans\": [\n { \"Uid\": \"abcd1234\" }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/billing/discountcoupons","description":"Payload notes:
\nAmountOff or PercentOff should be set.DiscountCouponPlansDurationInMonthsRedeemByThis method is used to see what the initial or renewal invoice would look like if an account were to register with this subscription. The method returns an invoice object with information about the amount outstanding that can be used to show the user a confirmation page.
\nQuerystring parameters
\n| Name | Value |
|---|---|
| asOf | now (default), renewal |
BillingRenewalTerm
\n| Name | Value |
|---|---|
| Monthly | 1 |
| Yearly | 2 |
| Quarterly | 3 |
| OneTime | 4 |
This method is used when adding a subscription to an account for the first time. The method returns an invoice object with information about the amount outstanding.
\n","urlObject":{"path":["billing","subscriptions","firsttimesubscription"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e1046b5d-bdf1-68dc-2b9f-d6dd712cd11f"},{"name":"Add first time subscription with add ons","id":"cdb8d4da-addc-7cfd-71fb-d114ff5df869","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Plan\": {\"Uid\": \"VdQG094Y\"},\n\t\"BillingRenewalTerm\": 1,\n\t\"Account\": {\t\"Uid\": \"KL9ngWZG\" },\n\t\"SubscriptionAddOns\": [{\n\t\t\t\"AddOn\": {\t\"Uid\": \"By9q8QAP\" }\n\t}]\n}"},"url":"{{url}}/billing/subscriptions/firsttimesubscription","description":"This method is used when adding a subscription to an account for the first time. The method returns an invoice object with information about the amount outstanding.
\n","urlObject":{"path":["billing","subscriptions","firsttimesubscription"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cdb8d4da-addc-7cfd-71fb-d114ff5df869"},{"name":"Change subscription (preview)","id":"dd1cd729-4b66-e7fc-9565-5c9d4c2ee31b","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Plan\": {\"Uid\": \"VdQG094Y\"},\n\t\"BillingRenewalTerm\": 2,\n\t\"Account\": {\t\"Uid\": \"wDQ2w9V6\" }\n}"},"url":"{{url}}/billing/subscriptions/[subscriptionUid]/changesubscriptionpreview","description":"This method is used when changing a subscription on an account. The method returns an invoice object with information about the amount outstanding that can be used to show the user a confirmation page.
\nThis method does not committ the subscription to the database. Rather it can be used as a preview.
\nRenewal term
\n| Name | Value |
|---|---|
| Monthly | 1 |
| Annual | 2 |
This method is used when changing a subscription on an account. The method returns an invoice object with information about the amount outstanding.
\n","urlObject":{"path":["billing","subscriptions","[subscriptionUid]","changesubscription"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ececc770-75ef-cc9c-cd18-cc2bcf0842a6"},{"name":"Set subscription upgrade required","id":"f5623de8-0218-2384-1132-72cf203c2623","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Uid\": \"z49E5z97\",\n\t\"NewRequiredQuantity\": null,\n \"IsPlanUpgradeRequired\": true,\n \"PlanUpgradeRequiredMessage\": \"This is the message that will display to user\"\n \n}"},"url":"{{url}}/billing/subscriptions/[subscriptionUid]/setsubscriptionupgraderequired","description":"Use this method to indicase that an updgrade of plan is required. When a subscription is flagged next time the user authenticates the authentication widget will prompt the user to change plan.
\n","urlObject":{"path":["billing","subscriptions","[subscriptionUid]","setsubscriptionupgraderequired"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f5623de8-0218-2384-1132-72cf203c2623"},{"name":"Extend trial subscription","id":"cdb0fce8-0145-9ae6-8619-721da60f43ca","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/crm/accounts/extendtrial/[accountUid]/[date_in_yyyy-MM-DD]","description":"Use this method to extend the date that a trial subscription expires.
\n","urlObject":{"path":["crm","accounts","extendtrial","[accountUid]","[date_in_yyyy-MM-DD]"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cdb0fce8-0145-9ae6-8619-721da60f43ca"},{"name":"Add add-on to subscription","id":"0d2edb9f-ea95-4d05-900a-48db7c232ee5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"AddOn\": { \"Uid\": \"z49E5z97\" },\n \"BillingRenewalTerm\": 1,\n \"Quantity\": 1,\n \"Subscription\": { \"Uid\": \"z49E5z97\" }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/billing/subscriptionaddons","urlObject":{"path":["billing","subscriptionaddons"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0d2edb9f-ea95-4d05-900a-48db7c232ee5"},{"name":"Add discount to subscription","id":"1775fe2a-d4c9-44dd-b840-52adaec01d31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"billing/subscriptions/{subscriptionUid}/discounts/{discountUid}","description":"Add a discount to a subscription.
\n","urlObject":{"path":["subscriptions","{subscriptionUid}","discounts","{discountUid}"],"host":["billing"],"query":[],"variable":[]}},"response":[],"_postman_id":"1775fe2a-d4c9-44dd-b840-52adaec01d31"}],"id":"a4b09cb2-a74f-46f5-8216-94ab114564d9","_postman_id":"a4b09cb2-a74f-46f5-8216-94ab114564d9","description":""},{"name":"Invoices","item":[{"name":"Add new invoice","id":"08d48d5b-3a66-8326-e604-2c27ca8d0475","request":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Subscription\": {\n \"Uid\": \"4XQY8qmP\"\n },\n\t\"InvoiceDate\": \"2017-12-30T00:00:00\",\n\t\"InvoiceLineItems\": [ \n {\n \"Description\": \"Manual invoice\",\n \"Amount\": 20\n },\n {\n \"Description\": \"Manual invoice 2\",\n \"Amount\": 20\n }\n ]\n}"},"url":"{{url}}/billing/invoices","description":"Use this API to create an add-hoc invoice for a given account.
\n","urlObject":{"path":["billing","invoices"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"160c4f16-f00a-1886-c06e-2f79956521e9","name":"Add new invoice","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}","disabled":false},{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"Subscription\": {\"Uid\": \"dpWr3mnq\"},\n\t\"InvoiceDate\": \"2017-12-30T00:00:00\",\n\t\"InvoiceLineItems\": [ {\t\"Description\": \"Manual invoice\",\n\t\t\t\t\t\t\t\t\t\"Amount\": 20},\n\t\t\t\t\t\t {\t\"Description\": \"Manual invoice 2\",\n\t\t\t\t\t\t\t\t\t\"Amount\": 20}\n\t\t\t]\n}"},"url":"{{url}}/billing/invoices"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"1124","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 12 Jun 2019 19:24:55 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"96","body":"{\"InvoiceDate\":\"2017-12-30T00:00:00\",\"Number\":1094,\"BillingInvoiceStatus\":1,\"Subscription\":{\"BillingRenewalTerm\":1,\"Account\":null,\"Plan\":null,\"Quantity\":null,\"StartDate\":\"2017-11-27T05:00:00\",\"EndDate\":null,\"RenewalDate\":\"2019-03-26T05:00:00\",\"NewRequiredQuantity\":null,\"IsPlanUpgradeRequired\":false,\"PlanUpgradeRequiredMessage\":null,\"SubscriptionAddOns\":null,\"Uid\":\"dpWr3mnq\",\"Created\":\"2017-11-27T18:19:45\",\"Updated\":\"2019-02-27T02:47:30\"},\"Amount\":40.0,\"AmountOutstanding\":40.0,\"InvoiceLineItems\":[{\"StartDate\":null,\"EndDate\":null,\"Description\":\"Manual invoice\",\"UnitOfMeasure\":\"\",\"Quantity\":null,\"Rate\":0.0,\"Amount\":20.0,\"Tax\":0.0,\"Invoice\":null,\"Uid\":\"z49EjjW7\",\"Created\":\"2019-06-12T19:24:55.6898226Z\",\"Updated\":\"2019-06-12T19:24:55.6898226Z\"},{\"StartDate\":null,\"EndDate\":null,\"Description\":\"Manual invoice 2\",\"UnitOfMeasure\":\"\",\"Quantity\":null,\"Rate\":0.0,\"Amount\":20.0,\"Tax\":0.0,\"Invoice\":null,\"Uid\":\"owmjkBQV\",\"Created\":\"2019-06-12T19:24:55.6898226Z\",\"Updated\":\"2019-06-12T19:24:55.6898226Z\"}],\"IsUserGenerated\":true,\"Uid\":\"pL9PO6QJ\",\"Created\":\"2019-06-12T19:24:55.6898226Z\",\"Updated\":\"2019-06-12T19:24:55.6898226Z\"}"}],"_postman_id":"08d48d5b-3a66-8326-e604-2c27ca8d0475"},{"name":"Get all transactions by account","id":"fccf606a-2e97-90f1-5b7a-05a503901a03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{url}}/billing/transactions/[accountUid]","description":"Retrieves all transactions for a given accountUId. Transactions are tied to accounts and invoices. Each transaction has a BillingTransactionType.
\nBillingTransactionType\n Invoice = 1,\n Payment = 2,\n Credit = 3,\n Refund = 4,\n Chargeback = 5
\n","urlObject":{"path":["billing","transactions","[accountUid]"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"6be4e875-3114-d654-05f3-639cac4d4e3c","name":"Get all transactions by account","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorizationtoken}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{url}}/billing/transactions/JVmAEnma"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"20585","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 31 May 2019 19:00:53 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"82","body":"{\n \"metadata\": {\n \"limit\": 100,\n \"offset\": 0,\n \"total\": 2\n },\n \"items\": [\n {\n \"TransactionDate\": \"2018-03-28T20:12:46\",\n \"BillingTransactionType\": 1,\n \"Account\": {\n \"Name\": \"Test Corporation\",\n \"ClientIdentifier\": \"55\",\n \"IsDemo\": false,\n \"BillingAddress\": null,\n \"MailingAddress\": null,\n \"AccountStage\": 3,\n \"PaymentInformation\": null,\n \"PersonAccount\": null,\n \"Subscriptions\": null,\n \"Deals\": null,\n \"LastLoginDateTime\": \"2019-03-04T20:41:06\",\n \"AccountStageLabel\": \"Subscribing\",\n \"DomainName\": null,\n \"LatestSubscription\": null,\n \"PrimaryContact\": null,\n \"Uid\": \"JVmAEnma\",\n \"Created\": \"2017-12-15T15:51:33\",\n \"Updated\": \"2019-03-04T20:41:06\"\n },\n \"Invoice\": {\n \"InvoiceDate\": \"2018-03-28T20:12:46\",\n \"Number\": 1014,\n \"BillingInvoiceStatus\": 2,\n \"Subscription\": null,\n \"Amount\": 3.78,\n \"AmountOutstanding\": 0,\n \"InvoiceLineItems\": null,\n \"IsUserGenerated\": false,\n \"Uid\": \"qrm04mXZ\",\n \"Created\": \"2018-03-29T13:02:30\",\n \"Updated\": \"2018-05-24T14:00:29\"\n },\n \"Amount\": 3.78,\n \"Uid\": \"Z496vr9X\",\n \"Created\": \"2018-03-29T13:02:30\",\n \"Updated\": \"2018-03-29T13:02:30\"\n },\n {\n \"TransactionDate\": \"2018-04-28T20:12:46\",\n \"BillingTransactionType\": 1,\n \"Account\": {\n \"Name\": \"Test Corporation\",\n \"ClientIdentifier\": \"55\",\n \"IsDemo\": false,\n \"BillingAddress\": null,\n \"MailingAddress\": null,\n \"AccountStage\": 3,\n \"PaymentInformation\": null,\n \"PersonAccount\": null,\n \"Subscriptions\": null,\n \"Deals\": null,\n \"LastLoginDateTime\": \"2019-03-04T20:41:06\",\n \"AccountStageLabel\": \"Subscribing\",\n \"DomainName\": null,\n \"LatestSubscription\": null,\n \"PrimaryContact\": null,\n \"Uid\": \"JVmAEnma\",\n \"Created\": \"2017-12-15T15:51:33\",\n \"Updated\": \"2019-03-04T20:41:06\"\n },\n \"Invoice\": {\n \"InvoiceDate\": \"2018-04-28T20:12:46\",\n \"Number\": 1035,\n \"BillingInvoiceStatus\": 2,\n \"Subscription\": null,\n \"Amount\": 0.15,\n \"AmountOutstanding\": 0,\n \"InvoiceLineItems\": null,\n \"IsUserGenerated\": false,\n \"Uid\": \"4XQY8qmP\",\n \"Created\": \"2018-04-29T13:00:30\",\n \"Updated\": \"2018-05-24T14:00:33\"\n },\n \"Amount\": 0.15,\n \"Uid\": \"jLmJP69P\",\n \"Created\": \"2018-04-29T13:00:30\",\n \"Updated\": \"2018-04-29T13:00:30\"\n }\n}"}],"_postman_id":"fccf606a-2e97-90f1-5b7a-05a503901a03"},{"name":"Add invoice payment","id":"348bae3f-4688-41d0-bd11-2a5e4da79596","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationToken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Account\": { \"Uid\": \"xxxxxxxx\" },\n \"Invoice\": { \"Uid\": \"yyyyyyyy\" },\n \"Amount\": -19.99\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/billing/transactions/payment","description":"Adds a payment to an invoice. If the amount matches the outstanding amount of the invoice, the invoice will be marked as Paid.
\n","urlObject":{"path":["billing","transactions","payment"],"host":["{{url}}"],"query":[{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[],"_postman_id":"348bae3f-4688-41d0-bd11-2a5e4da79596"}],"id":"358b8db0-0a93-4bc2-81b4-c172feedea37","_postman_id":"358b8db0-0a93-4bc2-81b4-c172feedea37","description":""},{"name":"Payment Information","item":[{"name":"Update Payment Information","id":"f2491ee0-ed4f-4226-b5f2-883a72421d21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{authorizationtoken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Account\": {\n \"Uid\": \"XXXXXXXX\"\n },\n \"CustomerToken\": \"cust_xxxxxxxxxxxxxxxx\",\n \"NameOnCard\": \"Joan Smith\",\n \"PaymentToken\": \"pm_xxxxxxxxxxxxxxxx\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/billing/paymentinformation","urlObject":{"path":["billing","paymentinformation"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f2491ee0-ed4f-4226-b5f2-883a72421d21"}],"id":"7185db30-1981-4871-b02b-64f0a5501377","_postman_id":"7185db30-1981-4871-b02b-64f0a5501377","description":""}],"id":"55ef49c9-577a-aa6a-bfc6-8c60cafd0a97","_postman_id":"55ef49c9-577a-aa6a-bfc6-8c60cafd0a97","description":""},{"name":"User Profile","item":[{"name":"Get Profile","id":"1a03e4dc-b5ce-1ffe-b0f2-cb630dbd44bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorizationoath}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{url}}/profile","description":"Use this method to retrieve the profile information of a user. Please note that you can not call this method with the API keys. You'll need to call it with the auth token generated from the Get Auth token method. Make sure to construct the auth token as described in the Getting started >> Client Side section above.
\n","urlObject":{"path":["profile"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"2159a01e-ced5-4667-a87e-fa3908eb1171","name":"Get Profile","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorizationoath}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/profile"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"Uid\": \"exmewp9V\",\r\n \"Email\": \"example@example.com\",\r\n \"FirstName\": \"My\",\r\n \"LastName\": \"example\",\r\n \"MailingAddress\": {\r\n \"Uid\": \"exmewp9V\",\r\n \"AddressLine1\": \"new line\",\r\n \"AddressLine2\": \"new line2\",\r\n \"AddressLine3\": null,\r\n \"City\": \"City\",\r\n \"State\": \"State\",\r\n \"PostalCode\": \"02446\"\r\n }\r\n}"}],"_postman_id":"1a03e4dc-b5ce-1ffe-b0f2-cb630dbd44bb"},{"name":"Update Profile","id":"d306291e-aaa5-3a6f-1c2d-6d9c423a1ba1","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorizationoath}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Email\": \"test@outseta.com\",\n \"FirstName\": \"Test\",\n \"LastName\": \"Testerakopoulos\",\n \"MailingAddress\": {\n \"AddressLine1\": \"5 Washington Street\",\n \"AddressLine2\": \"#7\",\n \"AddressLine3\": null,\n \"City\": \"Brookline\",\n \"State\": \"Brookline\",\n \"PostalCode\": \"02446\",\n \"Country\": null,\n \"Uid\": \"y7marQEq\",\n \"Created\": \"2017-02-07T20:59:21\",\n \"Updated\": \"2019-07-10T12:13:13\"\n },\n \"UserAgent\": null,\n \"Uid\": \"4XQYqQPB\"\n}"},"url":"{{url}}/profile","description":"Use this method to update the profile information of a user.
\nPlease note that you can not call this method with the API keys. You'll need to call it with the auth token generated from the Get Auth token method. Make sure to construct the auth token as described in the Getting started >> Client Side section above.
\nAlso, the body of the request needs to include the UID property that matches the person that you generated the token for.
\n","urlObject":{"path":["profile"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d306291e-aaa5-3a6f-1c2d-6d9c423a1ba1"},{"name":"Update Password","id":"be2b8327-36dc-fcb0-0cf6-436f2cdaf89d","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorizationoath}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"ExistingPassword\": \"test\",\n \"NewPassword\": \"tester\"\n}"},"url":"{{url}}/profile/password","description":"Use this method to update the password for a user. Please note that you can not call this method with the API keys. You'll need to call it with the auth token generated from the Get Auth token method. Make sure to construct the auth token as described in the Getting started >> Client Side section above.
\n","urlObject":{"path":["profile","password"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"be2b8327-36dc-fcb0-0cf6-436f2cdaf89d"}],"id":"9b533e88-46b6-4097-9710-1f1042bb363a","description":"This section includes APIs that are related to the maintainance of a users information.
\nPlease note that you can not call these method using the authentication token with the API keys. You'll need to call them with the auth token generated from the Get Auth token method. Make sure to construct the auth token as described in the Getting started >> Client Side section above (eg., \"bearer [token]\")
\n","event":[{"listen":"prerequest","script":{"id":"0f8093dd-7a7e-445b-bd85-45d3658860f1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e3e82b27-dc54-4b01-ac57-f0685a84c979","type":"text/javascript","exec":[""]}}],"_postman_id":"9b533e88-46b6-4097-9710-1f1042bb363a"},{"name":"Authentication","item":[{"name":"Get Auth Token","id":"c189ea0d-e3ff-42de-4373-2a09291236f6","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"{{username}}","type":"text"},{"key":"password","value":"{{password}}","type":"text"}]},"url":"{{url}}/tokens","description":"Call this API from the server to retrieve an access token that you can use to make API calls via the client side. Make sure to secure your username and password and not make them visible on the client side.
\nTo retrieve an access token for a user who has registered with your service, the URL should point to your Outseta domain (e.g. https://my-company.outseta.com).
\nTo retrieve an access token for an administrative user who logs into the Outseta admin site, the URL should be https://go.outseta.com.
\n","urlObject":{"path":["tokens"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c189ea0d-e3ff-42de-4373-2a09291236f6"},{"name":"Get Auth Token with API Keys","id":"442e49b2-c30c-27c6-e8cd-e86a32512e9c","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"Outseta {{apiKey}}:{{apiKeySecret}}"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"{{username}}","type":"text"}]},"url":"{{url}}/tokens","description":"Call this API from the server to retrieve an access token that you can used to make API calls via the client side. This method call can also be used to retrieve the access token that can then be set on the profile widget or the chat widget for private sites.
\nMake sure to secure your API keys and not make them visible on the client side.
\n","urlObject":{"path":["tokens"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"73e52bc6-6f19-3c31-e114-976f94ba8894","name":"Get Auth Token with API Keys","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"Outseta {{apiKey}}:{{apiKeySecret}}"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"{{username}}","type":"text"}]},"url":"{{url}}/tokens"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow_Origin","value":"*","name":"Access-Control-Allow_Origin","description":""},{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"1181","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 02 Oct 2019 20:34:25 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"228","body":"{\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6InhObnZiLWxaWDJWNHdKTFctaVdreXBSR0cwVSJ9.eyJ1bmlxdWVfbmFtZSI6ImRpbWl0cmlzQG91dHNldGEuY29tIiwiZ2l2ZW5fbmFtZSI6IkRpbWl0cmlzIiwiZmFtaWx5X25hbWUiOiJHZW9yZ2Frb3BvdWxvcyIsImVtYWlsIjoiZGltaXRyaXNAb3V0c2V0YS5jb20iLCJuYW1laWQiOiI0WFFZcVFQQiIsIm91dHNldGE6YWNjb3VudFVpZCI6IndabU5abTJPIiwib3V0c2V0YTphY2NvdW50Q2xpZW50SWRlbnRpZmllciI6IjEiLCJvdXRzZXRhOmlzUHJpbWFyeSI6IjEiLCJvdXRzZXRhOnN1YnNjcmlwdGlvblVpZCI6IjRYUVlvN1dQIiwib3V0c2V0YTpwbGFuVWlkIjoiS2o5YlhNbW4iLCJvdXRzZXRhOmlzcyI6ImxvY2FsaG9zdCIsImF1ZCI6ImxvY2FsaG9zdCIsImlzcyI6ImxvY2FsaG9zdCIsImV4cCI6MTYwMTU4NDQ2NCwibmJmIjoxNTcwMDQ4NDY0fQ.C13Q5lYW_BOBFLYwiVZX_J1GwlqjtrLCg9PCgIdPzwUKzpQMPbcUGq4DWNs9kleNjEJMy3Cc01S5bNmYefbLuYGngaoRRIqxSd2dErCeSdss9MIMSZjJv_rBuKoaoIXr6uf0KIL_4h1robsMindS2pizz9tqjLO7kcENg9WPfZjuXl81-FIYLL2OsRg7OtHBUvgWvTnnQO_H5_x0vabwD9cKMTH6EeOMMn3StX58yJ1WPNXA-cbppolgcfG45pPfmaPz84wTva-_clSWBG8usPLEshYOTGC8vIbM8LDB0RmxW7vcppcCet1m-tr87J9BzrrVZdVjKzcPUBi5wx0frg\",\n \"token_type\": \"bearer\",\n \"expires_in\": 31535999\n}"}],"_postman_id":"442e49b2-c30c-27c6-e8cd-e86a32512e9c"}],"id":"df12b418-8039-4a58-a0e8-2534ed6aa43c","_postman_id":"df12b418-8039-4a58-a0e8-2534ed6aa43c","description":""},{"name":"Notifications","item":[{"name":"New Request","id":"89fd0c77-fae5-40a4-bb12-7b44ec20cb7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"89fd0c77-fae5-40a4-bb12-7b44ec20cb7f"}],"id":"3a62cfa3-cc8a-4db2-9714-2f644e7517ca","_postman_id":"3a62cfa3-cc8a-4db2-9714-2f644e7517ca","description":""}],"event":[{"listen":"prerequest","script":{"id":"2fb2304c-1d12-418f-bbf7-724f4ca4bef1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3b72cd5d-11d7-4462-acde-1c15f246a54d","type":"text/javascript","exec":[""]}}]}