Members

Adds or updates a member

Add or update the information hullo stores for a specific member. If the member doesn't already exist then
they will be added to the members store and an opt-in message will be sent to the number specified in order
to get confirmation that the number exists and wishes to receive messages. If the member responds with a
confirmation message ("yes") then their member record will be updated to opted-in and they will then be able
to receive messages sent to them from any hullo campaign. If the member already exists then their record will be updated to reflect any new / updated attribute data included in the call. If an attribute is specified but
no value is given or the value is null then that attribute will be deleted from the members record.

post/endpoints/members

Request

  • Base URL: https://app.hullo.me/api
  • URL: https://app.hullo.me/api/endpoints/members
  • Auth: API key in header X-API-KEY

Request body

registrationDatestring date-time

The date the member was registered

phoneNumberstring phone-number required

The phone number of the member

fullNamestring

The full name of the member as "<forename> <surname>"

attributesobject required

The attributes that describe the member

groupsstring[]

The list of groups this member belongs to

Example request

{
  "phoneNumber": "phoneNumber",
  "registrationDate": "2000-01-23T04:56:07.000+00:00",
  "fullName": "fullName",
  "groups": [
    "groups",
    "groups"
  ],
  "attributes": {
    "key": [
      "attributes",
      "attributes"
    ]
  }
}

Response

OK

registrationDatestring date-time

The date the member was registered

phoneNumberstring phone-number required

The phone number of the member

fullNamestring

The full name of the member as "<forename> <surname>"

attributesobject required

The attributes that describe the member

groupsstring[]

The list of groups this member belongs to

Example response

{
  "phoneNumber": "phoneNumber",
  "registrationDate": "2000-01-23T04:56:07.000+00:00",
  "fullName": "fullName",
  "groups": [
    "groups",
    "groups"
  ],
  "attributes": {
    "key": [
      "attributes",
      "attributes"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.