Note objects

You can use the Spaaza API to manage any notes attached to a given user. This can be used to provide useful details about a user’s purchase habits, or any other generic notes that neeed to be saved for a user.

Fields in the Note object

The following fields are returned in the note object.

Identifying a note

Details for a note

Viewing user notes

User notes do not currently have their own API endpoint for fetching data. They can be fetched as part of the user get-card api call

Adding a note to a user

Example response

{
  "id": 123456,
  "text": "Customer very happy with her latest dress purchase.",
  "created_date": "2017-07-03T11:56:04Z",
  "user_id": 123123,
  "creating_user_id": 321321
}

Overview

• Call name: add-user-note
• Endpoint URL: https://api0.spaaza.com/internal/add-user-note
• Request methods: POST
• Request Content-Type: multipart/form-data or application/x-www-form-urlencoded
• Response Content-Type: application/json
• Auth required: yes
• X-Spaaza-MyPrice-App-Hostname header requirement: mandatory when using privileged authentication

Introduction

This API call adds a new note record to an existing user.

HTTP parameters

The following HTTP parameters can be passed to the API:

Deleting a user note

Example response

{
  "id": 123456,
  "deleted": true
}

Overview

• Call name: delete-user-note
• Endpoint URL: https://api0.spaaza.com/internal/delete-user-note
• Request methods: DELETE
• Request Content-Type: multipart/form-data or application/x-www-form-urlencoded
• Response Content-Type: application/json
• Auth required: yes
• X-Spaaza-MyPrice-App-Hostname header requirement: mandatory when using privileged authentication

Introduction

This API call deletes a user’s note record.

HTTP parameters

The following HTTP parameters can be passed to the API: