Accounts

My account

GET /accounts/me

Return current user account information. This is often used to validate authentication.

Parameters

Name	In	Type	Required	Description
x-api-key	header	string	true	API Authentication Key

Example responses

{
  "id": "string",
  "name": "string",
  "email": "user@example.com",
  "phone": "string",
  "is_active": true,
  "is_suspended": true,
  "last_login": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "company": {
    "name": "string",
    "email": "user@example.com",
    "phone": "string"
  },
  "billing": {
    "parent_account": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	A user object	AccountDetailsResponse
400	Bad Request	An error message	ErrorResponse

Code samples

"""
Python Code Snippet
"""
import requests

headers = {
  'Accept': 'application/json',
  'x-api-key': 'string'
}

r = requests.get('https://data.autohost.ai/v1/accounts/me', headers=headers)

print(r.json())

/*
TypeScript Code Snippet
*/

import fetch from 'node-fetch';

const headers = {
  'Accept':'application/json',
  'x-api-key':'string'
};

const response = await fetch('https://data.autohost.ai/v1/accounts/me', {
  method: 'get',
  
  headers,
});
const responseJson = await response.json();
console.log(responseJson);

Reseller accounts list

GET /accounts/children

Paginated list of user accounts belonging to a reseller profile.

Parameters

Name	In	Type	Required	Description
from	query	number	false	Pagination control
size	query	number	false	Number of items to return
x-api-key	header	string	true	API Authentication Key

Example responses

{
  "from": 0,
  "size": 0,
  "total": 0,
  "items": [
    {
      "id": "string",
      "name": "string",
      "email": "user@example.com",
      "phone": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A list of account objects	AccountChildrenResponse
400	Bad Request	An error message	ErrorResponse

Code samples

"""
Python Code Snippet
"""
import requests

headers = {
  'Accept': 'application/json',
  'x-api-key': 'string'
}

r = requests.get('https://data.autohost.ai/v1/accounts/children', headers=headers)

print(r.json())

/*
TypeScript Code Snippet
*/

import fetch from 'node-fetch';

const headers = {
  'Accept':'application/json',
  'x-api-key':'string'
};

const response = await fetch('https://data.autohost.ai/v1/accounts/children', {
  method: 'get',
  
  headers,
});
const responseJson = await response.json();
console.log(responseJson);

Delete API key

DELETE /accounts/keys/{key}

Delete an existing API key.

Parameters

Name	In	Type	Required	Description
key	path	string	true	The API key ID
x-api-key	header	string	true	API Authentication Key

Example responses

{
  "message": "Key removed"
}

{
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Deletion success message	AccountApiKeyDeleteResponse
403	Forbidden	Unauthorized access	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse

Code samples

"""
Python Code Snippet
"""
import requests

headers = {
  'Accept': 'application/json',
  'x-api-key': 'string'
}

r = requests.delete('https://data.autohost.ai/v1/accounts/keys/{key}', headers=headers)

print(r.json())

/*
TypeScript Code Snippet
*/

import fetch from 'node-fetch';

const headers = {
  'Accept':'application/json',
  'x-api-key':'string'
};

const response = await fetch('https://data.autohost.ai/v1/accounts/keys/{key}', {
  method: 'delete',
  
  headers,
});
const responseJson = await response.json();
console.log(responseJson);

Reseller new account

POST /accounts/register

Register a new account under a channel profile. This is used by resellers and channel partners to create Autohost user accounts.

Parameters

Name	In	Type	Required	Description
x-api-key	header	string	true	API Authentication Key
body	body	AccountRegistrationRequest	false	JSON object with user account details

Body parameter

{
  "name": "string",
  "email": "user@example.com",
  "phone": "string",
  "password": "string",
  "company": {
    "name": "string",
    "email": "user@example.com",
    "phone": "string"
  }
}

Example responses

{
  "id": "string",
  "name": "string",
  "email": "user@example.com",
  "phone": "string",
  "is_active": true,
  "is_suspended": true,
  "last_login": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "company": {
    "name": "string",
    "email": "user@example.com",
    "phone": "string"
  },
  "billing": {
    "parent_account": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	A user object	AccountDetailsResponse
400	Bad Request	An error message	ErrorResponse

Code samples

"""
Python Code Snippet
"""
import requests

input_body = {
  "name": "string",
  "email": "user@example.com",
  "phone": "string",
  "password": "string",
  "company": {
    "name": "string",
    "email": "user@example.com",
    "phone": "string"
  }
}

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'x-api-key': 'string'
}

r = requests.post('https://data.autohost.ai/v1/accounts/register', json=input_body, headers=headers)

print(r.json())

/*
TypeScript Code Snippet
*/

import fetch from 'node-fetch';
const inputBody = {
  "name": "string",
  "email": "user@example.com",
  "phone": "string",
  "password": "string",
  "company": {
    "name": "string",
    "email": "user@example.com",
    "phone": "string"
  }
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'x-api-key':'string'
};

const response = await fetch('https://data.autohost.ai/v1/accounts/register', {
  method: 'post',
  body: JSON.stringify(inputBody),
  headers,
});
const responseJson = await response.json();
console.log(responseJson);

Reseller update account

PUT /accounts/{id}

Update a channel account. This is used by resellers and channel partners to update Autohost user accounts.

Parameters

Name	In	Type	Required	Description
id	path	string	true	Autohost user ID
suspended	query	string	false	Suspend or unsuspend the account
status	query	string	false	Enable or disable the account
x-api-key	header	string	true	API Authentication Key
body	body	AccountRegistrationRequest	false	JSON object with user account details

Enumerated Values

Parameter	Value
suspended	true
suspended	false
status	active
status	disabled

Body parameter

{
  "name": "string",
  "email": "user@example.com",
  "phone": "string",
  "password": "string",
  "company": {
    "name": "string",
    "email": "user@example.com",
    "phone": "string"
  }
}

Example responses

{
  "id": "string",
  "name": "string",
  "email": "user@example.com",
  "phone": "string",
  "is_active": true,
  "is_suspended": true,
  "last_login": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "company": {
    "name": "string",
    "email": "user@example.com",
    "phone": "string"
  },
  "billing": {
    "parent_account": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	User account object	AccountDetailsResponse
400	Bad Request	An error message	ErrorResponse

Code samples

"""
Python Code Snippet
"""
import requests

input_body = {
  "name": "string",
  "email": "user@example.com",
  "phone": "string",
  "password": "string",
  "company": {
    "name": "string",
    "email": "user@example.com",
    "phone": "string"
  }
}

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'x-api-key': 'string'
}

r = requests.put('https://data.autohost.ai/v1/accounts/{id}', json=input_body, headers=headers)

print(r.json())

/*
TypeScript Code Snippet
*/

import fetch from 'node-fetch';
const inputBody = {
  "name": "string",
  "email": "user@example.com",
  "phone": "string",
  "password": "string",
  "company": {
    "name": "string",
    "email": "user@example.com",
    "phone": "string"
  }
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'x-api-key':'string'
};

const response = await fetch('https://data.autohost.ai/v1/accounts/{id}', {
  method: 'put',
  body: JSON.stringify(inputBody),
  headers,
});
const responseJson = await response.json();
console.log(responseJson);

POST /accounts/signup

Generate a self-signup link for a given PMS. This is used by resellers and channel partners to create registration links they can send to their customers.

Name	In	Type	Required	Description
pms	query	QueryParamPMS	true	PMS integration name
redirect	query	string	false	URL to redirect to after signup
hidepw	query	string	false	Hide password screen during user signup
x-api-key	header	string	true	API Authentication Key

Enumerated Values

Parameter	Value
pms	api
pms	apaleo
pms	beds24
pms	booking
pms	cloudbeds
pms	guesty
pms	hostaway
pms	hostfully
pms	inforhms
pms	impala
pms	lavanda
pms	myvr
pms	opera
pms	smartbnb
pms	stayntouch
pms	streamline
pms	trackhs

Example responses

{
  "url": "http://example.com",
  "expiry": "2019-08-24T14:15:22Z"
}

Status	Meaning	Description	Schema
200	OK	A signup object	AccountSignupLinkResponse
400	Bad Request	An error message	ErrorResponse

Code samples

"""
Python Code Snippet
"""
import requests

headers = {
  'Accept': 'application/json',
  'x-api-key': 'string'
}

params = {
  'pms': 'api'
}

r = requests.post('https://data.autohost.ai/v1/accounts/signup', headers=headers, params=params)

print(r.json())

/*
TypeScript Code Snippet
*/

import fetch from 'node-fetch';

const headers = {
  'Accept':'application/json',
  'x-api-key':'string'
};

const response = await fetch('https://data.autohost.ai/v1/accounts/signup', {
  method: 'post',
  
  headers,
});
const responseJson = await response.json();
console.log(responseJson);

Account create webhook

POST /accounts/webhooks

Parameters

Name	In	Type	Required	Description
x-api-key	header	string	true	API Authentication Key
body	body	AccountWebhooksRequest	false	JSON object with webhook details

Body parameter

{
  "webhook_url": "http://example.com",
  "webhook_key": "guest_portal_webhook_url"
}

Example responses

{
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Webhooks object	AccountWebhooksResponse
400	Bad Request	An error message	ErrorResponse

Code samples

"""
Python Code Snippet
"""
import requests

input_body = {
  "webhook_url": "http://example.com",
  "webhook_key": "guest_portal_webhook_url"
}

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'x-api-key': 'string'
}

r = requests.post('https://data.autohost.ai/v1/accounts/webhooks', json=input_body, headers=headers)

print(r.json())

/*
TypeScript Code Snippet
*/

import fetch from 'node-fetch';
const inputBody = {
  "webhook_url": "http://example.com",
  "webhook_key": "guest_portal_webhook_url"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'x-api-key':'string'
};

const response = await fetch('https://data.autohost.ai/v1/accounts/webhooks', {
  method: 'post',
  body: JSON.stringify(inputBody),
  headers,
});
const responseJson = await response.json();
console.log(responseJson);

Account remove webhook

DELETE /accounts/webhooks

Delete an existing webhook. This is used by platforms such as Zapier to unregister webhooks.

Parameters

Name	In	Type	Required	Description
x-api-key	header	string	true	API Authentication Key
body	body	AccountWebhooksRequest	false	JSON object with webhook details

Body parameter

{
  "webhook_url": "http://example.com",
  "webhook_key": "guest_portal_webhook_url"
}

Example responses

{
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Webhooks object	AccountWebhooksResponse
400	Bad Request	An error message	ErrorResponse

Code samples

"""
Python Code Snippet
"""
import requests

input_body = {
  "webhook_url": "http://example.com",
  "webhook_key": "guest_portal_webhook_url"
}

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'x-api-key': 'string'
}

r = requests.delete('https://data.autohost.ai/v1/accounts/webhooks', json=input_body, headers=headers)

print(r.json())

/*
TypeScript Code Snippet
*/

import fetch from 'node-fetch';
const inputBody = {
  "webhook_url": "http://example.com",
  "webhook_key": "guest_portal_webhook_url"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'x-api-key':'string'
};

const response = await fetch('https://data.autohost.ai/v1/accounts/webhooks', {
  method: 'delete',
  body: JSON.stringify(inputBody),
  headers,
});
const responseJson = await response.json();
console.log(responseJson);

Retrieve account settings

GET /accounts/{id}/settings/guest-portal-screens/{key}

Fetch your own account settings, or another user's account settings if you have the necessary permissions.

Parameters

Name	In	Type	Required	Description
id	path	string	true	Autohost user ID (optional — defaults to the authenticated user)
key	path	string	true	Setting key
x-api-key	header	string	true	API Authentication Key

Example responses

{
  "config_key": "guest_portal_screens_for_repeat_guests",
  "config_data": [
    {
      "source": "MINT",
      "guest_portal_screens": {
        "AboutYou": "required",
        "PurposeOfStay": "disabled",
        "TimeInfoEdit": "disabled"
      }
    }
  ]
}

{
  "config_key": "guest_portal_screens_by_source",
  "config_data": [
    {
      "source": "Airbnb",
      "guest_portal_screens": {
        "BackgroundCheck": "disabled",
        "CreditCheck": "disabled",
        "IDVerification": "disabled"
      }
    }
  ]
}

{
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Settings object	AccountSettingsResponse
400	Bad Request	An error message	ErrorResponse

Code samples

"""
Python Code Snippet
"""
import requests

headers = {
  'Accept': 'application/json',
  'x-api-key': 'string'
}

r = requests.get('https://data.autohost.ai/v1/accounts/{id}/settings/guest-portal-screens/{key}', headers=headers)

print(r.json())

/*
TypeScript Code Snippet
*/

import fetch from 'node-fetch';

const headers = {
  'Accept':'application/json',
  'x-api-key':'string'
};

const response = await fetch('https://data.autohost.ai/v1/accounts/{id}/settings/guest-portal-screens/{key}', {
  method: 'get',
  
  headers,
});
const responseJson = await response.json();
console.log(responseJson);

Update usage agreement template settings

PUT /accounts/{id}/settings/usage-agreement

Save (merge) usage agreement template settings for your account. All top-level fields are optional — only provided fields are upserted. Channel accounts may update settings for child accounts by passing the target user ID in the path.

Parameters

Name	In	Type	Required	Description
id	path	string	true	Autohost user ID (optional — defaults to the authenticated user)
x-api-key	header	string	false	API Authentication Key
body	body	UsageAgreementSettingsRequest	false	Partial usage agreement settings to upsert

Body parameter

{
  "user": {
    "format": "html",
    "content": "<p>By checking in, you agree to our house rules and policies.</p>"
  }
}

Example responses

{
  "user": {
    "id": "user-123",
    "format": "html",
    "content": "<p>By checking in, you agree to our house rules and policies.</p>"
  },
  "sources": [
    {
      "name": "airbnb",
      "format": "html",
      "content": "<p>Airbnb-specific usage agreement terms.</p>"
    }
  ],
  "reservations": [
    {
      "id": "res-456",
      "format": "html",
      "content": "<p>Custom agreement for this reservation.</p>"
    }
  ],
  "listings": [
    {
      "id": "list-789",
      "format": "html",
      "content": "<p>Beachfront property agreement with pool access rules.</p>"
    }
  ]
}

{
  "user": {
    "id": "user-123",
    "format": "html",
    "content": "<p>Standard agreement for all guests.</p>"
  }
}

{
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Updated usage agreement settings	UsageAgreementSettingsResponse
400	Bad Request	An error message	ErrorResponse
403	Forbidden	Forbidden — not authorized to update this user's settings	ErrorResponse
404	Not Found	User not found	ErrorResponse

Code samples

"""
Python Code Snippet
"""
import requests

input_body = {
  "user": {
    "format": "html",
    "content": "<p>By checking in, you agree to our house rules and policies.</p>"
  }
}

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'x-api-key': 'string'
}

r = requests.put('https://data.autohost.ai/v1/accounts/{id}/settings/usage-agreement', json=input_body, headers=headers)

print(r.json())

/*
TypeScript Code Snippet
*/

import fetch from 'node-fetch';
const inputBody = {
  "user": {
    "format": "html",
    "content": "<p>By checking in, you agree to our house rules and policies.</p>"
  }
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'x-api-key':'string'
};

const response = await fetch('https://data.autohost.ai/v1/accounts/{id}/settings/usage-agreement', {
  method: 'put',
  body: JSON.stringify(inputBody),
  headers,
});
const responseJson = await response.json();
console.log(responseJson);

Schemas

AccountDetailsResponse

{
  "id": "string",
  "name": "string",
  "email": "user@example.com",
  "phone": "string",
  "is_active": true,
  "is_suspended": true,
  "last_login": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "company": {
    "name": "string",
    "email": "user@example.com",
    "phone": "string"
  },
  "billing": {
    "parent_account": "string"
  }
}

AccountDetailsResponse

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
email	string(email)	false	none	none
phone	string	false	none	none
is_active	boolean	false	none	none
is_suspended	boolean	false	none	none
last_login	string(date-time)	false	none	none
created_at	string(date-time)	false	none	none
company	object	false	none	none
» name	string	false	none	none
» email	string(email)	false	none	none
» phone	string	false	none	none
billing	object	false	none	none
» parent_account	string	false	none	none

ErrorResponse

{
  "error": "string"
}

ErrorResponse

Properties

Name	Type	Required	Restrictions	Description
error	string	false	none	none

AccountChildrenResponse

{
  "from": 0,
  "size": 0,
  "total": 0,
  "items": [
    {
      "id": "string",
      "name": "string",
      "email": "user@example.com",
      "phone": "string"
    }
  ]
}

AccountChildrenResponse

Properties

Name	Type	Required	Restrictions	Description
from	number	false	none	none
size	number	false	none	none
total	number	false	none	none
items	[object]	false	none	none
» id	string	false	none	none
» name	string	false	none	none
» email	string(email)	false	none	none
» phone	string	false	none	none

AccountApiKeysResponse

[
  {
    "user_id": "string",
    "user_name": "string",
    "value": "string",
    "description": "string",
    "sdk": true
  }
]

AccountApiKeysResponse

Properties

Name	Type	Required	Restrictions	Description
AccountApiKeysResponse	[object]	false	none	A list of API key objects for all children accounts
user_id	string	false	none	The user ID of the API key owner
user_name	string	false	none	The user name of the API key owner
value	string	false	none	The API key secret
description	string	false	none	User-controlled description of the API key
sdk	boolean	false	none	Whether this is an SDK API key

AccountApiKeyCreateRequest

{
  "description": "string",
  "sdk": false
}

AccountApiKeyCreateRequest

Properties

Name	Type	Required	Restrictions	Description
description	string	false	none	Description for the API key
sdk	boolean	false	none	Whether this is an SDK API key

AccountApiKeyResponse

{
  "id": "string",
  "name": "string",
  "description": "string",
  "value": "string",
  "enabled": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "sdk": true
}

AccountApiKeyResponse

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	The API key ID
name	string	false	none	The API key name
description	string	false	none	User-controlled description of the API key
value	string	false	none	The API key secret
enabled	boolean	false	none	Whether the API key is enabled
created_at	string(date-time)	false	none	The date and time the API key was created
updated_at	string(date-time)	false	none	The date and time the API key was last updated
sdk	boolean	false	none	Whether this is an SDK API key

AccountApiKeyUpdateRequest

{
  "description": "string"
}

AccountApiKeyUpdateRequest

Properties

Name	Type	Required	Restrictions	Description
description	string	true	none	New description for the API key

AccountApiKeyDeleteResponse

{
  "message": "string"
}

AccountApiKeyDeleteResponse

Properties

Name	Type	Required	Restrictions	Description
message	string	false	none	none

AccountRegistrationRequest

{
  "name": "string",
  "email": "user@example.com",
  "phone": "string",
  "password": "string",
  "company": {
    "name": "string",
    "email": "user@example.com",
    "phone": "string"
  }
}

AccountRegistrationRequest

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
email	string(email)	false	none	none
phone	string	false	none	none
password	string	false	none	none
company	object	false	none	none
» name	string	false	none	none
» email	string(email)	false	none	none
» phone	string	false	none	none

QueryParamPMS

"api"

QueryParamPMS

Properties

Name	Type	Required	Restrictions	Description
QueryParamPMS	string	false	none	PMS integration name. If supplied, the API will assume the path parameter `id` is a confirmation code.

Enumerated Values

Property	Value
QueryParamPMS	api
QueryParamPMS	apaleo
QueryParamPMS	beds24
QueryParamPMS	booking
QueryParamPMS	cloudbeds
QueryParamPMS	guesty
QueryParamPMS	hostaway
QueryParamPMS	hostfully
QueryParamPMS	inforhms
QueryParamPMS	impala
QueryParamPMS	lavanda
QueryParamPMS	myvr
QueryParamPMS	opera
QueryParamPMS	smartbnb
QueryParamPMS	stayntouch
QueryParamPMS	streamline
QueryParamPMS	trackhs

AccountSignupLinkResponse

{
  "url": "http://example.com",
  "expiry": "2019-08-24T14:15:22Z"
}

AccountSignupLinkResponse

Properties

Name	Type	Required	Restrictions	Description
url	string(uri)	false	none	none
expiry	string(date-time)	false	none	none

AccountWebhooksRequest

{
  "webhook_url": "http://example.com",
  "webhook_key": "guest_portal_webhook_url"
}

AccountWebhooksRequest

Properties

Name	Type	Required	Restrictions	Description
webhook_url	string(uri)	false	none	none
webhook_key	string	false	none	none

Enumerated Values

Property	Value
webhook_key	guest_portal_webhook_url
webhook_key	screening_webhook_url
webhook_key	stargate_webhook_url
webhook_key	reservation_webhook_url
webhook_key	listing_webhook_url
webhook_key	account_webhook_url

AccountWebhooksResponse

{
  "message": "string"
}

AccountWebhooksResponse

Properties

Name	Type	Required	Restrictions	Description
message	string	false	none	none

AccountSettingsRequest

{
  "config_key": "guest_portal_screens_for_repeat_guests",
  "config_data": [
    {
      "source": "string",
      "guest_portal_screens": {
        "AboutYou": "disabled",
        "AuthorityReporting": "disabled",
        "BuildingScreen": "disabled",
        "BackgroundCheck": "disabled",
        "CreditCheck": "disabled",
        "IDVerification": "disabled",
        "IDCollection": "disabled",
        "SecurityDeposit": "disabled",
        "UsageAgreement": "disabled",
        "Coronavirus": "disabled",
        "CustomScreen": "disabled",
        "FileUpload": "disabled",
        "GuestList": "disabled",
        "HouseRules": "disabled",
        "LongTerm": "disabled",
        "PurposeOfStay": "disabled",
        "TimeInfoEdit": "disabled",
        "SexOffendersAddon": "disabled",
        "SocialVerificationAddon": "disabled",
        "SanctionsSearchAddon": "disabled",
        "FraudDetectionAddon": "disabled",
        "AdverseMediaSearchAddon": "disabled"
      }
    }
  ]
}

AccountSettingsRequest

Properties

Name	Type	Required	Restrictions	Description
config_key	string	false	none	Configuration key
config_data	[any]	false	none	Configuration data for each source

Enumerated Values

Property	Value
config_key	guest_portal_screens_for_repeat_guests
config_key	guest_portal_screens_by_source

AccountSettingsResponse

{
  "config_key": "guest_portal_screens_for_repeat_guests",
  "config_data": {}
}

AccountSettingsResponse

Properties

Name	Type	Required	Restrictions	Description
config_key	string	false	none	Configuration key
config_data	object	false	none	Configuration data

Enumerated Values

Property	Value
config_key	guest_portal_screens_for_repeat_guests
config_key	guest_portal_screens_by_source

UsageAgreementSettingsResponse

{
  "user": {
    "id": "string",
    "format": "html",
    "content": "string"
  },
  "sources": [
    {
      "name": "string",
      "format": "html",
      "content": "string"
    }
  ],
  "reservations": [
    {
      "id": "string",
      "format": "html",
      "content": "string"
    }
  ],
  "listings": [
    {
      "id": "string",
      "format": "html",
      "content": "string"
    }
  ]
}

UsageAgreementSettingsResponse

Properties

Name	Type	Required	Restrictions	Description
user	object	false	none	User-level agreement template
» id	string	false	none	User ID
» format	string	false	none	none
» content	string	false	none	Template content
sources	[object]	false	none	Source-specific templates
» name	string	false	none	Source name
» format	string	false	none	none
» content	string	false	none	Template content
reservations	[object]	false	none	Reservation-level template overrides (at most one element)
» id	string	false	none	Reservation ID
» format	string	false	none	none
» content	string	false	none	Template content
listings	[object]	false	none	Listing-level template overrides (at most one element)
» id	string	false	none	Listing ID
» format	string	false	none	none
» content	string	false	none	Template content

Enumerated Values

Property	Value
format	html
format	markdown
format	html
format	markdown
format	html
format	markdown
format	html
format	markdown

UsageAgreementSettingsRequest

{
  "user": {
    "format": "html",
    "content": "stringstri"
  },
  "sources": [
    {
      "name": "string",
      "format": "html",
      "content": "stringstri"
    }
  ],
  "reservations": [
    {
      "id": "string",
      "format": "html",
      "content": "stringstri"
    }
  ],
  "listings": [
    {
      "id": "string",
      "format": "html",
      "content": "stringstri"
    }
  ]
}

UsageAgreementSettingsRequest

Properties

Name	Type	Required	Restrictions	Description
user	object	false	none	User-level agreement template
» format	string	false	none	Content format
» content	string	false	none	Template content (minimum 10 characters)
sources	[object]	false	none	Source-specific templates (upserted by name)
» name	string	true	none	Source name (e.g. airbnb, vrbo) — used as the upsert key
» format	string	false	none	none
» content	string	true	none	Template content (minimum 10 characters)
reservations	[object]	false	none	Reservation-level template overrides
» id	string	true	none	Reservation ID
» format	string	false	none	none
» content	string	true	none	Template content (minimum 10 characters)
listings	[object]	false	none	Listing-level template overrides
» id	string	true	none	Listing ID
» format	string	false	none	none
» content	string	true	none	Template content (minimum 10 characters)

Enumerated Values

Property	Value
format	html
format	markdown
format	html
format	markdown
format	html
format	markdown
format	html
format	markdown

Autohost

Talk to Sales

My account​

Parameters​

Example responses​

Responses​

Code samples​

Reseller accounts list​

Parameters​

Example responses​

Responses​

Code samples​

Delete API key​

Parameters​

Example responses​

Responses​

Code samples​

Reseller new account​

Parameters​

Body parameter​

Example responses​

Responses​

Code samples​

Reseller update account​

Parameters​

Enumerated Values​

Body parameter​

Example responses​

Responses​

Code samples​

Reseller signup link​

Parameters​

Enumerated Values​

Example responses​

Responses​

Code samples​

Account create webhook​

Parameters​

Body parameter​

Example responses​

Responses​

Code samples​

Account remove webhook​

Parameters​

Body parameter​

Example responses​

Responses​

Code samples​

Retrieve account settings​

Parameters​

Example responses​

Responses​

Code samples​

Update usage agreement template settings​

Parameters​

Body parameter​

Example responses​

Responses​

Code samples​

Schemas​

AccountDetailsResponse​

Properties​

ErrorResponse​

Properties​

AccountChildrenResponse​

Properties​

AccountApiKeysResponse​

Properties​

AccountApiKeyCreateRequest​

Properties​

AccountApiKeyResponse​

Properties​

AccountApiKeyUpdateRequest​

Properties​

AccountApiKeyDeleteResponse​

Properties​

AccountRegistrationRequest​

Properties​

QueryParamPMS​

Properties​

Enumerated Values​

AccountSignupLinkResponse​

My account

Parameters

Example responses

Responses

Code samples

Reseller accounts list

Parameters

Example responses

Responses

Code samples

Delete API key

Parameters

Example responses

Responses

Code samples

Reseller new account

Parameters

Body parameter

Example responses

Responses

Code samples

Reseller update account

Parameters

Enumerated Values

Body parameter

Example responses

Responses

Code samples

Reseller signup link

Parameters

Enumerated Values

Example responses

Responses

Code samples

Account create webhook

Parameters

Body parameter

Example responses

Responses

Code samples

Account remove webhook

Parameters

Body parameter

Example responses

Responses

Code samples

Retrieve account settings

Parameters

Example responses

Responses

Code samples

Update usage agreement template settings

Parameters

Body parameter

Example responses

Responses

Code samples

Schemas

AccountDetailsResponse

Properties

ErrorResponse

Properties

AccountChildrenResponse

Properties

AccountApiKeysResponse

Properties

AccountApiKeyCreateRequest

Properties

AccountApiKeyResponse

Properties

AccountApiKeyUpdateRequest

Properties

AccountApiKeyDeleteResponse

Properties

AccountRegistrationRequest

Properties

QueryParamPMS

Properties

Enumerated Values

AccountSignupLinkResponse