Set customer property

curl --request POST \
  --url https://api.bizzyco.ai/v1/customers/{id}/properties \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "<string>",
  "key": "<string>",
  "definitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "label": "<string>",
  "sources": [
    {
      "url": "<string>",
      "title": "<string>"
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    value: '<string>',
    key: '<string>',
    definitionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    label: '<string>',
    sources: [{url: '<string>', title: '<string>'}]
  })
};

fetch('https://api.bizzyco.ai/v1/customers/{id}/properties', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.bizzyco.ai/v1/customers/{id}/properties"

payload = {
    "value": "<string>",
    "key": "<string>",
    "definitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "label": "<string>",
    "sources": [
        {
            "url": "<string>",
            "title": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bizzyco.ai/v1/customers/{id}/properties"

	payload := strings.NewReader("{\n  \"value\": \"<string>\",\n  \"key\": \"<string>\",\n  \"definitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"label\": \"<string>\",\n  \"sources\": [\n    {\n      \"url\": \"<string>\",\n      \"title\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "definitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "valueType": "text",
    "objectType": "contact",
    "objectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "valueText": "<string>",
    "valueNumber": "<string>",
    "valueBoolean": true,
    "valueDate": "2023-12-25",
    "valueTextList": [
      "<string>"
    ],
    "status": "suggested",
    "setByKind": "user",
    "setByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "setByAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sources": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "valueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "url": "<string>",
        "title": "<string>"
      }
    ],
    "suppressed": true
  },
  "meta": {
    "pagination": {
      "limit": 123,
      "offset": 123,
      "hasMore": true,
      "total": 123
    }
  }
}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "definitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "valueType": "text",
    "objectType": "contact",
    "objectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "valueText": "<string>",
    "valueNumber": "<string>",
    "valueBoolean": true,
    "valueDate": "2023-12-25",
    "valueTextList": [
      "<string>"
    ],
    "status": "suggested",
    "setByKind": "user",
    "setByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "setByAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sources": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "valueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "url": "<string>",
        "title": "<string>"
      }
    ],
    "suppressed": true
  },
  "meta": {
    "pagination": {
      "limit": 123,
      "offset": 123,
      "hasMore": true,
      "total": 123
    }
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>"
  }
}

Customers

Set customer property

Set a property value on the customer. Name the property by key — created on first use, with label and valueType as hints — or by definitionId. A confirmed value replaces the current one. With status: "suggested" the value is stored as a suggestion; a suggestion the customer already has is not stored twice, and one that was dismissed or matches the confirmed value is not stored at all: the response is 200 with suppressed: true and the value that suppressed it.

POST

customers

{id}

properties

Set customer property

curl --request POST \
  --url https://api.bizzyco.ai/v1/customers/{id}/properties \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "<string>",
  "key": "<string>",
  "definitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "label": "<string>",
  "sources": [
    {
      "url": "<string>",
      "title": "<string>"
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    value: '<string>',
    key: '<string>',
    definitionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    label: '<string>',
    sources: [{url: '<string>', title: '<string>'}]
  })
};

fetch('https://api.bizzyco.ai/v1/customers/{id}/properties', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.bizzyco.ai/v1/customers/{id}/properties"

payload = {
    "value": "<string>",
    "key": "<string>",
    "definitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "label": "<string>",
    "sources": [
        {
            "url": "<string>",
            "title": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bizzyco.ai/v1/customers/{id}/properties"

	payload := strings.NewReader("{\n  \"value\": \"<string>\",\n  \"key\": \"<string>\",\n  \"definitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"label\": \"<string>\",\n  \"sources\": [\n    {\n      \"url\": \"<string>\",\n      \"title\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "definitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "valueType": "text",
    "objectType": "contact",
    "objectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "valueText": "<string>",
    "valueNumber": "<string>",
    "valueBoolean": true,
    "valueDate": "2023-12-25",
    "valueTextList": [
      "<string>"
    ],
    "status": "suggested",
    "setByKind": "user",
    "setByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "setByAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sources": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "valueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "url": "<string>",
        "title": "<string>"
      }
    ],
    "suppressed": true
  },
  "meta": {
    "pagination": {
      "limit": 123,
      "offset": 123,
      "hasMore": true,
      "total": 123
    }
  }
}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "definitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "valueType": "text",
    "objectType": "contact",
    "objectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "valueText": "<string>",
    "valueNumber": "<string>",
    "valueBoolean": true,
    "valueDate": "2023-12-25",
    "valueTextList": [
      "<string>"
    ],
    "status": "suggested",
    "setByKind": "user",
    "setByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "setByAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sources": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "valueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "url": "<string>",
        "title": "<string>"
      }
    ],
    "suppressed": true
  },
  "meta": {
    "pagination": {
      "limit": 123,
      "offset": 123,
      "hasMore": true,
      "total": 123
    }
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

Authorization

string

header

required

API key authentication via Bearer token

Headers

idempotency-key

string

Key that makes this request safe to retry. Reuse the same value when retrying a request that may already have succeeded — the original response is replayed with an Idempotency-Replay: true header. Use a new value for a new operation.

Required string length: 1 - 255

Example:

"9f8c2b1a-4d3e-4a6b-8c1d-2e3f4a5b6c7d"

Path Parameters

string<uuid>

required

Customer UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json

value

required

key

string

Pattern: ^[a-z][a-z0-9_]{0,62}$

definitionId

string<uuid>

status

enum<string>

Available options:

confirmed,

suggested

label

string

Minimum string length: 1

valueType

enum<string>

Available options:

text,

number,

boolean,

date,

url,

select,

multi_select

sources

object[]

Show child attributes

Response

Nothing new was stored: the value already exists, or the suggestion was suppressed

data

object

required

Show child attributes

API Documentation

Agent resources

Automations

Businesses

Contacts

Customers

Domains

Email Templates

Files

Invoices

Invoice Line Items

Invoice Payments

Messages

Operations

Properties

Tasks

Set customer property

Authorizations

Headers

Path Parameters

Body

Response