invantive documentation
Foros de Soporte de InvantiveIniciar Sesión / Registrarse

Contacts: ActiveCampaign Contacts

Esta página aún no está disponible en tu idioma; se muestra la versión original.

popular insert update delete REST

  • Catalog: ActiveCampaign
  • Schema: V3
  • Primary Keys: id
  • Label: Contacts

Can retrieve data and change data using insert, update and delete.

API Source

  • Endpoint: /contacts

Performance Characteristics

Characteristic Value
Average access latency (ms) 321
Full scan rows per minute 12,000

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
exclude `` Exclude from the response the contact with the given ID.
formid `` Filter contacts associated with the given form.
in_group_lists `` Set this to 'true' in order to return only contacts that the current user has permissions to see.
listid `` Filter contacts associated with the given list.
segmentid `` Return only contacts that match a list segment (this param initially returns segment information, when it is run a second time it will return contacts that match the segment).
seriesid `` Filter contacts associated with the given automation.
status `` -1 = Any, 0 = Unconfirmed, 1 = Active, 2 = Unsubscribed, 3 = Bounced.
tag `` Filter contacts associated with the given tag.
waitid `` Filter by contacts in the wait queue of an automation block.

Table Columns

The columns of the table Contacts are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
adate datetime itgen_acn_adate writable
anonymized int64 Anonymized filters on the platform, writable, computed Whether the contact has been anonymised.
best_send_hour int64 Best Send Hour filters on the platform, writable, computed Hour of the day with the highest expected engagement.
bounced_date datetime Bounced Date writable
bounced_hard int64 Bounced Hard writable
bounced_soft int64 Bounced Soft writable
cdate datetime Created filters on the platform, writable, computed
created_by int64 Created by filters on the platform, writable, computed ID of the user that created the contact.
created_timestamp datetime Created filters on the platform, writable, computed Moment of creation in the time zone of the account.
created_utc_timestamp datetime Created UTC Timestamp filters on the platform, writable, computed Moment of creation in UTC.
deleted int64 Deleted writable
deleted_at datetime Deleted At filters on the platform, writable, computed Moment of deletion.
edate datetime itgen_acn_edate writable
email varchar2 Email Address filters on the platform, writable
email_domain varchar2 Email Domain writable
email_local varchar2 Email Local writable
firstName varchar2 First Name filters on the platform, writable
gravatar int64 Gravatar writable
hash varchar2 Hash writable
id int64 ID filters on the platform, writable, computed
ip int64 IP Address writable
lastName varchar2 Last Name filters on the platform, writable
last_click_date datetime Last Click Date filters on the platform, writable, computed Moment the contact last clicked a link.
last_mpp_open_date datetime Last Mpp Open Date filters on the platform, writable, computed Moment of the last open attributed to Apple Mail Privacy Protection.
last_open_date datetime Last Open Date filters on the platform, writable, computed Moment the contact last opened a message.
mpp_tracking int64 MPP Tracking filters on the platform, writable, computed Whether Apple Mail Privacy Protection was observed for this contact.
organization int64 Account filters on the platform, writable Deprecated. Do not use.
orgid int64 Organisation ID writable
orgname varchar2 Organisation Name filters on the platform, writable, computed Name of the account the contact belongs to.
phone varchar2 Phone filters on the platform, writable
rating_tstamp datetime Rating Date writable
segmentio_id int64 Segment ID writable
sentcnt int64 Sent Count writable
sms_consent int64 SMS Consent filters on the platform, writable, computed Consent status for SMS.
sms_consent_updated_at datetime SMS Consent Updated at filters on the platform, writable, computed Moment the SMS consent was last changed.
socialdata_lastcheck datetime Social Data Last Check writable
ua varchar2 User Agent writable
udate datetime Last Updated filters on the platform, writable, computed
updated_by int64 Updated by filters on the platform, writable, computed ID of the user that last changed the contact.
updated_timestamp datetime Updated filters on the platform, writable, computed Moment of last change in the time zone of the account.
updated_utc_timestamp datetime Updated UTC Timestamp filters on the platform, writable, computed Moment of last change in UTC.
whatsapp_id varchar2 Whatsapp ID filters on the platform, writable, computed WhatsApp identifier of the contact.
whatsapp_username varchar2 Whatsapp Username filters on the platform, writable, computed WhatsApp user name of the contact.

Sample Queries

--
-- List of contacts in ActiveCampaign. Use ContactWithCustomFieldValues to retrieve and/or update contact custom fields.
--
-- Table documentation: https://documentation.invantive.eu/2017R2/activecampaign-data-model/webhelp/activecampaign-connector-v3-contacts.html
--
select *
from   ActiveCampaign.V3.Contacts@acn
limit  100

Notas de la Versión

Cambios introducidos en cada versión en las tablas, columnas, atributos y capacidades del controlador:

Modificaciones de esta tabla, De 26.0 a 27.0

  • + anonymized (int64)
  • + best_send_hour (int64)
  • + created_by (int64)
  • + created_timestamp (datetime)
  • + created_utc_timestamp (datetime)
  • + deleted_at (datetime)
  • + last_click_date (datetime)
  • + last_mpp_open_date (datetime)
  • + last_open_date (datetime)
  • + mpp_tracking (int64)
  • + orgname (varchar2)
  • + sms_consent (int64)
  • + sms_consent_updated_at (datetime)
  • + updated_by (int64)
  • + updated_timestamp (datetime)

3 cambios más

  • + updated_utc_timestamp (datetime)
  • + whatsapp_id (varchar2)
  • + whatsapp_username (varchar2)

Todos los cambios del conductor, De 26.0 a 27.0