Create Location

post

https://api.fidel.uk/v1/programs/{programId}/locations

Creating a location requires a programId, brandId, and address details. Optionally, you can add merchantIDs.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

programId

string

required

The program you wish to add the location to.

Body Params

address

string

required

2 - 100 characters.

brandId

string

required

city

string

required

2 - 100 characters.

countryCode

string

required

allowedValues":["CAN","DNK","FIN","GBR","IRL","JPN","NOR","SWE","USA"]

postcode

string

required

4 - 20 characters.

stateCode

string

(Only for USA locations) 2-letter US state code from the ANSI standard INCITS 38:2009

searchBy

object

searchBy object, containing a merchantIds object with three keys, amex, visa and mastercard. These three keys have arrays of strings as values. The searchBy field is a means by which customers can associate a MID with a location if they already know it.

metadata

object

Metadata object with custom key value pairs. Object size limited to 2kb.

status

string

Defaults to syncing

Optional parameter that can be set to "syncing" if locations should auto sync on creations in a program. Only works in the live environment, all test environment locations are active (synced) by default.

Headers

Content-Type

string

required

application/json

Fidel-Key

string

test/live API secret key.

Responses

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

201201

400400