Ramp: Location schemas
4 Ramp schemas with complete fields and constraints.
← Location operations · All schemas
Create a location — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entity_id | string | Optional | Identifier of the business entity this location belongs to. Format: uuid |
name | string | Required within parent | Name of the location. |
Fetch a location — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entity_id | string | Required within parent | Identifier of the business entity this location belongs to. Format: uuid |
id | string | Required within parent | Unique identifier for the location. Format: uuid |
name | string | Required within parent | Name of the location. |
List locations — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand Fetch a location — response body |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entity_id | string | Optional | Updated 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 |
name | string | Required within parent | Updated name of the location. |