Create a contact

ip4 records the IPv4 address the contact opted in from, on the contact and on the list memberships this call creates. Only IPv4 is accepted.

Each lists entry may carry an sdate subscribe date and the mail subscribing should send: sendInstantAutoresponder, suppressInstantAutoresponder and sendLastCampaign. An entry only accepts those keys plus list, and asking for the autoresponders and their suppression at once is rejected.

form attributes the write to a form and inherits that form's behaviour: the lists it subscribes to (on top of the lists named here), its double opt-in confirmation — which leaves a membership it creates unconfirmed until the contact confirms — its actions and its submit automation trigger. A form ID that does not exist is rejected.

🚧

Organization-Related Nodes Have Been Deprecated

Contact-Organization relationships are now managed through Account-Contact end points

📘

Reference a custom field by id- not the custom field's name/title.

When writing to a Contact's custom data, the field must be the id of a previously-created custom field, not the custom field's name/title.

{
  "contact": {
    "email": "[email protected]",
    "allowNullEmail": true,
    "firstName": "John",
    "lastName": "Doe",
    "phone": "7223224241",
    "fieldValues": [
      {
        "field": "1",
        "value": "The Value for First Field"
      },
      {
        "field": "6",
        "value": "2008-01-20"
      }
    ],
    "tags": [
      "customer",
      "newsletter"
    ]
  }
}
{
      "fieldValues": [
        {
            "contact": "113",
            "field": "1",
            "value": "The Value for First Field",
            "cdate": "2020-08-01T10:54:59-05:00",
            "udate": "2020-08-01T14:13:34-05:00",
            "links": {
                "owner": "https://:account.api-us1.com/api/3/fieldValues/11797/owner",
                "field": "https://:account.api-us1.com/api/3/fieldValues/11797/field"
            },
            "id": "11797",
            "owner": "113"
        },
        {
            "contact": "113",
            "field": "6",
            "value": "2008-01-20",
            "cdate": "2020-08-01T10:54:59-05:00",
            "udate": "2020-08-01T14:13:34-05:00",
            "links": {
                "owner": "https://:account.api-us1.com/api/3/fieldValues/11798/owner",
                "field": "https://:account.api-us1.com/api/3/fieldValues/11798/field"
            },
            "id": "11798",
            "owner": "113"
        }
    ],
    "contact": {
        "email": "[email protected]",
        "cdate": "2018-09-28T13:50:41-05:00",
        "udate": "2018-09-28T13:50:41-05:00",
        "orgid": "",
        "links": {
            "bounceLogs": "https://:account.api-us1.com/api/:version/contacts/113/bounceLogs",
            "contactAutomations": "https://:account.api-us1.com/api/:version/contacts/113/contactAutomations",
            "contactData": "https://:account.api-us1.com/api/:version/contacts/113/contactData",
            "contactGoals": "https://:account.api-us1.com/api/:version/contacts/113/contactGoals",
            "contactLists": "https://:account.api-us1.com/api/:version/contacts/113/contactLists",
            "contactLogs": "https://:account.api-us1.com/api/:version/contacts/113/contactLogs",
            "contactTags": "https://:account.api-us1.com/api/:version/contacts/113/contactTags",
            "contactDeals": "https://:account.api-us1.com/api/:version/contacts/113/contactDeals",
            "deals": "https://:account.api-us1.com/api/:version/contacts/113/deals",
            "fieldValues": "https://:account.api-us1.com/api/:version/contacts/113/fieldValues",
            "geoIps": "https://:account.api-us1.com/api/:version/contacts/113/geoIps",
            "notes": "https://:account.api-us1.com/api/:version/contacts/113/notes",
            "organization": "https://:account.api-us1.com/api/:version/contacts/113/organization",
            "plusAppend": "https://:account.api-us1.com/api/:version/contacts/113/plusAppend",
            "trackingLogs": "https://:account.api-us1.com/api/:version/contacts/113/trackingLogs",
            "scoreValues": "https://:account.api-us1.com/api/:version/contacts/113/scoreValues"
        },
        "id": "113",
        "organization": ""
    }
}
Body Params
contact
object
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json