Geophrase Business

Bulk Create

HTTP request

POST https://api.geophrase.com/business/geophrases-bulk-create/

Mind the trailing slash in the URL.

Example request

curl --location 'https://api.geophrase.com/business/geophrases-bulk-create/' \
--header 'X-API-Key: {API key}' \
--header 'Content-Type: application/json' \
--data '[
  {
    "latitude": 25.0000000000001,
    "longitude": 45.78473662999998,
    "address_line_one": "House no 49",
    "address_line_two": "Gulab Nagar Ln",
    "landmark": "Near Mukul Ram Store",
    "city": "New Delhi",
    "address_type": "HOME",
    "postal_code": 110001
  }
]'

Request headers

Header Name	Value
X-API-Key Required	{API key}
Content-Type Required	application/json

Request body

The request body contains JSON array in following format.

[
  {
    "latitude": 25.0000000000001,
    "longitude": 45.78473662999998,
    "address_line_one": "House no 49",
    "address_line_two": "Gulab Nagar Ln",
    "landmark": "Near Mukul Ram Store",
    "city": "New Delhi",
    "address_type": "HOME",
    "postal_code": 110001
  },
  ...
]

JSON array in the request body can contain up to 500 objects.

Field Name	Value
latitude Required	Number
longitude Required	Number
address_line_one Required	String
address_line_two Required	String
landmark Optional	String
city Required	String
address_type Required	String Allowed values are: HOME and WORK
postal_code Required	Number Must be a valid and real postal code

Response

Returns status code 201 and a JSON array of Geophrase instances.

In bulk create API response, URLs returned in qr_code field may take some time (typically less than a minute) to become available when you try to access the URLs.

Error response

Returns 4xx HTTP status code and an error response.

Status Code	Description
400	Consider these reasons: Empty array was passed. Array contains more than 500 Geophrases.
403	Consider these reasons: Missing or incorrect X-API-Key header Insufficient wallet balance Read-only API key cannot perform write operation.

Status Code

Description

400

Consider these reasons:

Empty array was passed.
Array contains more than 500 Geophrases.

403