Methods

  • get - Get contact detail
  • patch - Patch contact

Resource

{
    "<key>": "string",
    "_averagePurchasesAmount": "number",
    "_birthdate": "date-time",
    "_createdAt": "date-time",
    "_email": "email",
    "_emailBouncedReason": "string",
    "_emailLastBouncedDate": "date-time",
    "_emailLastSoftBounceDate": "date-time",
    "_emailLastUnsubscribedDate": "date-time",
    "_emailLastUnsubscribedIp": "ip",
    "_emailSoftBounces": "integer",
    "_emailStatus": "string",
    "_firstPurchaseDate": "date-time",
    "_frequency": "string",
    "_hasPushSubscriptions": "boolean",
    "_isAnonymous": "boolean",
    "_lastPurchaseDate": "date-time",
    "_mobilePhone": "international",
    "_mobilePhoneStatus": "string",
    "_monetary": "string",
    "_name": "string",
    "_newsletterSubscriptionStatus": "string",
    "_points": "integer",
    "_recency": "string",
    "_rfm": "string",
    "_smsSubscriptionStatus": "string",
    "_surname": "string",
    "_totalPurchases": "integer",
    "_totalPurchasesAmount": "number",
    "_updatedAt": "date-time",
    "id": "string"
}

Properties

Name Type Description Additional
<key> map of string

A custom field created in Connectif. The key must be the custom field id and the value must be of the appropiate type: string for 'text', 'email', 'date', 'radio' and 'phone' fields; boolean for 'boolean' fields; number for 'decimal' fields; 'integer' for integer fields and an array of string for 'checkbox' fields.

Optional
_averagePurchasesAmount number

Average amount of the registered contact purchases.

_birthdate date-time

Birthdate of the contact in ISO8601 format.

Optional
_createdAt date-time

The date of creation of the contact in ISO8601 format.

_email email

The email that identifies the contact.

_emailBouncedReason string

Description of the reason why the last bounced email sent to the contact was bounced.

Optional
_emailLastBouncedDate date-time

The date of the last time an email sent to the contact was hard-bounced in ISO8601 format.

Optional
_emailLastSoftBounceDate date-time

The date of the last time an email sent to the contact was soft-bounced in ISO8601 format.

Optional
_emailLastUnsubscribedDate date-time

The date of the last time the contact unsubscribed from email newsletter in ISO8601 format.

Optional
_emailLastUnsubscribedIp ip

The IP address from which the contact unsubscribed to the email newsletter for the last time.

Optional
_emailSoftBounces integer

How many soft bounces have happened when sending emails to the contact.

Optional
_emailStatus string

Status of the email address of the contact: active (email address is valid and can receive emails), bounced, paused or banned.

Possible values are:

  • active
  • bounced
  • paused
  • banned
_firstPurchaseDate date-time

The date of the first time a purchase of the contact was registered in ISO8601 format.

Optional
_frequency string

RFM - Frequency value.

Possible values are:

  • 1
  • 2
  • 3
  • 4
  • 5
Optional
_hasPushSubscriptions boolean

Whether the contact has at least 1 push subscription or not.

_isAnonymous boolean

Whether the contact has an email address or not.

_lastPurchaseDate date-time

The date of the last time a purchase of the contact was registered in ISO8601 format.

Optional
_mobilePhone international

The phone number of the contact in international format.

Optional
_mobilePhoneStatus string

Status of the phone number of the contact: active (phone number is valid and can receive SMS), bounced or paused.

Possible values are:

  • active
  • bounced
  • paused
_monetary string

RFM - Monetary value.

Possible values are:

  • 1
  • 2
  • 3
  • 4
  • 5
Optional
_name string

The name of the contact.

Optional
_newsletterSubscriptionStatus string

Status of subscription of the contact to the email newsletter: subscribed, unsubscribed or none (not specified yet).

Possible values are:

  • subscribed
  • unsubscribed
  • none
_points integer

The score of the contact.

_recency string

RFM - Recency value.

Possible values are:

  • 1
  • 2
  • 3
  • 4
  • 5
Optional
_rfm string

RFM - Segment.

Possible values are:

  • champions
  • loyal
  • potential-loyalist
  • new-customers
  • promising
  • need-attention
  • about-to-sleep
  • at-risk
  • cannot-lose-them
  • hibernating-customers
  • lost-customers
Optional
_smsSubscriptionStatus string

Status of subscription of the contact to the SMS newsletter: subscribed, unsubscribed or none (not specified yet).

Possible values are:

  • subscribed
  • unsubscribed
  • none
_surname string

The surname of the contact.

Optional
_totalPurchases integer

How many purchases of the contact have been registered.

_totalPurchasesAmount number

Total amount of the registered contact purchases.

_updatedAt date-time

The date of last update of the contact in ISO8601 format.

Optional
id string

The tracker id of the contact.