Connectif API

Patch a contact by email. If contact does not exists, it is created

Request

PATCH https://api.connectif.cloud/contacts/email/{email}

Path parameters

Parameter name	Value	Description	Additional
email	email	Email of the contact to be patched	Required

Request body

The request body takes a complete ContactPatchByEmail resource, containing the following writable properties:

{
    "_birthdate": "date-time",
    "_emailStatus": "string",
    "_externalId": "string",
    "_mobilePhone": "international",
    "_mobilePhoneStatus": "string",
    "_name": "string",
    "_newsletterSubscriptionStatus": "string",
    "_points": "integer",
    "_smsSubscriptionStatus": "string",
    "_surname": "string"
}

Properties

Name	Type	Description	Additional
_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
_externalId	string	The externalId of the contact.	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

Authorization

This request requires the use of one of following authorization methods: API key .

Response

The following HTTP status codes may be returned, optionally with a response resource.