{"info":{"_postman_id":"e535893d-37e5-4347-ac41-a4ba280d82ec","name":"Revaluate API","description":"

A simple API for interacting with your Revaluate account

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"22173140","collectionId":"e535893d-37e5-4347-ac41-a4ba280d82ec","publishedId":"2sBY4WocCj","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-08-11T18:51:57.000Z"},"item":[{"name":"Check Token","id":"86ea554c-c2d2-40f0-bc93-6564c5607b22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"https://api.revaluate.com/v1/users/check_token","description":"

Revaluate API uses your API Token for authentication. All endpoints require the Authorization Header.Returns a success true if the token is valid.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"e535893d-37e5-4347-ac41-a4ba280d82ec","id":"e535893d-37e5-4347-ac41-a4ba280d82ec","name":"Revaluate API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","users","check_token"],"host":["api","revaluate","com"],"query":[],"variable":[]}},"response":[{"id":"2d47ff38-9c39-4d6c-8f76-697ce174fa82","name":"Response_200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"https://api.revaluate.com/v1/users/check_token","description":"Revaluate API uses your API Token for authentication. All endpoints require the Authorization Header.Returns a success true if the token is valid."},"code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}\nRequests with a message-body are using plain JSON to set or update resource states.\n\nResponses are in JSON."}],"_postman_id":"86ea554c-c2d2-40f0-bc93-6564c5607b22"},{"name":"Get Billing Details","id":"8350774e-4a07-4c1d-a79f-552c3eee344f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"https://api.revaluate.com/v1/billing","description":"

Get billing information about your account.This endpoint can be called by the parent account user or a child. Since billing is tied to the parent account, the last 4 digits of the credit card number are only shown to the parent. The company section shows the contact highwater mark counts for the entire account (all children) while the user section only shows the counts for the current user calling the API.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"e535893d-37e5-4347-ac41-a4ba280d82ec","id":"e535893d-37e5-4347-ac41-a4ba280d82ec","name":"Revaluate API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","billing"],"host":["api","revaluate","com"],"query":[],"variable":[]}},"response":[{"id":"332dceb4-6234-4e67-9a05-459359fed111","name":"Response_200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"https://api.revaluate.com/v1/billing","description":"Get billing information about your account.This endpoint can be called by the parent account user or a child. Since billing is tied to the parent account, the last 4 digits of the credit card number are only shown to the parent. The company section shows the contact highwater mark counts for the entire account (all children) while the user section only shows the counts for the current user calling the API."},"code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"cookie":[],"responseTime":null,"body":"{ \"email\": \"user@domain.com\", \"credit_card\": { \"last4\": \"4242\" }, \"company\": { \"current_high_watermark\": 229, \"current_high_watermark_date\": \"2021-05-20\", \"previous_high_watermark\": 1679, \"previous_high_watermark_date\": \"2021-04-20\", \"child_user_count\": 1 }, \"user\": { \"current_high_watermark\": 229, \"current_high_watermark_date\": \"2021-05-20\" }}"}],"_postman_id":"8350774e-4a07-4c1d-a79f-552c3eee344f"},{"name":"List All Contacts","id":"6f12c356-ea13-4831-9cf6-51d25834dcb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"https://api.revaluate.com/v1/contacts?page=1&page_size=10&include_child_contacts=false&change=increase","description":"

Please Note: Although the field that contains the score of a contact is move_score, please refer to this as the \"Revaluate Score\" anywhere it is displayed to users.Pages are limited to 1,000 contacts per page with a default of 10. Use a 'page' query parameter to loop through additional pages. The \"change\" field can have a value of \"none\", \"increase\", or \"decrease\".

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"e535893d-37e5-4347-ac41-a4ba280d82ec","id":"e535893d-37e5-4347-ac41-a4ba280d82ec","name":"Revaluate API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","contacts"],"host":["api","revaluate","com"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"10"},{"key":"include_child_contacts","value":"false"},{"key":"change","value":"increase"}],"variable":[]}},"response":[{"id":"e51397f5-632f-4185-8921-70f1ebf48dd3","name":"Response_200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.revaluate.com/v1/contacts?page=1&page_size=10&include_child_contacts=false&change=increase","protocol":"https","host":["api","revaluate","com"],"path":["v1","contacts"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"10"},{"key":"include_child_contacts","value":"false"},{"key":"change","value":"increase"}]},"description":"Please Note: Although the field that contains the score of a contact is `move_score`, please refer to this as the \"Revaluate Score\" anywhere it is displayed to users.Pages are limited to 1,000 contacts per page with a default of 10. Use a 'page' query parameter to loop through additional pages. The \"change\" field can have a value of \"none\", \"increase\", or \"decrease\"."},"code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"cookie":[],"responseTime":null,"body":"{ \"count\": 20121, \"page\": 2, \"per_page\": 10, \"pages_count\": 2013, \"contacts\": [ { \"id\": \"587d299e547261777a880000\", \"email\": \"test@example.com\", \"name\": \"Billy Joe\", \"move_score\": 98.89, \"change\": \"none\", \"job_title\": \"Software Developer\", \"home_owner\": \"Own\", \"children\": \"Yes\", \"social_profiles\": [ { \"type\": \"facebook\", \"url\": \"https://www.facebook.com/fb.user.16\" } ], \"job_company\": \"Revaluate\", \"avg_salary\": \"$93,574\", \"phone\": \"303-867-5309\", \"external_id\": \"abc123\", \"external_owner_id\": \"own123\", \"year_last_moved\": 2009, \"age_range\": \"31-39\", \"gender\": \"Female\", \"address\": \"123 Main St. Unit 123, Golden, CO 80401\", \"address_line_1\": \"123 Main St.\", \"address_line_2\": \"Unit 123\", \"city\": \"Golden\", \"state\": \"CO\", \"postal_code\": \"80401\", \"tags\": [\"google_import\", \"other-tag\"], \"snoozed_until\": \"2018-03-12T10:37:00.050-06:00\", \"first_crossed_threshold\": \"2017-01-18T12:13:20.153-07:00\", \"created_at\": \"2017-01-16T13:14:20.153-07:00\", \"updated_at\": \"2017-01-16T13:14:20.153-07:00\" }, { \"id\": \"587d2851547261777a200000\", \"email\": \"otherperson@example.com\", \"name\": \"Jane Jones\", \"move_score\": 80.77, \"change\": \"increase\", \"job_title\": \"Marketing Intern\", \"home_owner\": \"Rent\", \"children\": \"No\", \"social_profiles\": [ { \"type\": \"facebook\", \"url\": \"https://www.facebook.com/fb.user.17\" } ], \"job_company\": \"Revaluate\", \"avg_salary\": \"$23,574\", \"phone\": \"303-867-5309\", \"external_id\": \"abc4456\", \"external_owner_id\": \"own123\", \"year_last_moved\": 2009, \"age_range\": \"31-39\", \"gender\": \"Female\", \"address\": \"456 E 19th St. Unit 321, Lawrence, KS, 66046\", \"address_line_1\": \"456 E 19th St.\", \"address_line_2\": \"Unit 321\", \"city\": \"Lawrence\", \"state\": \"KS\", \"postal_code\": \"66046\", \"tags\": [\"google_import\", \"other-tag\"], \"snoozed_until\": \"2018-03-12T10:37:00.050-06:00\", \"first_crossed_threshold\": \"2017-01-18T12:13:20.153-07:00\", \"email_bounce_status\": \"Valid\", \"created_at\": \"2017-01-16T13:14:20.153-07:00\", \"updated_at\": \"2017-01-16T13:14:20.153-07:00\" } ]}"}],"_postman_id":"6f12c356-ea13-4831-9cf6-51d25834dcb4"},{"name":"Create a New Contact","id":"15d3c53b-fb3b-40e8-aa63-14df692dd4aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"contact\": { \"email\": \"otherperson@example.com\", \"name\": \"Jane Jones\", \"external_id\": \"abc123\", \"external_owner_id\": \"own123\", \"address\": \"456 E 19th St. Unit 321, Lawrence, KS, 66046\", \"address_line_1\": \"456 E 19th St.\", \"address_line_2\": \"Unit 321\", \"city\": \"Lawrence\", \"state\": \"KS\", \"postal_code\": \"66046\", \"phone\": \"3033335555\", \"tags\": [\"tag1\", \"tag2\"] }}"},"url":"https://api.revaluate.com/v1/contacts","description":"

Please Note: Although the field that contains the score of a contact is move_score, please refer to this as the \"Revaluate Score\" anywhere it is displayed to users.You may create your own contact using this action. It takes a JSON\nobject containing a contact object. Email is required.

\n
Note on Addresses:
\n

When passing in an address, it is recommended to use the separate address parts (address_line_1, address_line_2, city, state, postal_code). If you don't have them split out, you can use the single \"address\" field.

\n
If you attempt to create a contact that already exists in your Revaluate account (email address), you will receive a 422 error code. Please use the PUT action to update existing contacts.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"e535893d-37e5-4347-ac41-a4ba280d82ec","id":"e535893d-37e5-4347-ac41-a4ba280d82ec","name":"Revaluate API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","contacts"],"host":["api","revaluate","com"],"query":[],"variable":[]}},"response":[{"id":"cfcb2e02-1963-4c9d-b0e0-2fe7fe7070ed","name":"Response_201","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"contact\": { \"email\": \"otherperson@example.com\", \"name\": \"Jane Jones\", \"external_id\": \"abc123\", \"external_owner_id\": \"own123\", \"address\": \"456 E 19th St. Unit 321, Lawrence, KS, 66046\", \"address_line_1\": \"456 E 19th St.\", \"address_line_2\": \"Unit 321\", \"city\": \"Lawrence\", \"state\": \"KS\", \"postal_code\": \"66046\", \"phone\": \"3033335555\", \"tags\": [\"tag1\", \"tag2\"] }}"},"url":"https://api.revaluate.com/v1/contacts","description":"Please Note: Although the field that contains the score of a contact is `move_score`, please refer to this as the \"Revaluate Score\" anywhere it is displayed to users.You may create your own contact using this action. It takes a JSON\nobject containing a contact object. Email is required.\n\n##### Note on Addresses:\n\nWhen passing in an address, it is recommended to use the separate address parts (address_line_1, address_line_2, city, state, postal_code). If you don't have them split out, you can use the single \"address\" field.\n\n###### If you attempt to create a contact that already exists in your Revaluate account (email address), you will receive a 422 error code. Please use the PUT action to update existing contacts."},"code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"cookie":[],"responseTime":null,"body":"{ \"id\": \"587d2851547261777a200000\", \"email\": \"otherperson@example.com\", \"name\": \"Jane Jones\", \"move_score\": 80.77, \"external_id\": \"abc123\", \"external_owner_id\": \"own123\", \"address\": \"456 E 19th St. Unit 321, Lawrence, KS, 66046\", \"address_line_1\": \"456 E 19th St.\", \"address_line_2\": \"Unit 321\", \"city\": \"Lawrence\", \"state\": \"KS\", \"postal_code\": \"66046\", \"phone\": \"3033335555\", \"created_at\": \"2017-01-16T13:14:20.153-07:00\", \"updated_at\": \"2017-01-16T13:14:20.153-07:00\",}"}],"_postman_id":"15d3c53b-fb3b-40e8-aa63-14df692dd4aa"},{"name":"Retrieve a Contact","id":"26f90a86-77c5-411e-8cee-c49c4d64baae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"https://api.revaluate.com/v1/contacts/:id","description":"

A single Contact object with all its details.

\n
    \n

  • home_owner can be any of the following: Own, Rent, Unknown

    \n
    • \n

  • email_bounce_status can be any of the following: Valid, Risky, Invalid (Optional field. Please contact support to enable or learn more about Email Bounce Status) support AT revaluate.com

    \n
    • \n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"e535893d-37e5-4347-ac41-a4ba280d82ec","id":"e535893d-37e5-4347-ac41-a4ba280d82ec","name":"Revaluate API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","contacts",":id"],"host":["api","revaluate","com"],"query":[],"variable":[{"id":"55530eb6-4d56-48c9-877c-dc61343954ce","description":{"content":"

ID of the Contact.

\n","type":"text/plain"},"type":"any","value":"587d2851547261777a200000","key":"id"}]}},"response":[{"id":"32378d24-fb0a-4004-b4c0-24180abc4154","name":"Response_200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.revaluate.com/v1/contacts/:id","protocol":"https","host":["api","revaluate","com"],"path":["v1","contacts",":id"],"variable":[{"id":"55530eb6-4d56-48c9-877c-dc61343954ce","key":"id","value":"587d2851547261777a200000","description":"`ID` of the Contact."}]},"description":"A single Contact object with all its details.\n\n+ `home_owner` can be any of the following: `Own`, `Rent`, `Unknown`\n\n+ `email_bounce_status` can be any of the following: `Valid`, `Risky`, `Invalid` (Optional field. Please contact support to enable or learn more about Email Bounce Status) support AT revaluate.com"},"code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"cookie":[],"responseTime":null,"body":"{ \"id\": \"587d2851547261777a200000\", \"email\": \"otherperson@example.com\", \"name\": \"Jane Jones\", \"move_score\": 80.77, \"change\": \"none\", \"job_title\": \"Software Developer\", \"job_company\": \"Revaluate\", \"home_owner\": \"Own\", \"children\": \"Yes\", \"social_profiles\": [ { \"type\": \"facebook\", \"url\": \"https://www.facebook.com/fb.user.16\" } ], \"avg_salary\": \"$93,574\", \"phone\": \"303-867-5309\", \"external_id\": \"abc123\", \"external_owner_id\": \"own123\", \"year_last_moved\": 2009, \"age_range\": \"31-39\", \"gender\": \"Female\", \"address\": \"456 E 19th St. Unit 321, Lawrence, KS, 66046\", \"address_line_1\": \"456 E 19th St.\", \"address_line_2\": \"Unit 321\", \"city\": \"Lawrence\", \"state\": \"KS\", \"postal_code\": \"66046\", \"tags\": [\"google_import\", \"other-tag\"], \"snoozed_until\": \"2018-03-12T10:37:00.050-06:00\", \"first_crossed_threshold\": \"2017-01-18T12:13:20.153-07:00\", \"email_bounce_status\": \"Valid\", \"created_at\": \"2017-01-16T13:14:20.153-07:00\", \"updated_at\": \"2017-01-16T13:14:20.153-07:00\"}"}],"_postman_id":"26f90a86-77c5-411e-8cee-c49c4d64baae"},{"name":"Update a Contact","id":"2d606c7b-9a20-45b3-aaf0-cc07123004f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"contact\": { \"name\": \"Changed Name\", \"phone\": \"3033335555\", \"external_id\": \"ext_999\", \"external_owner_id\": \"own123\", \"address\": \"123 5th Street, Boulder, CO 80305\", \"address_line_1\": \"123 5th Street\", \"address_line_2\": \"\", \"city\": \"Boulder\", \"state\": \"CO\", \"postal_code\": \"80305\", \"tags\": [\"tag1\", \"tag2\"] }}"},"url":"https://api.revaluate.com/v1/contacts/:id","description":"

A single Contact object with all its details.

\n
    \n

  • home_owner can be any of the following: Own, Rent, Unknown

    \n
    • \n

  • email_bounce_status can be any of the following: Valid, Risky, Invalid (Optional field. Please contact support to enable or learn more about Email Bounce Status) support AT revaluate.com

    \n
    • \n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"e535893d-37e5-4347-ac41-a4ba280d82ec","id":"e535893d-37e5-4347-ac41-a4ba280d82ec","name":"Revaluate API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","contacts",":id"],"host":["api","revaluate","com"],"query":[],"variable":[{"id":"a119b4e8-752f-4b0a-8913-61b90e04cab5","description":{"content":"

ID of the Contact.

\n","type":"text/plain"},"type":"any","value":"587d2851547261777a200000","key":"id"}]}},"response":[{"id":"35c7c913-5fe3-4acb-a373-b351adf9d6dd","name":"Response_200","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"contact\": { \"name\": \"Changed Name\", \"phone\": \"3033335555\", \"external_id\": \"ext_999\", \"external_owner_id\": \"own123\", \"address\": \"123 5th Street, Boulder, CO 80305\", \"address_line_1\": \"123 5th Street\", \"address_line_2\": \"\", \"city\": \"Boulder\", \"state\": \"CO\", \"postal_code\": \"80305\", \"tags\": [\"tag1\", \"tag2\"] }}"},"url":{"raw":"https://api.revaluate.com/v1/contacts/:id","protocol":"https","host":["api","revaluate","com"],"path":["v1","contacts",":id"],"variable":[{"id":"a119b4e8-752f-4b0a-8913-61b90e04cab5","key":"id","value":"587d2851547261777a200000","description":"`ID` of the Contact."}]},"description":"A single Contact object with all its details.\n\n+ `home_owner` can be any of the following: `Own`, `Rent`, `Unknown`\n\n+ `email_bounce_status` can be any of the following: `Valid`, `Risky`, `Invalid` (Optional field. Please contact support to enable or learn more about Email Bounce Status) support AT revaluate.com"},"code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"cookie":[],"responseTime":null,"body":"{ \"id\": \"587d2851547261777a200000\", \"email\": \"otherperson@example.com\", \"name\": \"Changed Name\", \"move_score\": 80.77, \"external_id\": \"ext_999\", \"external_owner_id\": \"own123\", \"address\": \"123 5th Street, Boulder, CO 80305\", \"address_line_1\": \"123 5th Street\", \"address_line_2\": \"\", \"city\": \"Boulder\", \"state\": \"CO\", \"postal_code\": \"80305\", \"phone\": \"3033335555\", \"created_at\": \"2017-01-16T13:14:20.153-07:00\", \"updated_at\": \"2017-01-16T13:14:20.153-07:00\"}"}],"_postman_id":"2d606c7b-9a20-45b3-aaf0-cc07123004f0"},{"name":"Remove a Contact","id":"c7a89187-ba86-4bf3-b83d-9c43f152e416","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":""},"url":"https://api.revaluate.com/v1/contacts/:id","description":"

A single Contact object with all its details.

\n
    \n

  • home_owner can be any of the following: Own, Rent, Unknown

    \n
    • \n

  • email_bounce_status can be any of the following: Valid, Risky, Invalid (Optional field. Please contact support to enable or learn more about Email Bounce Status) support AT revaluate.com

    \n
    • \n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"e535893d-37e5-4347-ac41-a4ba280d82ec","id":"e535893d-37e5-4347-ac41-a4ba280d82ec","name":"Revaluate API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","contacts",":id"],"host":["api","revaluate","com"],"query":[],"variable":[{"id":"c1f87fa1-2a2a-45cf-ada3-485b53fe5457","description":{"content":"

ID of the Contact.

\n","type":"text/plain"},"type":"any","value":"587d2851547261777a200000","key":"id"}]}},"response":[{"id":"8711acee-160b-444c-9c64-2aee7de8792a","name":"Response_204","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.revaluate.com/v1/contacts/:id","protocol":"https","host":["api","revaluate","com"],"path":["v1","contacts",":id"],"variable":[{"id":"c1f87fa1-2a2a-45cf-ada3-485b53fe5457","key":"id","value":"587d2851547261777a200000","description":"`ID` of the Contact."}]},"description":"A single Contact object with all its details.\n\n+ `home_owner` can be any of the following: `Own`, `Rent`, `Unknown`\n\n+ `email_bounce_status` can be any of the following: `Valid`, `Risky`, `Invalid` (Optional field. Please contact support to enable or learn more about Email Bounce Status) support AT revaluate.com"},"code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c7a89187-ba86-4bf3-b83d-9c43f152e416"},{"name":"Retrieve a Contact By Email Address","id":"4707dc17-50b9-4681-a967-24419764ee21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"email\": \"otherperson@example.com\"}"},"url":"https://api.revaluate.com/v1/contacts/show_by_email","description":"

In order to protect the email address, we require this to be sent via a POST instead of via the querystring as would normally be used. A single Contact object with all its details. home_owner can be any of the following: 'Own', 'Rent', 'Unknown'.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"e535893d-37e5-4347-ac41-a4ba280d82ec","id":"e535893d-37e5-4347-ac41-a4ba280d82ec","name":"Revaluate API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","contacts","show_by_email"],"host":["api","revaluate","com"],"query":[],"variable":[]}},"response":[{"id":"e4534859-a255-4613-9354-be9bdbf1029f","name":"Response_200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"email\": \"otherperson@example.com\"}"},"url":"https://api.revaluate.com/v1/contacts/show_by_email","description":"In order to protect the email address, we require this to be sent via a POST instead of via the querystring as would normally be used. A single Contact object with all its details. home_owner can be any of the following: 'Own', 'Rent', 'Unknown'."},"code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"cookie":[],"responseTime":null,"body":"{ \"id\": \"587d2851547261777a200000\", \"email\": \"otherperson@example.com\", \"name\": \"Jane Jones\", \"move_score\": 80.77, \"change\": \"none\", \"job_title\": \"Software Developer\", \"job_company\": \"Revaluate\", \"home_owner\": \"Own\", \"children\": \"Yes\", \"social_profiles\": [ { \"type\": \"facebook\", \"url\": \"https://www.facebook.com/fb.user.16\" } ], \"avg_salary\": \"$93,574\", \"phone\": \"303-867-5309\", \"external_id\": \"abc123\", \"external_owner_id\": \"own123\", \"year_last_moved\": 2009, \"age_range\": \"31-39\", \"gender\": \"Female\", \"address\": \"456 E 19th St. Unit 321, Lawrence, KS, 66046\", \"address_line_1\": \"456 E 19th St.\", \"address_line_2\": \"Unit 321\", \"city\": \"Lawrence\", \"state\": \"KS\", \"postal_code\": \"66046\", \"tags\": [\"google_import\", \"other-tag\"], \"snoozed_until\": \"2018-03-12T10:37:00.050-06:00\", \"first_crossed_threshold\": \"2017-01-18T12:13:20.153-07:00\", \"email_bounce_status\": \"Valid\", \"created_at\": \"2017-01-16T13:14:20.153-07:00\", \"updated_at\": \"2017-01-16T13:14:20.153-07:00\"}"}],"_postman_id":"4707dc17-50b9-4681-a967-24419764ee21"},{"name":"Create a User","id":"c3c2d169-9f24-4b7d-9775-3a8c04510038","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"user\": { \"email\": \"apicontact@example.com\", \"name\": \"Larry Smith\", \"company\": \"Super Brokers\", \"phone\": \"303-555-5555\", \"address_1\": \"123 Main St.\", \"address_2\": \"Suite 200\", \"city\": \"Boulder\", \"state\": \"CO\", \"postal_code\": \"80305\", \"lead_routing_email\": \"leads@example.com\", \"lead_routing_phone\": \"303-867-5309\", \"external_id\": \"abc123\", \"followupboss_api_key\": \"key123\", \"followupboss_include_tags\": [\"tag1\", \"tag2\"], \"enable_boomtown_sync_email\": true, \"enable_followupboss_sync_email\": true, \"send_followup_surveys\": false, \"followupboss_enable_tagging\": true, \"score_alert_enabled\": false }}"},"url":"https://api.revaluate.com/v1/users","description":"
NOTE: The user endpoints are reserved for Revaluate partners and your API key will need to be granted access. Please reach out if you'd like to discuss a partnership.You may create a child user in your account using this action. It takes a JSON
\n

object containing a user object. Email is required.

\n

The external_id is the User ID from the external system. This is only needed if you want to be able to track the user's ID across different platforms.

\n

You may only use include or exclude tags for a given system. You cannot use both at the same time.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"e535893d-37e5-4347-ac41-a4ba280d82ec","id":"e535893d-37e5-4347-ac41-a4ba280d82ec","name":"Revaluate API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","users"],"host":["api","revaluate","com"],"query":[],"variable":[]}},"response":[{"id":"9cd00884-0c3c-4f20-9fd7-2c18a3f1060e","name":"Response_201","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"user\": { \"email\": \"apicontact@example.com\", \"name\": \"Larry Smith\", \"company\": \"Super Brokers\", \"phone\": \"303-555-5555\", \"address_1\": \"123 Main St.\", \"address_2\": \"Suite 200\", \"city\": \"Boulder\", \"state\": \"CO\", \"postal_code\": \"80305\", \"lead_routing_email\": \"leads@example.com\", \"lead_routing_phone\": \"303-867-5309\", \"external_id\": \"abc123\", \"followupboss_api_key\": \"key123\", \"followupboss_include_tags\": [\"tag1\", \"tag2\"], \"enable_boomtown_sync_email\": true, \"enable_followupboss_sync_email\": true, \"send_followup_surveys\": false, \"followupboss_enable_tagging\": true, \"score_alert_enabled\": false }}"},"url":"https://api.revaluate.com/v1/users","description":"##### NOTE: The user endpoints are reserved for Revaluate partners and your API key will need to be granted access. Please reach out if you'd like to discuss a partnership.You may create a child user in your account using this action. It takes a JSON\nobject containing a user object. Email is required.\n\nThe external_id is the User ID from the external system. This is only needed if you want to be able to track the user's ID across different platforms.\n\nYou may only use include or exclude tags for a given system. You cannot use both at the same time."},"code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"cookie":[],"responseTime":null,"body":"{ \"id\": \"587d2851547261777a200000\", \"email\": \"otherperson@example.com\", \"name\": \"Jane Jones\", \"contact_high_watermark\": 0, \"created_at\": \"2017-01-16T13:14:20.153-07:00\", \"updated_at\": \"2017-01-16T13:14:20.153-07:00\"}"}],"_postman_id":"c3c2d169-9f24-4b7d-9775-3a8c04510038"},{"name":"Retrieve a User","id":"1d3f721b-4319-498a-b0b4-25b41ecabdd4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"https://api.revaluate.com/v1/users/:id","description":"

The User object allows you to work with Revaluate user accounts. A single User object with all its details.Returns details about a given user. ID is required and is returned from the CREATE endpoint.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"e535893d-37e5-4347-ac41-a4ba280d82ec","id":"e535893d-37e5-4347-ac41-a4ba280d82ec","name":"Revaluate API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","users",":id"],"host":["api","revaluate","com"],"query":[],"variable":[{"id":"02954737-938d-4b83-b7be-aa3bce683877","description":{"content":"

ID of the User.

\n","type":"text/plain"},"type":"any","value":"587d2851547261777a200000","key":"id"}]}},"response":[{"id":"9c5431d6-1361-46c1-a6a9-bb09e2e5f9e6","name":"Response_200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.revaluate.com/v1/users/:id","protocol":"https","host":["api","revaluate","com"],"path":["v1","users",":id"],"variable":[{"id":"02954737-938d-4b83-b7be-aa3bce683877","key":"id","value":"587d2851547261777a200000","description":"`ID` of the User."}]},"description":"The User object allows you to work with Revaluate user accounts. A single User object with all its details.Returns details about a given user. ID is required and is returned from the CREATE endpoint."},"code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"cookie":[],"responseTime":null,"body":"{ \"id\": \"587d2851547261777a200000\", \"email\": \"otherperson@example.com\", \"name\": \"Jane Jones\", \"contact_high_watermark\": 2305, \"created_at\": \"2017-01-16T13:14:20.153-07:00\", \"updated_at\": \"2017-01-16T13:14:20.153-07:00\"}"}],"_postman_id":"1d3f721b-4319-498a-b0b4-25b41ecabdd4"},{"name":"Update a User","id":"8ec9b181-40a2-45d8-9ee6-705dc4a71398","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"user\": { \"name\": \"Larry Smith\", \"company\": \"Super Brokers\", \"phone\": \"303-555-5555\", \"lead_routing_email\": \"leads@example.com\", \"lead_routing_phone\": \"303-867-5309\", \"external_id\": \"abc123\", \"followupboss_api_key\": \"key123\", \"followupboss_include_tags\": [\"tag1\", \"tag2\"], \"enable_boomtown_sync_email\": true, \"enable_followupboss_sync_email\": true, \"send_followup_surveys\": false, \"followupboss_enable_tagging\": true, \"score_alert_enabled\": true }}"},"url":"https://api.revaluate.com/v1/users/:id","description":"

The User object allows you to work with Revaluate user accounts. A single User object with all its details.You may update a child user in your account using this action. It takes a JSON\nobject containing a user object.

\n

Email address may not be updated via the API.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"e535893d-37e5-4347-ac41-a4ba280d82ec","id":"e535893d-37e5-4347-ac41-a4ba280d82ec","name":"Revaluate API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","users",":id"],"host":["api","revaluate","com"],"query":[],"variable":[{"id":"96bf9c95-2078-412f-ba0e-f714dbe1b621","description":{"content":"

ID of the User.

\n","type":"text/plain"},"type":"any","value":"587d2851547261777a200000","key":"id"}]}},"response":[{"id":"a467aa8a-6d66-4205-ada1-24b46f8a713b","name":"Response_200","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"user\": { \"name\": \"Larry Smith\", \"company\": \"Super Brokers\", \"phone\": \"303-555-5555\", \"lead_routing_email\": \"leads@example.com\", \"lead_routing_phone\": \"303-867-5309\", \"external_id\": \"abc123\", \"followupboss_api_key\": \"key123\", \"followupboss_include_tags\": [\"tag1\", \"tag2\"], \"enable_boomtown_sync_email\": true, \"enable_followupboss_sync_email\": true, \"send_followup_surveys\": false, \"followupboss_enable_tagging\": true, \"score_alert_enabled\": true }}"},"url":{"raw":"https://api.revaluate.com/v1/users/:id","protocol":"https","host":["api","revaluate","com"],"path":["v1","users",":id"],"variable":[{"id":"96bf9c95-2078-412f-ba0e-f714dbe1b621","key":"id","value":"587d2851547261777a200000","description":"`ID` of the User."}]},"description":"The User object allows you to work with Revaluate user accounts. A single User object with all its details.You may update a child user in your account using this action. It takes a JSON\nobject containing a user object.\n\nEmail address may not be updated via the API."},"code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"cookie":[],"responseTime":null,"body":"{ \"id\": \"587d2851547261777a200000\", \"email\": \"otherperson@example.com\", \"name\": \"Jane Jones\", \"contact_high_watermark\": 0, \"created_at\": \"2017-01-16T13:14:20.153-07:00\", \"updated_at\": \"2017-01-16T13:14:20.153-07:00\"}"}],"_postman_id":"8ec9b181-40a2-45d8-9ee6-705dc4a71398"},{"name":"Delete a User","id":"d182e0e8-4cb7-415d-acf1-517b3fa53889","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":""},"url":"https://api.revaluate.com/v1/users/:id","description":"

The User object allows you to work with Revaluate user accounts. A single User object with all its details.You may remove a child user in your account using this action.

\n

Remove the parent user is not permitted.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"e535893d-37e5-4347-ac41-a4ba280d82ec","id":"e535893d-37e5-4347-ac41-a4ba280d82ec","name":"Revaluate API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","users",":id"],"host":["api","revaluate","com"],"query":[],"variable":[{"id":"861f5095-f42f-4f7a-9e1b-b9ad43f7505e","description":{"content":"

ID of the User.

\n","type":"text/plain"},"type":"any","value":"587d2851547261777a200000","key":"id"}]}},"response":[{"id":"d1a05568-0530-4a56-8a3e-bd336252401d","name":"Response_204","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.revaluate.com/v1/users/:id","protocol":"https","host":["api","revaluate","com"],"path":["v1","users",":id"],"variable":[{"id":"861f5095-f42f-4f7a-9e1b-b9ad43f7505e","key":"id","value":"587d2851547261777a200000","description":"`ID` of the User."}]},"description":"The User object allows you to work with Revaluate user accounts. A single User object with all its details.You may remove a child user in your account using this action.\n\nRemove the parent user is not permitted."},"code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d182e0e8-4cb7-415d-acf1-517b3fa53889"},{"name":"Generate SSO Token","id":"e6737e99-dd6a-4efe-9022-f5899112c7ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"product\": \"reportcard\"}"},"url":"https://api.revaluate.com/v1/users/sso_token/:user_id","description":"

Revaluate supports Single Sign On for approved partners and is subject to IP whitelisting. \nTo get started, reach out to your account representative to be connected to the engineering team.The first step is to generate an SSO Token for the child user you wish to log in.

\n

You must pass in the product name you want the user to be redirected to as part of your request. Valid product names are: \"reveal\", \"repair\", and \"reportcard\".

\n

With the resulting token (sso_token) that is returned, you'll need to construct a link for the user to click that looks like the following:

\n
<a href=\"https://revaluate.com/ssologin?sso_token=[SSO_TOKEN FROM ABOVE]\">Login</a>\n

All SSO Tokens expire in 15 minutes.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"e535893d-37e5-4347-ac41-a4ba280d82ec","id":"e535893d-37e5-4347-ac41-a4ba280d82ec","name":"Revaluate API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","users","sso_token",":user_id"],"host":["api","revaluate","com"],"query":[],"variable":[{"id":"d7474940-8f8d-403b-9841-130c09a1b671","description":{"content":"

ID of the User.

\n","type":"text/plain"},"type":"any","value":"587d2851547261777a200000","key":"user_id"}]}},"response":[{"id":"fc5f7c2a-5782-4512-ab28-04a978f77756","name":"Response_200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"product\": \"reportcard\"}"},"url":{"raw":"https://api.revaluate.com/v1/users/sso_token/:user_id","protocol":"https","host":["api","revaluate","com"],"path":["v1","users","sso_token",":user_id"],"variable":[{"id":"d7474940-8f8d-403b-9841-130c09a1b671","key":"user_id","value":"587d2851547261777a200000","description":"`ID` of the User."}]},"description":"Revaluate supports Single Sign On for approved partners and is subject to IP whitelisting. \nTo get started, reach out to your account representative to be connected to the engineering team.The first step is to generate an SSO Token for the child user you wish to log in.\n\nYou must pass in the product name you want the user to be redirected to as part of your request. Valid product names are: \"reveal\", \"repair\", and \"reportcard\".\n\nWith the resulting token (`sso_token`) that is returned, you'll need to construct a link for the user to click that looks like the following:\n\n```\nLogin\n```\n\n**All SSO Tokens expire in 15 minutes.**"},"code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"cookie":[],"responseTime":null,"body":"{ \"success\": true, \"sso_token\": \"abc123_token\"}"}],"_postman_id":"e6737e99-dd6a-4efe-9022-f5899112c7ba"},{"name":"List All Subscriptions","id":"d6fcda11-3f1a-4436-99ad-700e90b4279f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"https://api.revaluate.com/v1/subscriptions?page=1&page_size=10","description":"

This is the webhook (Resthook) documentation section. Please read more about the Resthooks standard here.\nCurrently our list of supported events you can subscribe to are:

\n
    \n

  • contact.ascend_80 (occurs when a contact was previously below 80 and crosses above 80)

    \n
    • \n

  • contact.descend_80 (occurs when a contact was previously above 80 and crosses below 80)

    \n
    • \n
\n

When a webhook is triggered for a contact, the following data is POSTed to the provided hook URL:

\n

{ \"id\": \"5e7ae3f163053e73af6e0326\", \"email\": \"testcontact@live.com\", \"name\": \"Test Contact\", \"move_score\": 96.5, \"change\": \"decrease\", \"phone\": \"303-333-3333\", \"external_id\": \"abc123\", \"tags\": [ \"tag1\", \"tag2\" ], \"created_at\": \"2020-03-27T23:43:13.544-06:00\", \"updated_at\": \"2020-04-16T13:44:26.122-06:00\" }Pages are limited to 1,000 contacts per page with a default of 10. Use a 'page' query parameter to loop through additional pages. The \"change\" field can have a value of \"none\", \"increase\", or \"decrease\".

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"e535893d-37e5-4347-ac41-a4ba280d82ec","id":"e535893d-37e5-4347-ac41-a4ba280d82ec","name":"Revaluate API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","subscriptions"],"host":["api","revaluate","com"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"10"}],"variable":[]}},"response":[{"id":"5b96e6f7-c364-494e-a4ab-a78be1dcb49d","name":"Response_200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.revaluate.com/v1/subscriptions?page=1&page_size=10","protocol":"https","host":["api","revaluate","com"],"path":["v1","subscriptions"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"10"}]},"description":"This is the webhook (Resthook) documentation section. Please read more about the Resthooks standard [here](https://resthooks.org/docs/).\nCurrently our list of supported events you can subscribe to are:\n\n* contact.ascend_80 \\(occurs when a contact was previously below 80 and crosses above 80\\)\n\n* contact.descend_80 \\(occurs when a contact was previously above 80 and crosses below 80\\)\n\nWhen a webhook is triggered for a contact, the following data is POSTed to the provided hook URL:\n\n```\n {\n \"id\": \"5e7ae3f163053e73af6e0326\",\n \"email\": \"testcontact@live.com\",\n \"name\": \"Test Contact\",\n \"move_score\": 96.5,\n \"change\": \"decrease\",\n \"phone\": \"303-333-3333\",\n \"external_id\": \"abc123\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"created_at\": \"2020-03-27T23:43:13.544-06:00\",\n \"updated_at\": \"2020-04-16T13:44:26.122-06:00\"\n }\n```Pages are limited to 1,000 contacts per page with a default of 10. Use a 'page' query parameter to loop through additional pages. The \"change\" field can have a value of \"none\", \"increase\", or \"decrease\"."},"code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"cookie":[],"responseTime":null,"body":"[ { \"id\": \"587d299e547261777a880000\", \"event\": \"contact.ascend_80\", \"hook_url\": \"https://yoururl.com/hook-acsend-80\", \"created_at\": \"2017-01-16T13:14:20.153-07:00\", \"updated_at\": \"2017-01-16T13:14:20.153-07:00\" }, { \"id\": \"587d299e547261777a890000\", \"event\": \"contact.descend_80\", \"hook_url\": \"https://yoururl.com/hook-descend-80\", \"created_at\": \"2017-01-16T13:14:20.153-07:00\", \"updated_at\": \"2017-01-16T13:14:20.153-07:00\" }]"}],"_postman_id":"d6fcda11-3f1a-4436-99ad-700e90b4279f"},{"name":"Create a Subscription","id":"9f413732-dc68-4560-bfda-c3e65c4e3670","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"event\": \"contact.ascend_80\", \"hook_url\": \"https://yoururl.com/receive_hook\"}"},"url":"https://api.revaluate.com/v1/subscriptions","description":"

This is the webhook (Resthook) documentation section. Please read more about the Resthooks standard here.\nCurrently our list of supported events you can subscribe to are:

\n
    \n

  • contact.ascend_80 (occurs when a contact was previously below 80 and crosses above 80)

    \n
    • \n

  • contact.descend_80 (occurs when a contact was previously above 80 and crosses below 80)

    \n
    • \n
\n

When a webhook is triggered for a contact, the following data is POSTed to the provided hook URL:

\n

{ \"id\": \"5e7ae3f163053e73af6e0326\", \"email\": \"testcontact@live.com\", \"name\": \"Test Contact\", \"move_score\": 96.5, \"change\": \"decrease\", \"phone\": \"303-333-3333\", \"external_id\": \"abc123\", \"tags\": [ \"tag1\", \"tag2\" ], \"created_at\": \"2020-03-27T23:43:13.544-06:00\", \"updated_at\": \"2020-04-16T13:44:26.122-06:00\" }To subscribe to an event, you first need to create a new Subscription.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"e535893d-37e5-4347-ac41-a4ba280d82ec","id":"e535893d-37e5-4347-ac41-a4ba280d82ec","name":"Revaluate API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","subscriptions"],"host":["api","revaluate","com"],"query":[],"variable":[]}},"response":[{"id":"fe5db3e0-504f-4661-9e85-191047d3f94b","name":"Response_201","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"event\": \"contact.ascend_80\", \"hook_url\": \"https://yoururl.com/receive_hook\"}"},"url":"https://api.revaluate.com/v1/subscriptions","description":"This is the webhook (Resthook) documentation section. Please read more about the Resthooks standard [here](https://resthooks.org/docs/).\nCurrently our list of supported events you can subscribe to are:\n\n* contact.ascend_80 \\(occurs when a contact was previously below 80 and crosses above 80\\)\n\n* contact.descend_80 \\(occurs when a contact was previously above 80 and crosses below 80\\)\n\nWhen a webhook is triggered for a contact, the following data is POSTed to the provided hook URL:\n\n```\n {\n \"id\": \"5e7ae3f163053e73af6e0326\",\n \"email\": \"testcontact@live.com\",\n \"name\": \"Test Contact\",\n \"move_score\": 96.5,\n \"change\": \"decrease\",\n \"phone\": \"303-333-3333\",\n \"external_id\": \"abc123\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"created_at\": \"2020-03-27T23:43:13.544-06:00\",\n \"updated_at\": \"2020-04-16T13:44:26.122-06:00\"\n }\n```To subscribe to an event, you first need to create a new Subscription."},"code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"cookie":[],"responseTime":null,"body":"{ \"id\": \"587d2851547261777a200000\", \"event\": \"contact.ascend_80\", \"hook_url\": \"https://yoururl.com/receive_hook\", \"created_at\": \"2017-01-16T13:14:20.153-07:00\", \"updated_at\": \"2017-01-16T13:14:20.153-07:00\"}"}],"_postman_id":"9f413732-dc68-4560-bfda-c3e65c4e3670"},{"name":"Retrieve a Subscription","id":"bbc60800-e12e-4568-ae9d-8fda63e6e83d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"https://api.revaluate.com/v1/subscriptions/:id","description":"

The Subscription object allows you retrieve, update, or destroy a single Subscription object with all its details.Returns details about a given subscription. ID is required and is returned from the CREATE endpoint.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"e535893d-37e5-4347-ac41-a4ba280d82ec","id":"e535893d-37e5-4347-ac41-a4ba280d82ec","name":"Revaluate API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","subscriptions",":id"],"host":["api","revaluate","com"],"query":[],"variable":[{"id":"7a09405c-ab92-4ba1-96f1-ab3e666d8138","description":{"content":"

ID of the Subscription.

\n","type":"text/plain"},"type":"any","value":"587d2851547261777a200000","key":"id"}]}},"response":[{"id":"2394b0d3-76f1-4735-b7ae-710bad5dd1eb","name":"Response_200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.revaluate.com/v1/subscriptions/:id","protocol":"https","host":["api","revaluate","com"],"path":["v1","subscriptions",":id"],"variable":[{"id":"7a09405c-ab92-4ba1-96f1-ab3e666d8138","key":"id","value":"587d2851547261777a200000","description":"`ID` of the Subscription."}]},"description":"The Subscription object allows you retrieve, update, or destroy a single Subscription object with all its details.Returns details about a given subscription. ID is required and is returned from the CREATE endpoint."},"code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"cookie":[],"responseTime":null,"body":"{ \"id\": \"587d2851547261777a200000\", \"event\": \"contact.ascend_80\", \"hook_url\": \"https://yoururl.com/receive_hook\", \"created_at\": \"2017-01-16T13:14:20.153-07:00\", \"updated_at\": \"2017-01-16T13:14:20.153-07:00\"}"}],"_postman_id":"bbc60800-e12e-4568-ae9d-8fda63e6e83d"},{"name":"Update a Subscription","id":"ecdcd296-2818-4409-98c0-f82cf9b06f19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"subscription\": { \"event\": \"contact.ascend_80\", \"hook_url\": \"https://yoururl.com/new_hook_ascend_80\" }}"},"url":"https://api.revaluate.com/v1/subscriptions/:id","description":"

The Subscription object allows you retrieve, update, or destroy a single Subscription object with all its details.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"e535893d-37e5-4347-ac41-a4ba280d82ec","id":"e535893d-37e5-4347-ac41-a4ba280d82ec","name":"Revaluate API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","subscriptions",":id"],"host":["api","revaluate","com"],"query":[],"variable":[{"id":"6e4f9461-b91a-4721-bbac-22da43bd491c","description":{"content":"

ID of the Subscription.

\n","type":"text/plain"},"type":"any","value":"587d2851547261777a200000","key":"id"}]}},"response":[{"id":"41c2f2fb-7fa4-46b9-a047-afd91ec967ad","name":"Response_200","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"subscription\": { \"event\": \"contact.ascend_80\", \"hook_url\": \"https://yoururl.com/new_hook_ascend_80\" }}"},"url":{"raw":"https://api.revaluate.com/v1/subscriptions/:id","protocol":"https","host":["api","revaluate","com"],"path":["v1","subscriptions",":id"],"variable":[{"id":"6e4f9461-b91a-4721-bbac-22da43bd491c","key":"id","value":"587d2851547261777a200000","description":"`ID` of the Subscription."}]},"description":"The Subscription object allows you retrieve, update, or destroy a single Subscription object with all its details."},"code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"cookie":[],"responseTime":null,"body":"{ \"id\": \"587d2851547261777a200000\", \"event\": \"contact.ascend_80\", \"hook_url\": \"https://yoururl.com/new_hook_ascend_80\" \"created_at\": \"2017-01-16T13:14:20.153-07:00\", \"updated_at\": \"2017-01-16T13:14:20.153-07:00\"}"}],"_postman_id":"ecdcd296-2818-4409-98c0-f82cf9b06f19"},{"name":"Remove a Subscription","id":"3ee6a0f1-c48f-4579-b70c-75310fcd48a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":""},"url":"https://api.revaluate.com/v1/subscriptions/:id","description":"

The Subscription object allows you retrieve, update, or destroy a single Subscription object with all its details.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"e535893d-37e5-4347-ac41-a4ba280d82ec","id":"e535893d-37e5-4347-ac41-a4ba280d82ec","name":"Revaluate API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","subscriptions",":id"],"host":["api","revaluate","com"],"query":[],"variable":[{"id":"41c6f2ac-b530-4de9-a7da-955075298a62","description":{"content":"

ID of the Subscription.

\n","type":"text/plain"},"type":"any","value":"587d2851547261777a200000","key":"id"}]}},"response":[{"id":"99a516fa-412a-4dc9-95ba-84cb45c9a263","name":"Response_204","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.revaluate.com/v1/subscriptions/:id","protocol":"https","host":["api","revaluate","com"],"path":["v1","subscriptions",":id"],"variable":[{"id":"41c6f2ac-b530-4de9-a7da-955075298a62","key":"id","value":"587d2851547261777a200000","description":"`ID` of the Subscription."}]},"description":"The Subscription object allows you retrieve, update, or destroy a single Subscription object with all its details."},"code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3ee6a0f1-c48f-4579-b70c-75310fcd48a3"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]}}}