Create Contact

Options

Body

Values to create a contact

Request body which must comply to the following JSON Schema:

{
  "type" : "object",
  "properties" : {
    "email" : {
      "type" : "string",
      "description" : "Email address of the user. **Mandatory if \"SMS\" field is not passed in \"attributes\" parameter**. Mobile Number in **SMS** field should be passed with proper country code. For example:\n**{\"SMS\":\"+91xxxxxxxxxx\"}** or **{\"SMS\":\"0091xxxxxxxxxx\"}**\n",
      "format" : "email",
      "example" : "elly@example.com"
    },
    "ext_id" : {
      "type" : "string",
      "description" : "Pass your own Id to create a contact.",
      "example" : "externalId"
    },
    "attributes" : {
      "type" : "object",
      "additionalProperties" : {
        "oneOf" : [ {
          "type" : "number"
        }, {
          "type" : "string"
        }, {
          "type" : "boolean"
        }, {
          "type" : "array",
          "items" : {
            "type" : "string"
          }
        } ]
      },
      "description" : "Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored. **These attributes must be present in your Brevo account.**. For eg:\n**{\"FNAME\":\"Elly\", \"LNAME\":\"Roger\", \"COUNTRIES\":[\"India\",\"China\"]}**\n",
      "example" : {
        "FNAME" : "Elly",
        "LNAME" : "Roger",
        "COUNTRIES" : [ "India", "China" ]
      }
    },
    "emailBlacklisted" : {
      "type" : "boolean",
      "description" : "Set this field to blacklist the contact for emails (emailBlacklisted = true)",
      "example" : false
    },
    "smsBlacklisted" : {
      "type" : "boolean",
      "description" : "Set this field to blacklist the contact for SMS (smsBlacklisted = true)",
      "example" : false
    },
    "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" : 36
      }
    },
    "updateEnabled" : {
      "type" : "boolean",
      "description" : "Facilitate to update the existing contact in the same request (updateEnabled = true)",
      "example" : false,
      "default" : false
    },
    "smtpBlacklistSender" : {
      "type" : "array",
      "description" : "transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true )",
      "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:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers