updateContact

Authentication

This operation does not declare an authentication requirement in the API contract.

Path parameters

NameTypeDescription

contact_idrequiredstring

Request body (required)

FieldTypeDescription

emailrequiredstring (email)

first_namestring

last_namestring

unsubscribedboolean

propertiesobject

segmentsarray

idrequiredstring

topicsarray

idrequiredstring

subscriptionrequiredunknown

Values: "opt_in", "opt_out".

Request examples

request.sh

bash

curl --request PATCH 'https://api.au.boundry.dev/contacts/string' \
+  -H 'Authorization: Bearer $BOUNDRY_API_KEY' \
+  -H 'Content-Type: application/json' \
+  --data '{"email":"string","first_name":"string","last_name":"string","unsubscribed":true,"segments":[{"id":"string"}],"topics":[{"id":"string","subscription":"opt_in"}]}'

import { Boundry } from "@boundry/sdk";

const boundry = new Boundry({ apiKey: process.env.BOUNDRY_API_KEY! });
const response = await boundry.updateContact({
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "unsubscribed": true,
  "segments": [
    {
      "id": "string"
    }
  ],
  "topics": [
    {
      "id": "string",
      "subscription": "opt_in"
    }
  ],
  "contact_id": "string"
});

from boundry import Boundry

boundry = Boundry(api_key="$BOUNDRY_API_KEY")
response = boundry.updateContact({
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "unsubscribed": true,
  "segments": [
    {
      "id": "string"
    }
  ],
  "topics": [
    {
      "id": "string",
      "subscription": "opt_in"
    }
  ],
  "contact_id": "string"
})

`200` response

Contact