BSG utilizes HTTP cookies (and similar or complementary technologies) to 1) make this website safe, functional, and accessible (through the use of mandatory cookies) and 2) understand how you use our website (through the use of optional cookies) in order to improve your experience and to provide you with personalized content.

The information in the cookie text files may be related to your personal preferences or your device and is intended to make the site operate according to your expectations. The information contained in cookies does not usually identify your identity directly but is helpful in providing you with a more personalized user experience.

In accordance with the requirements of the General Data Protection Regulation (GDPR) privacy and security law that governs how the personal data of individuals in the EU may be processed and transferred, we provide you the possibility to prohibit the use of certain types of cookies when you use our website.

Read our Cookie Notice and the Privacy Policy for detailed information on how BGS collects and uses cookies. Please note that prohibiting the use of certain types of cookies may affect your interaction with the website and limit the accessibility of services we offer you. Choose the appropriate category below to learn more and to disable cookies.

Accept All cookies*
*Recommended for comfortable use of the site
Accept only necessary cookies
Accept only selected cookies
Necessary cookies
Social media
Analytics
Marketing
Developer Docs
Number Intelligence

Edit contact field

Method for editing custom contact field:

  • change field name
  • change field description.

To edit contact field

PATCH http://one-api.bsg.world/api/contacts/fields/{id}

Request parameters

It is necessary to pass at least one of the following parameters: name/ description/ is_visiable.

Parameter Required Type Default Description
id Yes integer No ID of the custom contact field to edit
name No string No Custom contact field name
description No string No Custom contact field description
is_visible No boolean No Display the field in the personal account in the Contact Book: value true or false

Request sample:


{
  "name": "string"
}

Response parameters:

Parameter Type Description
id int Custom contact field ID
type string Field type. Possible values:
  • string – for a field with “Text” type

  • integer – for a field with “Number” type

  • datetime – for a field with “Date and time” type
name string Custom contact field name
description null|string Custom contact field description
is_visible boolean Display the field in the personal account in the Contact Book: value true or false

if the request is successful, you will receive a response:


{
  "data": {
    "id": 26130,
    "name": "Страна",
    "type": "number",
    "description": "The country name",
    "is_visible": true
  }
}

Interested in a special offer?

Ready to reach further?
Let’s talk

I agree to BSG privacy policy
Submit

Useful Materials

What Is Number Verifier — And Why It’s More Than Just an “HLR Lookup”

30% of SMS fail — not because of content, but numbers. Verify before you send.

10 Awesome Back-to-School Marketing Ideas 2025

The start of the school year: when parents trade in their summer margaritas for the

What Is CPaaS? Communications Platform as a Service

Talking to customers these days is more than just emails or phone calls. Businesses need