Update contact attribute

Code Examples

You can use as reference the code below to implement this call in your preferred language.
Check all our official API clients here

const SibApiV3Sdk = require('sib-api-v3-sdk');
let defaultClient = SibApiV3Sdk.ApiClient.instance;

let apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';

let apiInstance = new SibApiV3Sdk.AttributesApi();
let attributeCategory = "category";
let attributeName = "levelOfExpertise";
let updateAttribute = new SibApiV3Sdk.UpdateAttribute();

updateAttribute.enumeration = [];
updateAttribute.enumeration[0] = {'value':4,'label':'Proficient'}

apiInstance.updateAttribute(attributeCategory, attributeName, updateAttribute).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR API KEY');

$apiInstance = new SendinBlue\Client\Api\AttributesApi(
    new GuzzleHttp\Client(),
    $config
);
$attributeCategory = 'category'; 
$attributeName = 'levelOfExpertise';
$updateAttribute = new \SendinBlue\Client\Model\UpdateAttribute();
$updateAttribute['enumeration'] = array(
	array('value'=>4, 'label'=>'Proficient')
);

try {
    $apiInstance->updateAttribute($attributeCategory, $attributeName, $updateAttribute);
} catch (Exception $e) {
    echo 'Exception when calling AttributesApi->updateAttribute: ', $e->getMessage(), PHP_EOL;
}
?>
from __future__ import print_function
import time
import sib_api_v3_sdk
from sib_api_v3_sdk.rest import ApiException
from pprint import pprint

configuration = sib_api_v3_sdk.Configuration()
configuration.api_key['api-key'] = 'YOUR API KEY'

api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration))
attribute_category = 'category'
attribute_name = 'levelOfExpertise'
update_attribute = sib_api_v3_sdk.UpdateAttribute()
update_attribute.enumeration = []
update_attribute.enumeration.append({'value':4,'label':'Proficient'})

try:
    api_instance.update_attribute(attribute_category, attribute_name, update_attribute)
except ApiException as e:
    print("Exception when calling AttributesApi->update_attribute: %s\n" % e)
const SibApiV3Sdk = require('sib-api-v3-typescript');
 
let apiInstance = new SibApiV3Sdk.ContactsApi()

let apiKey = apiInstance.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';

let attributeCategory = "category";
let attributeName = "levelOfExpertise";
let updateAttribute = new SibApiV3Sdk.UpdateAttribute(); 

updateAttribute.enumeration = [];
updateAttribute.enumeration[0] = {'value':4,'label':'Proficient'}

apiInstance.updateAttribute(attributeCategory, attributeName, updateAttribute).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});
package sibApi;

import sendinblue.ApiClient;
import sendinblue.Configuration;
import sendinblue.auth.ApiKeyAuth;
import sibModel.*;
import java.util.*;
import java.util.List;

public class Program {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure API key authorization: api-key
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
        apiKey.setApiKey("YOUR API KEY");

        try {
            ContactsApi api = new ContactsApi();
            String attributeCategory = "category";
            String attributeName = "levelOfExpertise";
            UpdateAttributeEnumeration Beginner = new UpdateAttributeEnumeration();
            Beginner.setLabel("Beginner");
            Beginner.setValue(1);
            UpdateAttributeEnumeration Intermediate = new UpdateAttributeEnumeration();
            Intermediate.setLabel("Intermediate");
            Intermediate.setValue(2);
            UpdateAttributeEnumeration Expert = new UpdateAttributeEnumeration();
            Expert.setLabel("Expert");
            Expert.setValue(3);
            List<UpdateAttributeEnumeration> enumerations = new ArrayList<UpdateAttributeEnumeration>();
            enumerations.add(Beginner);
            enumerations.add(Intermediate);
            enumerations.add(Expert);
            UpdateAttribute updateAttribute = new UpdateAttribute();
            updateAttribute.setEnumeration(enumerations);
            api.updateAttribute(attributeCategory, attributeName, updateAttribute);
        } catch (Exception e) {
            System.out.println("Exception occurred:- " + e.getMessage());
        }
    }
}
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;
using System;
using System.Diagnostics;
using System.Collections.Generic;

namespace Sendinblue
{
    class Program
    {
        static void Main(string[] args)
        {
            Configuration.Default.ApiKey.Add("api-key", "YOUR API KEY");

            var apiInstance = new ContactsApi();

            string attributeCategory = "category";
            string attributeName = "levelOfExpertise";
            string value = null;
            UpdateAttributeEnumeration Beginner = new UpdateAttributeEnumeration(1, "Beginner");
            UpdateAttributeEnumeration Intermediate = new UpdateAttributeEnumeration(2, "Intermediate");
            UpdateAttributeEnumeration Expert = new UpdateAttributeEnumeration(3, "Expert");
            List<UpdateAttributeEnumeration> enumerations = new List<UpdateAttributeEnumeration>();
            enumerations.Add(Beginner);
            enumerations.Add(Intermediate);
            enumerations.Add(Expert);
            try
            {
                var updateAttribute = new UpdateAttribute(value, enumerations);
                apiInstance.UpdateAttribute(attributeCategory, attributeName, updateAttribute);
                Console.ReadLine();
            }
            catch (Exception e)
            {
                Debug.WriteLine(e.Message);
                Console.WriteLine(e.Message);
                Console.ReadLine();
            }
        }
    }
}
package main
import (
	"fmt"
	"context"
    sib_api_v3_sdk "./lib"
)

func main() {
	var ctx context.Context
	var cli = sib_api_v3_sdk.APIClient{
		cfg: sib_api_v3_sdk.NewConfiguration(),
	}
	//Configure API key authorization: api-key
	cli.cfg.AddDefaultHeader("api-key", "YOUR_API_KEY")

	sib := sib_api_v3_sdk.NewAPIClient(cli.cfg)
	body := UpdateAttribute{
		Enumeration: []UpdateAttributeEnumeration{
			{Value: 1, Label: "Beginner"},
			{Value: 2, Label: "Intermediate"},
			{Value: 3, Label: "Expert"},
		},
	}
	attributeCategory := "category"
	attributeName := "levelOfExpertise"

	resp, err := sib.ContactsApi.UpdateAttribute(ctx, body, attributeCategory, attributeName)
    if err!=nil{
        fmt.Println("Error in ContactsApi->UpdateAttribute",err.Error())
        return
    }
	fmt.Println( "UpdateAttribute response:",resp)
	return 
}
# load the gem
require 'sib-api-v3-sdk'
# setup authorization
SibApiV3Sdk.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
end

api_instance = SibApiV3Sdk::ContactsApi.new

attribute_category = 'category' # String | Category of the attribute

attribute_name = 'levelOfExpertise' # String | Name of the attribute

update_attribute = SibApiV3Sdk::UpdateAttribute.new # UpdateAttribute | Values to update an attribute

update_attribute = {
  'enumeration'=> [{'value'=>1,'label'=>'Beginner'},{'value'=>2,'label'=>'Intermediate'},{'value'=>3,'label'=>'Expert'}],
  'type'=> 'category'
}

begin
  #Update contact attribute
  api_instance.update_attribute(attribute_category, attribute_name, update_attribute)
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->update_attribute: #{e}"
end
Language
Authorization
Header
Click Try It! to start a request and see the response here!