Skip to main content
POST
/
api
/
resources
/
locations
Create Location Resource
curl --request POST \
  --url https://api.embedreach.com/api/resources/locations \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "locationId": "<string>",
    "name": "<string>",
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipCode": "<string>",
    "address2": "<string>",
    "address3": "<string>"
  }
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "schema_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "schemaDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "platformId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "resource_external_id": "<string>",
    "resourceExternalId": "<string>",
    "created_at": "<string>",
    "createdAt": "<string>",
    "updated_at": "<string>",
    "updatedAt": "<string>",
    "data": {
      "locationId": "<string>",
      "name": "<string>",
      "address": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>",
      "address2": "<string>",
      "address3": "<string>"
    }
  }
}

Headers

​
reach-tenant-id
string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Query Parameters

​
onconflict
enum<string>
default:upsert

What to do if the resource already exists. upsert will merge new data with existing data (PATCH-like behavior), preserving existing fields not included in the request. Null values will delete fields. reject will throw an error if the resource already exists

Available options:
upsert,
reject
​
ignoreUnknownFields
boolean | null
default:false

Whether to allow extra fields that are not defined in the schema. If true, extra fields will be accepted but not saved. If false, requests with extra fields will be rejected.

Body

application/json
​
data
object
required

Default Location Resource

Response

Status 200 response

​
success
boolean
required
​
message
string
​
data
object