Add new customer member

POST /customers/{customer_id}/members

Request Structure

  • email: string, required
  • first_name: string, required
  • last_name: string, required
  • telephone_number: string
  • mobile_number: string

Example Request

POST /api/v1/customers/3/members/ HTTP/1.1
Host: tph.io
X-Token: c9c0a840-b5f1-4e0e-84da-e8a4eedfc63b
Content-Type: application/json

{
    "email":"customerstaff2@example.com",
    "first_name":"Customer Staff",
    "last_name":"Example Two"
}

Response Structure

  • success: bool
  • messages: string
  • data: object
    • data: object
      • id: int
      • first_name: string
      • last_name: string
      • email: string
      • telephone_number: string
      • mobile_number: string
      • is_active: true
      • is_enabled: true
      • last_login: string ("2020-12-31 00:00:00")
      • created_at: string ("2020-12-31 00:00:00+00:00")
      • roles: object
        • data: object
          • id: int
          • name: string

Example Response

{
  "success":true,
  "messages":"Member added to customer.",
  "data":{
    "data":{
      "id":15,
      "first_name":"Customer Staff",
      "last_name":"Example Two",
      "email":"customerstaff2@example.com",
      "telephone_number":null,
      "mobile_number":null,
      "is_active":false,
      "is_enabled":true,
      "last_login":null,
      "created_at":"2018-04-27T13:50:58+00:00",
      "roles":{
        "data":{
          "id":10,
          "name":"Reseller Customer - Company Staff"
        }
      }
    }
  }
}