Skip to content

Update a member

Request

This endpoint is used to update a member. It takes a member ID and uses your public API key to match the customer to your account. As of now, all fields in the update schema are required, so it is not possible to update a single field at a time.

Security
api_key
Path
idstringrequired

The customer ID number which you would like to update.

Bodyapplication/jsonrequired
firstNamestringrequired

The customer's first name.

lastNamestringrequired

The customer's last name.

notesstringrequired

Internal notes for this customer. Only viewable by the merchant.

phoneNumberstringrequired

The customer's phone number.

birthdaystringrequired

The customer's date of birth in YYYY-MM-DD format, e.g "1988-04-01"

curl -i -X PATCH \
  'https://public.inveterateapi.com/v2.0/admin/members/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-Inveterate-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "firstName": "string",
    "lastName": "string",
    "notes": "string",
    "phoneNumber": "string",
    "birthday": "string"
  }'

Responses

Returned upon successful request made to our backend. Requests that return this code may take a small amount of time after successful API return to fully update.

Bodyapplication/json
messagestringrequired

The message associated with the response. Generally, the message only confirms the requested action. In the case of errors, the message will give insight into the source of the error.

dataobjectrequired

The data associated with the response. Data is only returned from errors if the error originates from our backend to give further insight into the nature of the error.

Response
{
  "message": "Request sent successfully",
  "data": {
    "id": 1,
    "name": "John Doe"
  }
}