Skip to content

Ramp: Location schemas

4 Ramp schemas with complete fields and constraints.

← Location operations · All schemas

Create a location — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
entity_idstringOptionalIdentifier of the business entity this location belongs to.
Format: uuid
namestringRequired within parentName of the location.

Fetch a location — response body

FieldTypePresenceDescription and constraints
$objectRoot
entity_idstringRequired within parentIdentifier of the business entity this location belongs to.
Format: uuid
idstringRequired within parentUnique identifier for the location.
Format: uuid
namestringRequired within parentName of the location.

List locations — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Fetch a location — response body
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: List bills — response body — page, Fetch a location — response body

Update a location — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
entity_idstringOptionalUpdated identifier of the business entity this location belongs to. Existing users assigned to this location will also be moved to the updated entity.
Format: uuid
namestringRequired within parentUpdated name of the location.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.