Customer
An example of a Bank Object
{"id": "cc15e9a7-21bf-4d55-b500-2a24c8e4ed1e","customer_name": "Tom Jones","email": "tom@felloh.org","address_1": "The Old Rectory","address_2": "Main Road","city": "Belton","county": "Lincolnshire","country": "United Kingdom","post_code": "NG32 2LW"}
idinteger
The unique identifier of the entry
customer_namestring
The name of the customer
emailstring
The email address of the customer
address_1string
The first line of the customers address.
address_2string
The second line of the customers address.
citystring
The city of the customer.
countystring
The county of the customer address.
countrystring
The ISO 3166-1 country code of the customer.
post_codestring
The postal code of the customer.
Create one
PUT/agent/customers/
import axios from 'axios';const response = await axios({method: 'put',url: `https://api.felloh.com/agent/customers`,data : JSON.stringify({organisation: 'X9876',customer_name: 'Tom Jones',email: 'tom@felloh.com',address_1: 'The Old Rectory',address_2: 'Main Road',city: 'Belton',county: 'Lincolnshire',country: 'United Kingdom',post_code: 'NG32 2LW'}),headers: {'Content-Type': 'application/json',Authorization: `Bearer <YOUR TOKEN HERE>`,},});
RESPONSE
{"data": {"id": "226009ab-ffe9-4c80-922b-982e8e7849f8"},"errors": {},"meta": {"code": 200,"reason": "OK","message": "The request was successful","request_id": "cdd40f5c-9d82-44c2-92e3-b5d2cad364f6"}}
This endpoint allows you to create a new customer
HTTP Method
PUT
HTTP Endpoint
PRODhttps://api.felloh.com/agent/customers
SANDBOXhttps://sandbox.felloh.com/agent/customers
Payload
Parameter | Required | Type | Description |
---|---|---|---|
organisation | true | string | The organisation ID that you want to create the customer for |
customer_name | false | string | The name of the customer |
false | string | The customers email address | |
address_1 | false | date | The first line of the customers address |
address_2 | false | date | The second line of the customers address |
city | false | Integer | The city of the customer |
county | false | Integer | The county of the customer |
country | false | String | The ISO 3166-1 country code of the customer |
post_code | false | String | The postal code of the customer |
Response
Parameter | Type | Description |
---|---|---|
id | UUID | The ID of the customer that you have created |