Update Batch Contacts

Options

Body

Values to update multiple contacts

Request body which must comply to the following JSON Schema:

{
  "type" : "object",
  "properties" : {
    "contacts" : {
      "type" : "array",
      "description" : "List of contacts to be updated",
      "items" : {
        "type" : "object",
        "properties" : {
          "email" : {
            "type" : "string",
            "description" : "Email address of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms)",
            "format" : "email",
            "example" : "elly@example.com"
          },
          "id" : {
            "type" : "integer",
            "description" : "id of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms)",
            "format" : "int64",
            "example" : 31
          },
          "sms" : {
            "type" : "string",
            "description" : "SMS of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms)",
            "example" : "+91xxxxxxxxxx"
          },
          "ext_id" : {
            "type" : "string",
            "description" : "Pass your own Id to update ext_id of a contact.",
            "example" : "UpdateExternalId"
          },
          "attributes" : {
            "type" : "object",
            "additionalProperties" : { },
            "description" : "Pass the set of attributes to be updated. **These attributes must be present in your account**. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, **{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}**.\nKeep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in **SMS** field should be passed with proper country code. For example: **{\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"}**\n",
            "example" : {
              "EMAIL" : "newemail@domain.com",
              "FNAME" : "Ellie",
              "LNAME" : "Roger"
            }
          },
          "emailBlacklisted" : {
            "type" : "boolean",
            "description" : "Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true)",
            "example" : false
          },
          "smsBlacklisted" : {
            "type" : "boolean",
            "description" : "Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true)",
            "example" : true
          },
          "listIds" : {
            "type" : "array",
            "description" : "Ids of the lists to add the contact to",
            "items" : {
              "type" : "integer",
              "description" : "Id of the list to add the contact to",
              "format" : "int64",
              "example" : 65
            }
          },
          "unlinkListIds" : {
            "type" : "array",
            "description" : "Ids of the lists to remove the contact from",
            "items" : {
              "type" : "integer",
              "description" : "Id of the list to remove the contact from",
              "format" : "int64",
              "example" : 36
            }
          },
          "smtpBlacklistSender" : {
            "type" : "array",
            "description" : "transactional email forbidden sender for contact. Use only for email Contact",
            "items" : {
              "type" : "string",
              "format" : "email"
            }
          }
        }
      }
    }
  }
}

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Raw Response: Returns the raw response in a single row with the following columns:

• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers