Skip to main content
POST
/
v1
/
accounts
/
{accountId}
/
attributes
/
{attributeType}
Setup autotopup for your account
curl --request POST \
  --url https://api.sakari.io/v1/accounts/{accountId}/attributes/{attributeType} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "chris@sakari.io",
  "firstName": "Chris",
  "lastName": "Bloggs",
  "lists": [
    {
      "name": "<string>",
      "keyword": "<string>",
      "doubleOptIn": {
        "enabled": true,
        "prompt": "<string>"
      },
      "filter": {
        "q": "<string>",
        "attributes": [
          {
            "attribute": "<string>",
            "comparator": "<string>",
            "value": [
              "<string>"
            ]
          }
        ],
        "list": "<string>",
        "valid": true,
        "invalid": true,
        "blocked": true,
        "unblocked": true,
        "optIn": true
      },
      "optInConfirmation": "<string>",
      "optIn": "2023-11-07T05:31:56Z",
      "optOut": "2023-11-07T05:31:56Z"
    }
  ],
  "attributes": {},
  "optIn": "2023-11-07T05:31:56Z",
  "blocked": "2023-11-07T05:31:56Z",
  "activecampaign": {
    "id": 123
  },
  "hubspot": {
    "id": 123
  },
  "pipedrive": {
    "id": 123
  }
}
'
import requests

url = "https://api.sakari.io/v1/accounts/{accountId}/attributes/{attributeType}"

payload = {
    "email": "chris@sakari.io",
    "firstName": "Chris",
    "lastName": "Bloggs",
    "lists": [
        {
            "name": "<string>",
            "keyword": "<string>",
            "doubleOptIn": {
                "enabled": True,
                "prompt": "<string>"
            },
            "filter": {
                "q": "<string>",
                "attributes": [
                    {
                        "attribute": "<string>",
                        "comparator": "<string>",
                        "value": ["<string>"]
                    }
                ],
                "list": "<string>",
                "valid": True,
                "invalid": True,
                "blocked": True,
                "unblocked": True,
                "optIn": True
            },
            "optInConfirmation": "<string>",
            "optIn": "2023-11-07T05:31:56Z",
            "optOut": "2023-11-07T05:31:56Z"
        }
    ],
    "attributes": {},
    "optIn": "2023-11-07T05:31:56Z",
    "blocked": "2023-11-07T05:31:56Z",
    "activecampaign": { "id": 123 },
    "hubspot": { "id": 123 },
    "pipedrive": { "id": 123 }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'chris@sakari.io',
    firstName: 'Chris',
    lastName: 'Bloggs',
    lists: [
      {
        name: '<string>',
        keyword: '<string>',
        doubleOptIn: {enabled: true, prompt: '<string>'},
        filter: {
          q: '<string>',
          attributes: [{attribute: '<string>', comparator: '<string>', value: ['<string>']}],
          list: '<string>',
          valid: true,
          invalid: true,
          blocked: true,
          unblocked: true,
          optIn: true
        },
        optInConfirmation: '<string>',
        optIn: '2023-11-07T05:31:56Z',
        optOut: '2023-11-07T05:31:56Z'
      }
    ],
    attributes: {},
    optIn: '2023-11-07T05:31:56Z',
    blocked: '2023-11-07T05:31:56Z',
    activecampaign: {id: 123},
    hubspot: {id: 123},
    pipedrive: {id: 123}
  })
};

fetch('https://api.sakari.io/v1/accounts/{accountId}/attributes/{attributeType}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sakari.io/v1/accounts/{accountId}/attributes/{attributeType}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'chris@sakari.io',
    'firstName' => 'Chris',
    'lastName' => 'Bloggs',
    'lists' => [
        [
                'name' => '<string>',
                'keyword' => '<string>',
                'doubleOptIn' => [
                                'enabled' => true,
                                'prompt' => '<string>'
                ],
                'filter' => [
                                'q' => '<string>',
                                'attributes' => [
                                                                [
                                                                                                                                'attribute' => '<string>',
                                                                                                                                'comparator' => '<string>',
                                                                                                                                'value' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ]
                                                                ]
                                ],
                                'list' => '<string>',
                                'valid' => true,
                                'invalid' => true,
                                'blocked' => true,
                                'unblocked' => true,
                                'optIn' => true
                ],
                'optInConfirmation' => '<string>',
                'optIn' => '2023-11-07T05:31:56Z',
                'optOut' => '2023-11-07T05:31:56Z'
        ]
    ],
    'attributes' => [
        
    ],
    'optIn' => '2023-11-07T05:31:56Z',
    'blocked' => '2023-11-07T05:31:56Z',
    'activecampaign' => [
        'id' => 123
    ],
    'hubspot' => [
        'id' => 123
    ],
    'pipedrive' => [
        'id' => 123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.sakari.io/v1/accounts/{accountId}/attributes/{attributeType}"

	payload := strings.NewReader("{\n  \"email\": \"chris@sakari.io\",\n  \"firstName\": \"Chris\",\n  \"lastName\": \"Bloggs\",\n  \"lists\": [\n    {\n      \"name\": \"<string>\",\n      \"keyword\": \"<string>\",\n      \"doubleOptIn\": {\n        \"enabled\": true,\n        \"prompt\": \"<string>\"\n      },\n      \"filter\": {\n        \"q\": \"<string>\",\n        \"attributes\": [\n          {\n            \"attribute\": \"<string>\",\n            \"comparator\": \"<string>\",\n            \"value\": [\n              \"<string>\"\n            ]\n          }\n        ],\n        \"list\": \"<string>\",\n        \"valid\": true,\n        \"invalid\": true,\n        \"blocked\": true,\n        \"unblocked\": true,\n        \"optIn\": true\n      },\n      \"optInConfirmation\": \"<string>\",\n      \"optIn\": \"2023-11-07T05:31:56Z\",\n      \"optOut\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"attributes\": {},\n  \"optIn\": \"2023-11-07T05:31:56Z\",\n  \"blocked\": \"2023-11-07T05:31:56Z\",\n  \"activecampaign\": {\n    \"id\": 123\n  },\n  \"hubspot\": {\n    \"id\": 123\n  },\n  \"pipedrive\": {\n    \"id\": 123\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))

}
HttpResponse<String> response = Unirest.post("https://api.sakari.io/v1/accounts/{accountId}/attributes/{attributeType}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"chris@sakari.io\",\n  \"firstName\": \"Chris\",\n  \"lastName\": \"Bloggs\",\n  \"lists\": [\n    {\n      \"name\": \"<string>\",\n      \"keyword\": \"<string>\",\n      \"doubleOptIn\": {\n        \"enabled\": true,\n        \"prompt\": \"<string>\"\n      },\n      \"filter\": {\n        \"q\": \"<string>\",\n        \"attributes\": [\n          {\n            \"attribute\": \"<string>\",\n            \"comparator\": \"<string>\",\n            \"value\": [\n              \"<string>\"\n            ]\n          }\n        ],\n        \"list\": \"<string>\",\n        \"valid\": true,\n        \"invalid\": true,\n        \"blocked\": true,\n        \"unblocked\": true,\n        \"optIn\": true\n      },\n      \"optInConfirmation\": \"<string>\",\n      \"optIn\": \"2023-11-07T05:31:56Z\",\n      \"optOut\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"attributes\": {},\n  \"optIn\": \"2023-11-07T05:31:56Z\",\n  \"blocked\": \"2023-11-07T05:31:56Z\",\n  \"activecampaign\": {\n    \"id\": 123\n  },\n  \"hubspot\": {\n    \"id\": 123\n  },\n  \"pipedrive\": {\n    \"id\": 123\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.sakari.io/v1/accounts/{accountId}/attributes/{attributeType}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"chris@sakari.io\",\n  \"firstName\": \"Chris\",\n  \"lastName\": \"Bloggs\",\n  \"lists\": [\n    {\n      \"name\": \"<string>\",\n      \"keyword\": \"<string>\",\n      \"doubleOptIn\": {\n        \"enabled\": true,\n        \"prompt\": \"<string>\"\n      },\n      \"filter\": {\n        \"q\": \"<string>\",\n        \"attributes\": [\n          {\n            \"attribute\": \"<string>\",\n            \"comparator\": \"<string>\",\n            \"value\": [\n              \"<string>\"\n            ]\n          }\n        ],\n        \"list\": \"<string>\",\n        \"valid\": true,\n        \"invalid\": true,\n        \"blocked\": true,\n        \"unblocked\": true,\n        \"optIn\": true\n      },\n      \"optInConfirmation\": \"<string>\",\n      \"optIn\": \"2023-11-07T05:31:56Z\",\n      \"optOut\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"attributes\": {},\n  \"optIn\": \"2023-11-07T05:31:56Z\",\n  \"blocked\": \"2023-11-07T05:31:56Z\",\n  \"activecampaign\": {\n    \"id\": 123\n  },\n  \"hubspot\": {\n    \"id\": 123\n  },\n  \"pipedrive\": {\n    \"id\": 123\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "amount": 123,
    "below": 123,
    "lastTopup": "2023-11-07T05:31:56Z"
  }
}
{
  "success": true,
  "error": {
    "code": "CONT-010",
    "description": "Contact has requested no further communication"
  }
}
{
  "success": true,
  "error": {
    "code": "CONT-010",
    "description": "Contact has requested no further communication"
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
accountId
string
required

Account to apply operations to

​
attributeType
enum<string>
required

Type of custom attribute

Available options:
contacts,
deals,
tickets

Body

​
email
string
Example:

"chris@sakari.io"

​
firstName
string
Example:

"Chris"

​
lastName
string
Example:

"Bloggs"

​
mobile
object
​
lists
object[]
​
attributes
object
​
optIn
string<date-time>
​
blocked
string<date-time>
​
activecampaign
object
​
hubspot
object
​
pipedrive
object
​
error
object

Response

successful operation

​
success
boolean
required
​
data
object
required