ContactPatch resource

Methods

Resource

{
    "<key>": "string",
    "_birthdate": "date-time",
    "_emailStatus": "string",
    "_mobilePhone": "international",
    "_mobilePhoneStatus": "string",
    "_name": "string",
    "_newsletterSubscriptionStatus": "string",
    "_points": "integer",
    "_smsSubscriptionStatus": "string",
    "_surname": "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
_birthdate date-time

Birthdate of the contact in ISO8601 format.

 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
 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
 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
 Optional
_points integer

The score of the contact.

 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
 Optional
_surname string

The surname of the contact.

 Optional