{"method":"GET","path":"https://api.revcent.com/v2/customer_portals/{customer_portal_id}","summary":"Get A Customer Portal","description":"Retrieve the details of a previously created customer portal using the customer portal ID.","operationId":"GetCustomerPortal","parameters":[{"in":"path","name":"customer_portal_id","description":"The customer portal ID.","required":true,"schema":{"type":"string","description":"A 20 character customer portal ID.","minLength":20,"maxLength":20}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"The API call response code, 1 = Success","type":"integer","enum":[1]}},"title":"APICallResponseInfo","type":"object","additionalProperties":false},{"type":"object","additionalProperties":false,"properties":{"created_date_unix":{"description":"The unix timestamp of when the item was created.","type":"integer","format":"unix-time"},"id":{"type":"string","description":"A 20 character customer portal ID.","minLength":20,"maxLength":20},"name":{"description":"The customer portal name.","type":"string"},"description":{"description":"The customer portal description.","type":"string"},"enabled":{"description":"Whether the customer portal is currently enabled.","type":"boolean"},"logo":{"description":"The customer portal logo URL. The logo will be displayed in the top left of the portal. We recommend using a transparent PNG image for best results.","type":"string"},"tracking_domain":{"type":"object","additionalProperties":false,"description":"The tracking domain settings for the customer portal. A tracking domain is required for a customer portal.","properties":{"id":{"type":"string","description":"A 20 character tracking domain ID.","minLength":20,"maxLength":20},"name":{"description":"The tracking domain name.","type":"string"},"domain_name":{"description":"The root tracking domain. This is the domain that will be used in the customer portal URLs and for the reCAPTCHA settings.","type":"string"}}},"recaptcha":{"description":"The reCAPTCHA settings to prevent bots from registering for the portal. This is required.","type":"object","additionalProperties":false,"properties":{"site_key":{"description":"The reCAPTCHA v2 'Im Not A Robot' site key for the domain associated with the tracking domain. Get a free one here: https://www.google.com/recaptcha/admin. Required.","type":"string"},"secret_key":{"description":"The reCAPTCHA v2 'Im Not A Robot' secret key for the domain associated with the tracking domain. Get a free one here: https://www.google.com/recaptcha/admin. Required.","type":"string"}}},"portal_urls":{"description":"The customer portal URLs. These are the URLs for the main portal page, registration page, login page, and account page. The URLs are based on the tracking domain root domain. You have the ability to embed the portal as an iframe in your own website with same domain, and the main URL can be used for the iframe source URL's for acccess to the various portal pages.","type":"object","additionalProperties":false,"properties":{"main":{"description":"The main customer portal URL. Use this URL if wishing to embed as an iframe on same domain.","type":"string"},"register":{"description":"The customer portal registration page URL.","type":"string"},"login":{"description":"The customer portal login page URL.","type":"string"},"account":{"description":"The customer portal account page URL.","type":"string"}}},"display_name":{"description":"The customer portal display name. This is what will be displayed to customers using the portal. If blank, portal name will be used.","type":"string"},"footer_html":{"description":"The customer portal footer HTML. This is where you can add custom text, links, and more to the footer of the customer portal.","type":"string"},"smtp_profile":{"type":"object","additionalProperties":false,"description":"The SMTP profile settings to use for the portal emails. This is required.","properties":{"id":{"type":"string","title":"SMTP Profile ID","description":"A 20 character SMTP Profile ID.","minLength":20,"maxLength":20},"name":{"description":"The SMTP profile name.","type":"string"}}},"customer_emails":{"type":"object","additionalProperties":false,"description":"Customize the portal emails for both registration confirmation and password reset. Each email type has its own options and template HTML. RevCent will send the emails to the customers' email address in question upon registration or password reset.","properties":{"customer_account_confirm_email":{"type":"object","additionalProperties":false,"description":"The customer account confirmation email settings.","properties":{"to_cc":{"type":"array","description":"An array of email addresses to CC on the customer account confirmation email.","items":{"type":"string","description":"The email address to CC."}},"to_bcc":{"type":"array","description":"An array of email addresses to BCC on the customer account confirmation email.","items":{"type":"string","description":"The email address to BCC."}},"from":{"type":"string","description":"The email address to use as the sender."},"from_name":{"type":"string","description":"The name to use as the sender."},"subject":{"type":"string","description":"The subject of the customer account confirmation email."},"html":{"description":"The customer account confirmation email template HTML. Make sure to place the {{email_code}} shortcode in your template HTML below. The customer will need the code to confirm their registration in the portal.","type":"string"}}},"customer_account_password_reset":{"type":"object","additionalProperties":false,"description":"The customer account password reset email settings.","properties":{"to_cc":{"type":"array","description":"An array of email addresses to CC on the customer account password reset email.","items":{"type":"string","description":"The email address to CC."}},"to_bcc":{"type":"array","description":"An array of email addresses to BCC on the customer account password reset email.","items":{"type":"string","description":"The email address to BCC."}},"from":{"type":"string","description":"The email address to use as the sender."},"from_name":{"type":"string","description":"The name to use as the sender."},"subject":{"type":"string","description":"The subject of the customer account password reset email."},"html":{"description":"The customer account password reset email template HTML. Important: Make sure to place the {{email_code}} shortcode in your template HTML. The customer will need the code to reset their password.","type":"string"}}}}},"customer_filters":{"type":"object","additionalProperties":false,"description":"The customer filters are used to determine which customers are able to access the customer portal. If no filters are set, all customers will be able to access the portal.","properties":{"campaign":{"type":"array","description":"An array of campaigns, used to allow customers associated with at least one of the campaign(s) to access the portal. Leave empty to not require campaign association.","items":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","title":"Campaign ID","description":"A 20 character campaign ID.","minLength":20,"maxLength":20},"name":{"description":"The campaign name.","type":"string"}}}},"third_party_shop":{"type":"array","description":"An array of third party shops, used to allow customers associated with at least one of the third party shops to access the portal. Leave empty to not require third party shop association.","items":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"A 20 character user shop ID.","minLength":20,"maxLength":20},"name":{"description":"The third party shop name.","type":"string"}}}}}},"customer_permissions":{"type":"object","additionalProperties":false,"description":"The customer permissions are used to determine what customers can do in the customer portal.","properties":{"contact_modify":{"type":"boolean","description":"Whether customers can modify their contact information in the portal."},"credit_card_add":{"type":"boolean","description":"Whether customers can add credit cards in the portal."},"credit_card_remove":{"type":"boolean","description":"Whether customers can remove credit cards in the portal."},"credit_card_set_default":{"type":"boolean","description":"Whether customers can set a default credit card in the portal."},"shipping_modify_ship_to":{"type":"boolean","description":"Whether customers can modify their shipping information in the portal."},"subscription_renew":{"type":"boolean","description":"Whether customers can renew their subscriptions in the portal."},"subscription_activate":{"type":"boolean","description":"Whether customers can re-activate their subscriptions in the portal."},"subscription_suspend":{"type":"boolean","description":"Whether customers can suspend their subscriptions in the portal."},"subscription_cancel":{"type":"boolean","description":"Whether customers can cancel their subscriptions in the portal."},"trial_expire":{"type":"boolean","description":"Whether customers can expire their trials in the portal."},"trial_cancel":{"type":"boolean","description":"Whether customers can cancel their trials in the portal."},"salvage_transaction_process":{"type":"boolean","description":"Whether customers can manually process salvage transactions in the portal."}}},"create_non_existing_customer":{"description":"Whether to allow a non-existing customer to register for the portal. Recommended set to false.","type":"boolean"},"create_non_existing_customer_campaign":{"description":"The campaign to use for non-existing customers who register through the customer portal when create_non_existing_customer is true.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","title":"Campaign ID","description":"A 20 character campaign ID.","minLength":20,"maxLength":20},"name":{"description":"The campaign name.","type":"string"}}},"updated_date_unix":{"description":"The unix timestamp of when the item was last updated.","type":"integer","format":"unix-time"}}}]}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","enum":[0]},"error_code":{"description":"The specific error code.","type":"string"},"message":{"description":"A human readable description of the error.","type":"string"},"result":{"description":"A description of the API call result.","type":"string"}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}