Update an application

patch

https://api.revenuehq.dev/applications/{applicationID}

Update an application by setting the values provided in the request payload.

Any parameters not provided will remain unchanged.

While entitlements can be defined when an application is created, they are not modified in this endpoint. After an application is created, you can add an entitlement or delete an entitlement via dedicated API endpoints.

Authorized scopes:

owner
admin:full
admin:limited
application:update

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

applicationID

uuid

required

The id of the application.

Body Params

name

string

The name of the application.

subdomain

string

The unique subdomain under which landing pages will be available. If the subdomain is greatest-company, then landing pages will be available at greatest-company.myrevhq.com.

custom_domain

string

The custom domain under which landing pages will be available. If the custom domain is example.com, then landing pages will be available at example.com.

product_type

string

enum

The product type of the application. This is used to determine default ordering and presentation. For example, Apple Pay is prioritized on the checkout page for D2C, but not for B2B.

Allowed:

descriptor

string

The complete descriptor that appears on account statements.

post_signup_redirect

uri

Where to redirect an account after successful signup. The query parameter rhq_account will be appended to this URL. This short-lived token can then be verified via API to get a full Account object. This will allow your application to create its own internal object that is associated with the Revenue HQ account.

embedded_account_link_out

uri

The URL to redirect an account from within our standalone account management screen. The query parameter rhq_account will be appended to this URL. This short-lived token can then be verified via API to get the full Account object. This will let an individual move between our hosted account management and your system without needing to log in a second time.

terms_of_service

uri

The URL of the terms of service for the application. This will be linked to directly from the signup page.

privacy_policy

uri

The URL of the privacy policy for the application. This will be linked to directly from the signup page.

cancel_location

string

Descriptive location of where to cancel a subscription from within your web application. This will be referenced in the signup disclaimer, with a default value of "Account Settings".

gtm_container_id

string

The identifier of the Google Tag Manager container that should be embedded in all landing pages. This generally takes the form of GTM-XXXX.

timezone

string

The timezone for the application. This will impact things like daily reports (how many people signed up yesterday) as well as provide default conversions when interacting with offers via the web console.

email_config

object

Headers

REVHQ-Version

integer

Responses

401

Unauthorized

200Application updated successfully

400Bad request

415Unsupported media type

500Server error