Open API v2 / CRM & Orders / CRM Contacts

CRM Contacts

→

Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.

GET/api/v2/admin/contacts#

Retrieves a list of contacts by using a "where" filtering

Parameters
Wherestring · query
JSON filter expression. Combine operators ($eq, $contains, $gt, $in, …) with $and / $or.
Order_Bystring · query
Sort field. Prefix with - for descending; comma-separate for tie-breakers.
Semantic_Querystring · query
Natural-language search, ranked by relevance.
Min_Scorenumber · query
Lowest relevance score to include when using Semantic_Query.
Offsetinteger · query
Number of items to skip before returning results. Defaults to 0.
Limitinteger · query
Maximum number of items to return. Defaults to 100.
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Emailstring · nullable
User's email.
FirstNamestring · nullable
The contact's first name.
LastNamestring · nullable
The contact's last name.
CrmTypeenum
Type of record in the CRM system. Possible values: Contact, Member.Possible values: ContactMember
EmailConfirmedboolean
Email confirmation status.
Roleenum
Access level granted to the member. Possible values: General, AdminUser.Possible values: GeneralAdminUser
CreatedDatestring · date-time
Date and time of record creation.
Addressstring · nullable
Street/residential address.
Citystring · nullable
City of residence.
Statestring · nullable
State of residence.
ZipCodestring · nullable
Postal code.
Countrystring · nullable
Country.
BillingAddressstring · nullable
The street and number of the contact's billing address.
BillingCitystring · nullable
The city of the contact's billing address.
BillingStatestring · nullable
The state, province, or region of the contact's billing address.
BillingZipCodestring · nullable
The postal code of the contact's billing address.
BillingCountrystring · nullable
The country of the contact's billing address.
Sitestring · nullable
The member's website address.
Phonestring · nullable
The contact's phone number, ideally in E.164 format.
Statusstring · nullable
Current object status.
Notesstring · nullable
Free-text notes for internal use.
Typeenum
User category. Possible values: Consumer, Wholesaler.Possible values: ConsumerWholesaler
IsDataUsingAllowedboolean
Consent to the use of personal data.
CustomCrmGroupsarray of objects
Custom CRM group field values attached to this record.
curl "https://your-site.webinone.com/api/v2/admin/contacts" \
  -H "Authorization: Bearer <token>"
Response · 200
{
  "Items": [
    {
      "Id": 1,
      "Email": "user@example.com",
      "FirstName": "Example",
      "LastName": "Example",
      "CrmType": "Contact",
      "EmailConfirmed": false,
      "Role": "General",
      "CreatedDate": "2026-07-01T00: 00: 00Z",
      "Address": "string",
      "City": "string",
      "State": "string",
      "ZipCode": "string",
      "Country": "string",
      "BillingAddress": "string",
      "BillingCity": "string",
      "BillingState": "string",
      "BillingZipCode": "string",
      "BillingCountry": "string",
      "Site": "string",
      "Phone": "string",
      "Status": "string",
      "Notes": "string",
      "Type": "Consumer",
      "IsDataUsingAllowed": false,
      "CustomCrmGroups": [
        {
          "Alias": "string",
          "Fields": [
            {
              "Alias": "string",
              "Value": "string",
              "Type": "DateTime"
            }
          ]
        }
      ]
    }
  ],
  "TotalItemsCount": 0
}
POST/api/v2/admin/contacts#

Creates a new contact

Body parameters
Emailstringrequired
Primary contact identifier. Must be unique in the system. Email validity verification is performed.
FirstNamestringrequired
Client's first name.
LastNamestring · nullable
Client's last name.
Passwordstring · nullable
Password. Pass only for Member.
CrmTypeenum
Defines the access level. Member: client with access (if password is provided). Contact: regular lead or record in the database.Possible values: ContactMember
Roleenum
Role in the system or position. General: by default. Nullable: false.Possible values: GeneralAdminUser
Addressstring · nullable
Physical address (street, house number).
Citystring · nullable
City of residence.
Statestring · nullable
Province, state, or region.
ZipCodestring · nullable
Postal code.
Countrystring · nullable
Country (it is recommended to use ISO codes).
BillingAddressstring · nullable
Billing address (may match the physical address).
BillingCitystring · nullable
Billing address city.
BillingStatestring · nullable
Province/state of the billing address.
BillingZipCodestring · nullable
Billing address postal code.
BillingCountrystring · nullable
Billing address country.
Sitestring · nullable
URL of the contact's or company's website.
Phonestring · nullable
Phone number (E.164 format recommended).
Statusstring · nullable
Contact lifecycle (for example: Active, Lead, Archived).
Notesstring · nullable
Arbitrary internal administrator notes about this contact.
Typeenum
Classification. Consumer: by default. Nullable: false.Possible values: ConsumerWholesaler
IsDataUsingAllowedboolean
Consent to data processing. A key parameter for GDPR. True allows marketing communications.
CustomCrmGroupsarray of objects
Custom fields. An object containing additional properties grouped by technical names (for example, hobbies or specific settings). This is a dynamic section, where keys (for example, at-api-crm-group) correspond to internal identifiers of field groups in your CRM. Films (string): Example of a text field (for example, movie preferences) and depending on the settings, may be required. Field types are.
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Emailstring · nullable
User's email.
FirstNamestring · nullable
The contact's first name.
LastNamestring · nullable
The contact's last name.
CrmTypeenum
Type of record in the CRM system. Possible values: Contact, Member.Possible values: ContactMember
EmailConfirmedboolean
Email confirmation status.
Roleenum
Access level granted to the member. Possible values: General, AdminUser.Possible values: GeneralAdminUser
CreatedDatestring · date-time
Date and time of record creation.
Addressstring · nullable
Street/residential address.
Citystring · nullable
City of residence.
Statestring · nullable
State of residence.
ZipCodestring · nullable
Postal code.
Countrystring · nullable
Country.
BillingAddressstring · nullable
The street and number of the contact's billing address.
BillingCitystring · nullable
The city of the contact's billing address.
BillingStatestring · nullable
The state, province, or region of the contact's billing address.
BillingZipCodestring · nullable
The postal code of the contact's billing address.
BillingCountrystring · nullable
The country of the contact's billing address.
Sitestring · nullable
The member's website address.
Phonestring · nullable
The contact's phone number, ideally in E.164 format.
Statusstring · nullable
Current object status.
Notesstring · nullable
Free-text notes for internal use.
Typeenum
User category. Possible values: Consumer, Wholesaler.Possible values: ConsumerWholesaler
IsDataUsingAllowedboolean
Consent to the use of personal data.
CustomCrmGroupsarray of objects
Custom CRM group field values attached to this record.
curl -X POST "https://your-site.webinone.com/api/v2/admin/contacts" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Email":"user@example.com","FirstName":"Example","LastName":"Example","Password":"string","CrmType":"Contact","Role":"General","Address":"string","City":"string","State":"string","ZipCode":"string","Country":"string","BillingAddress":"string","BillingCity":"string","BillingState":"string","BillingZipCode":"string","BillingCountry":"string","Site":"string","Phone":"string","Status":"string","Notes":"string","Type":"Consumer","IsDataUsingAllowed":false,"CustomCrmGroups":[{"Alias":"string","Fields":[{"Alias":"string","Value":"string","Type":"DateTime"}]}]}'
Response · 200
{
  "Id": 1,
  "Email": "user@example.com",
  "FirstName": "Example",
  "LastName": "Example",
  "CrmType": "Contact",
  "EmailConfirmed": false,
  "Role": "General",
  "CreatedDate": "2026-07-01T00: 00: 00Z",
  "Address": "string",
  "City": "string",
  "State": "string",
  "ZipCode": "string",
  "Country": "string",
  "BillingAddress": "string",
  "BillingCity": "string",
  "BillingState": "string",
  "BillingZipCode": "string",
  "BillingCountry": "string",
  "Site": "string",
  "Phone": "string",
  "Status": "string",
  "Notes": "string",
  "Type": "Consumer",
  "IsDataUsingAllowed": false,
  "CustomCrmGroups": [
    {
      "Alias": "string",
      "Fields": [
        {
          "Alias": "string",
          "Value": "string",
          "Type": "DateTime"
        }
      ]
    }
  ]
}
GET/api/v2/admin/contacts/{contactId}/bookings#

Retrieves a list of contact bookings by using a "where" filtering

Parameters
contactIdinteger · pathrequired
Contact id.
Wherestring · query
JSON filter expression. Combine operators ($eq, $contains, $gt, $in, …) with $and / $or.
Order_Bystring · query
Sort field. Prefix with - for descending; comma-separate for tie-breakers.
Semantic_Querystring · query
Natural-language search, ranked by relevance.
Min_Scorenumber · query
Lowest relevance score to include when using Semantic_Query.
Offsetinteger · query
Number of items to skip before returning results. Defaults to 0.
Limitinteger · query
Maximum number of items to return. Defaults to 100.
Response
Idinteger
Event ID. Read-only.
EventIdinteger
Event ID. Connection to a specific event.
OrderIdinteger
Identifier of the related order.
FormIdinteger
Identifier of the related form.
MemberIdinteger
Identifier of the related member.
Allocationinteger
Number of "allocated" units.
CreatedDateTimestring · date-time
Date and time of case creation in UTC. Read-only.
CustomCrmGroupsarray of objects
Dynamic CRM groups with custom fields.
Memberobject
The member (site user) this record is linked to.
Formobject
Form the submission belongs to.
Eventobject
Event details for this booking.
EventBookingFieldsarray of objects
This is a dynamic object that contains the values of the form fields on which the EventBooking is created.
curl "https://your-site.webinone.com/api/v2/admin/contacts/1/bookings" \
  -H "Authorization: Bearer <token>"
Response · 200
{
  "Items": [
    {
      "Id": 1,
      "EventId": 1,
      "OrderId": 1,
      "FormId": 1,
      "MemberId": 1,
      "Allocation": 0,
      "CreatedDateTime": "2026-07-01T00: 00: 00Z",
      "CustomCrmGroups": [
        {
          "Alias": "string",
          "Fields": [
            {
              "Alias": "string",
              "Value": "string",
              "Type": "DateTime"
            }
          ]
        }
      ],
      "Member": {
        "Id": 1,
        "Email": "user@example.com",
        "FirstName": "Example",
        "LastName": "Example"
      },
      "Form": {
        "Id": 1,
        "Alias": "string",
        "Name": "Example"
      },
      "Event": {
        "Id": 1,
        "Name": "Example"
      },
      "EventBookingFields": [
        {
          "Alias": "string",
          "Value": "string",
          "Type": "DateTime"
        }
      ]
    }
  ],
  "TotalItemsCount": 0
}
GET/api/v2/admin/contacts/{contactId}/cases#

Retrieves a list of contact cases by using a "where" filtering

Parameters
contactIdinteger · pathrequired
Contact id.
Wherestring · query
JSON filter expression. Combine operators ($eq, $contains, $gt, $in, …) with $and / $or.
Order_Bystring · query
Sort field. Prefix with - for descending; comma-separate for tie-breakers.
Semantic_Querystring · query
Natural-language search, ranked by relevance.
Min_Scorenumber · query
Lowest relevance score to include when using Semantic_Query.
Offsetinteger · query
Number of items to skip before returning results. Defaults to 0.
Limitinteger · query
Maximum number of items to return. Defaults to 100.
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
OrderIdinteger
Identifier of the related order.
FormIdinteger
Identifier of the related form.
MemberIdinteger
Identifier of the related member.
CreatedDateTimestring · date-time
Date and time of case creation in UTC. Read-only.
CustomCrmGroupsarray of objects
Custom CRM group field values attached to this record.
Memberobject
The member (site user) this record is linked to.
Formobject
Form the submission belongs to.
CaseFieldsarray of objects
This is a dynamic object that contains the values of the form fields on which the Case is created.
curl "https://your-site.webinone.com/api/v2/admin/contacts/1/cases" \
  -H "Authorization: Bearer <token>"
Response · 200
{
  "Items": [
    {
      "Id": 1,
      "OrderId": 1,
      "FormId": 1,
      "MemberId": 1,
      "CreatedDateTime": "2026-07-01T00: 00: 00Z",
      "CustomCrmGroups": [
        {
          "Alias": "string",
          "Fields": [
            {
              "Alias": "string",
              "Value": "string",
              "Type": "DateTime"
            }
          ]
        }
      ],
      "Member": {
        "Id": 1,
        "Email": "user@example.com",
        "FirstName": "Example",
        "LastName": "Example"
      },
      "Form": {
        "Id": 1,
        "Alias": "string",
        "Name": "Example"
      },
      "CaseFields": [
        {
          "Alias": "string",
          "Value": "string",
          "Type": "DateTime"
        }
      ]
    }
  ],
  "TotalItemsCount": 0
}
GET/api/v2/admin/contacts/{contactId}/orders#

Retrieves a list of contact orders by using a "where" filtering

Parameters
contactIdinteger · pathrequired
Contact id.
Wherestring · query
JSON filter expression. Combine operators ($eq, $contains, $gt, $in, …) with $and / $or.
Order_Bystring · query
Sort field. Prefix with - for descending; comma-separate for tie-breakers.
Semantic_Querystring · query
Natural-language search, ranked by relevance.
Min_Scorenumber · query
Lowest relevance score to include when using Semantic_Query.
Offsetinteger · query
Number of items to skip before returning results. Defaults to 0.
Limitinteger · query
Maximum number of items to return. Defaults to 100.
Response
Idinteger
'Member' a unique user identifier in the system. Read-only.
AWBNumberstring · nullable
Intended for the Air Waybill (or any other shipment tracking/consignment number) from your freight provider.
CurrencyCountrystring · nullable
The Currency/Country pair used for the payment processing (this field is not editable).
Currencystring · nullable
Order currency code.
Countrystring · nullable
'ShippingInfo' the contact's shipping country as entered during the checkout process.
InvoiceDatestring · date-time
Date-time - the date and time the invoice was generated.
InvoiceNumberinteger · nullable
A number assigned incrementally to each order.
VATInvoiceNumberinteger · nullable
The VAT invoice number assigned to the order for tax reporting.
InvoiceCodestring · nullable
Formatted identifier.
IsDeletedboolean
Soft delete flag for the order.
IsRecurringboolean
Indicates whether this order is a recurring payment (auto-renewal or subscription).
MainOrderIdinteger
Identifier of the related main order.
MemberIdinteger
The CRM Contact who submitted the Order (this field is not editable).
OrderNamestring · nullable
The Order name is generally constructed by the name of the Form used for taking the Order then appended with the Order date.
PaymentStateenum
Current payment status. Possible values: None, Succeeded, RequiresCapture, RequiresAction, Canceled, Processing, Pending.Possible values: NoneSucceededRequiresCaptureRequiresActionCanceledProcessingPending
StatusIdinteger
The current status of the Order. See eCommerce Settings / Manage Status for more details.
TotalCostnumber
The total amount or the Order (this field is not editable).
CreatedDateTimestring · date-time
Date-time - the date and time the Order was created in the CRM (this field is not editable). Read-only.
HasSubscriptionsboolean
Indicates whether the order contains at least one product that is a subscription (for example, access to a service for a month).
HasPaidSubscriptionboolean
Indicates whether this order was successfully paid for as part of a subscription.
TrackingURLstring · nullable
Intended for the URL used for consignment tracking by your freight provider.
TransactionIdstring · nullable
Unique transaction identifier from the payment gateway.
AmountPaidnumber
The amount that has already been actually received by the system. When it equals TotalCost, the order is considered fully paid.
AmountPendingnumber
An amount that is pending (for example, a bank transfer that has not yet been confirmed or a card hold).
OrderCaseTypeenum
Order category for internal processing. Possible values: FormCase, EventCase, None.Possible values: FormCaseEventCaseNone
StatusShortobject
This is a mapping object that decodes the system StatusId.
Discountobject
Discount amount (promotional codes, promotions).
GiftVoucherobject
Amount paid with a gift certificate.
Taxobject
Tax amount. May be included in the price or added on top depending on the region.
ShippingInfoobject
This is an object that contains detailed information about logistics and delivery address.
Memberobject
Contains basic information about the customer who placed the order.
MemberSnapshotobject
A frozen copy of the customer's details as they were when the order was placed, preserved even if the contact later changes.
OrderLinesarray of objects
List of product items in the order.
Paymentsarray of objects
Transaction history for this order. Allows you to track multiple payment attempts (for example, if the first was declined and the second was successful). Contains payment details and dates.
CustomCrmGroupsarray of objects
JSON object for custom CRM metadata. Used to group customers or orders by specific marketing tags (e.g. "VIP", "Black Friday Hunter").
curl "https://your-site.webinone.com/api/v2/admin/contacts/1/orders" \
  -H "Authorization: Bearer <token>"
Response · 200
{
  "Items": [
    {
      "Id": 1,
      "AWBNumber": "string",
      "CurrencyCountry": "USD",
      "Currency": "USD",
      "Country": "string",
      "InvoiceDate": "2026-07-01T00: 00: 00Z",
      "InvoiceNumber": 0,
      "VATInvoiceNumber": 0,
      "InvoiceCode": "string",
      "IsDeleted": false,
      "IsRecurring": false,
      "MainOrderId": 1,
      "MemberId": 1,
      "OrderName": "Example",
      "PaymentState": "None",
      "StatusId": 1,
      "TotalCost": 0,
      "CreatedDateTime": "2026-07-01T00: 00: 00Z",
      "HasSubscriptions": false,
      "HasPaidSubscription": false,
      "TrackingURL": "https://example.com",
      "TransactionId": "string",
      "AmountPaid": 1,
      "AmountPending": 0,
      "OrderCaseType": "FormCase",
      "StatusShort": {
        "Id": 1,
        "Name": "Example",
        "Type": "string"
      },
      "Discount": {
        "Code": "string",
        "Cost": 0
      },
      "GiftVoucher": {
        "Name": "Example",
        "Cost": 0
      },
      "Tax": {
        "Code": "string",
        "Rate": 0
      },
      "ShippingInfo": {
        "Name": "Example",
        "Cost": 0,
        "Address": "string",
        "City": "string",
        "State": "string",
        "Zipcode": "string",
        "Country": "string"
      },
      "Member": {
        "Id": 1,
        "Email": "user@example.com",
        "FirstName": "Example",
        "LastName": "Example"
      },
      "MemberSnapshot": {
        "Email": "user@example.com",
        "FirstName": "Example",
        "LastName": "Example",
        "BillingAddress": "string",
        "BillingCity": "string",
        "BillingState": "string",
        "BillingZipCode": "string",
        "BillingCountry": "string"
      },
      "OrderLines": [
        {
          "Id": 1,
          "EntityType": "Form",
          "ProductId": 1,
          "ModuleId": 1,
          "ProductName": "Example",
          "Quantity": 0,
          "TaxRate": 0,
          "UnitPrice": 0,
          "TotalPrice": 0,
          "FileName": "Example",
          "IsDownload": false,
          "Attributes": [
            {
              "AttributeId": 1,
              "OptionsIds": null
            }
          ]
        }
      ],
      "Payments": [
        {
          "Id": 1,
          "Amount": 0,
          "AmountCaptured": 0,
          "GatewayReason": "string",
          "TransactionId": "string",
          "Status": "string",
          "PaymentType": "CreditCard",
          "PaymentGatewayType": "stripe",
          "Notes": "string",
          "CreatedDateTime": "2026-07-01T00: 00: 00Z"
        }
      ],
      "CustomCrmGroups": [
        {
          "Alias": "string",
          "Fields": [
            {
              "Alias": "string",
              "Value": "string",
              "Type": "DateTime"
            }
          ]
        }
      ]
    }
  ],
  "TotalItemsCount": 0
}
GET/api/v2/admin/contacts/{contactId}/secure-zones#

Retrieves a list of contact secure zones

Parameters
contactIdinteger · pathrequired
Contact id.
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Namestring · nullable
Name of the contact secure zones.
ExpiryDateTimestring · date-time
Expiry timestamp (ISO 8601).
CreatedDateTimestring · date-time
When the record was created (ISO 8601). Read-only.
UpdatedDateTimestring · date-time
When the record was last updated (ISO 8601).
curl "https://your-site.webinone.com/api/v2/admin/contacts/1/secure-zones" \
  -H "Authorization: Bearer <token>"
Response · 200
[
  {
    "Id": 1,
    "Name": "Example",
    "ExpiryDateTime": "2026-07-01T00: 00: 00Z",
    "CreatedDateTime": "2026-07-01T00: 00: 00Z",
    "UpdatedDateTime": "2026-07-01T00: 00: 00Z"
  }
]
PUT/api/v2/admin/contacts/{contactId}/secure-zones#

Updates an existing contact secure zones

Parameters
contactIdinteger · pathrequired
Contact id.
Body parameters
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Namestring · nullable
Name of the contact secure zones.
ExpiryDateTimestring · date-time
Expiry timestamp (ISO 8601).
CreatedDateTimestring · date-time
When the record was created (ISO 8601). Read-only.
UpdatedDateTimestring · date-time
When the record was last updated (ISO 8601).
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Namestring · nullable
Name of the contact secure zones.
ExpiryDateTimestring · date-time
Expiry timestamp (ISO 8601).
CreatedDateTimestring · date-time
When the record was created (ISO 8601). Read-only.
UpdatedDateTimestring · date-time
When the record was last updated (ISO 8601).
curl -X PUT "https://your-site.webinone.com/api/v2/admin/contacts/1/secure-zones" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '[{"Id":1,"Name":"Example","ExpiryDateTime":"2026-07-01T00:00:00Z","CreatedDateTime":"2026-07-01T00:00:00Z","UpdatedDateTime":"2026-07-01T00:00:00Z"}]'
Response · 200
[
  {
    "Id": 1,
    "Name": "Example",
    "ExpiryDateTime": "2026-07-01T00: 00: 00Z",
    "CreatedDateTime": "2026-07-01T00: 00: 00Z",
    "UpdatedDateTime": "2026-07-01T00: 00: 00Z"
  }
]
GET/api/v2/admin/contacts/{id}#

Retrieves a single contact

Parameters
idinteger · pathrequired
Contact id.
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Emailstring · nullable
User's email.
FirstNamestring · nullable
The contact's first name.
LastNamestring · nullable
The contact's last name.
CrmTypeenum
Type of record in the CRM system. Possible values: Contact, Member.Possible values: ContactMember
EmailConfirmedboolean
Email confirmation status.
Roleenum
Access level granted to the member. Possible values: General, AdminUser.Possible values: GeneralAdminUser
CreatedDatestring · date-time
Date and time of record creation.
Addressstring · nullable
Street/residential address.
Citystring · nullable
City of residence.
Statestring · nullable
State of residence.
ZipCodestring · nullable
Postal code.
Countrystring · nullable
Country.
BillingAddressstring · nullable
The street and number of the contact's billing address.
BillingCitystring · nullable
The city of the contact's billing address.
BillingStatestring · nullable
The state, province, or region of the contact's billing address.
BillingZipCodestring · nullable
The postal code of the contact's billing address.
BillingCountrystring · nullable
The country of the contact's billing address.
Sitestring · nullable
The member's website address.
Phonestring · nullable
The contact's phone number, ideally in E.164 format.
Statusstring · nullable
Current object status.
Notesstring · nullable
Free-text notes for internal use.
Typeenum
User category. Possible values: Consumer, Wholesaler.Possible values: ConsumerWholesaler
IsDataUsingAllowedboolean
Consent to the use of personal data.
CustomCrmGroupsarray of objects
Custom CRM group field values attached to this record.
curl "https://your-site.webinone.com/api/v2/admin/contacts/1" \
  -H "Authorization: Bearer <token>"
Response · 200
{
  "Id": 1,
  "Email": "user@example.com",
  "FirstName": "Example",
  "LastName": "Example",
  "CrmType": "Contact",
  "EmailConfirmed": false,
  "Role": "General",
  "CreatedDate": "2026-07-01T00: 00: 00Z",
  "Address": "string",
  "City": "string",
  "State": "string",
  "ZipCode": "string",
  "Country": "string",
  "BillingAddress": "string",
  "BillingCity": "string",
  "BillingState": "string",
  "BillingZipCode": "string",
  "BillingCountry": "string",
  "Site": "string",
  "Phone": "string",
  "Status": "string",
  "Notes": "string",
  "Type": "Consumer",
  "IsDataUsingAllowed": false,
  "CustomCrmGroups": [
    {
      "Alias": "string",
      "Fields": [
        {
          "Alias": "string",
          "Value": "string",
          "Type": "DateTime"
        }
      ]
    }
  ]
}
PUT/api/v2/admin/contacts/{id}#

Updates an existing contact

Parameters
idinteger · pathrequired
Existent contact id.
Body parameters
Emailstringrequired
Primary contact identifier. Must be unique in the system. Email validity verification is performed.
FirstNamestringrequired
Client's first name.
LastNamestring · nullable
Client's last name.
CrmTypeenum
Defines the access level. Member: client with access (if password is provided). Contact: regular lead or record in the database.Possible values: ContactMember
Roleenum
Role in the system or position. General: by default. Nullable: false.Possible values: GeneralAdminUser
Addressstring · nullable
Physical address (street, house number).
Citystring · nullable
City of residence.
Statestring · nullable
Province, state, or region.
ZipCodestring · nullable
Postal code.
Countrystring · nullable
Country (it is recommended to use ISO codes).
BillingAddressstring · nullable
Billing address (may match the physical address).
BillingCitystring · nullable
Billing address city.
BillingStatestring · nullable
Province/state of the billing address.
BillingZipCodestring · nullable
Billing address postal code.
BillingCountrystring · nullable
Billing address country.
Sitestring · nullable
URL of the contact's or company's website.
Phonestring · nullable
Phone number (E.164 format recommended).
Statusstring · nullable
Contact lifecycle (for example: Active, Lead, Archived).
Notesstring · nullable
Arbitrary internal administrator notes about this contact.
Typeenum
Classification. Consumer: by default. Nullable: false.Possible values: ConsumerWholesaler
IsDataUsingAllowedboolean
Consent to data processing. A key parameter for GDPR. True allows marketing communications.
CustomCrmGroupsarray of objects
Custom fields. An object containing additional properties grouped by technical names (for example, hobbies or specific settings). This is a dynamic section, where keys (for example, at-api-crm-group) correspond to internal identifiers of field groups in your CRM. Films (string): Example of a text field (for example, movie preferences) and depending on the settings, may be required. Field types are.
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Emailstring · nullable
User's email.
FirstNamestring · nullable
The contact's first name.
LastNamestring · nullable
The contact's last name.
CrmTypeenum
Type of record in the CRM system. Possible values: Contact, Member.Possible values: ContactMember
EmailConfirmedboolean
Email confirmation status.
Roleenum
Access level granted to the member. Possible values: General, AdminUser.Possible values: GeneralAdminUser
CreatedDatestring · date-time
Date and time of record creation.
Addressstring · nullable
Street/residential address.
Citystring · nullable
City of residence.
Statestring · nullable
State of residence.
ZipCodestring · nullable
Postal code.
Countrystring · nullable
Country.
BillingAddressstring · nullable
The street and number of the contact's billing address.
BillingCitystring · nullable
The city of the contact's billing address.
BillingStatestring · nullable
The state, province, or region of the contact's billing address.
BillingZipCodestring · nullable
The postal code of the contact's billing address.
BillingCountrystring · nullable
The country of the contact's billing address.
Sitestring · nullable
The member's website address.
Phonestring · nullable
The contact's phone number, ideally in E.164 format.
Statusstring · nullable
Current object status.
Notesstring · nullable
Free-text notes for internal use.
Typeenum
User category. Possible values: Consumer, Wholesaler.Possible values: ConsumerWholesaler
IsDataUsingAllowedboolean
Consent to the use of personal data.
CustomCrmGroupsarray of objects
Custom CRM group field values attached to this record.
curl -X PUT "https://your-site.webinone.com/api/v2/admin/contacts/1" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Email":"user@example.com","FirstName":"Example","LastName":"Example","CrmType":"Contact","Role":"General","Address":"string","City":"string","State":"string","ZipCode":"string","Country":"string","BillingAddress":"string","BillingCity":"string","BillingState":"string","BillingZipCode":"string","BillingCountry":"string","Site":"string","Phone":"string","Status":"string","Notes":"string","Type":"Consumer","IsDataUsingAllowed":false,"CustomCrmGroups":[{"Alias":"string","Fields":[{"Alias":"string","Value":"string","Type":"DateTime"}]}]}'
Response · 200
{
  "Id": 1,
  "Email": "user@example.com",
  "FirstName": "Example",
  "LastName": "Example",
  "CrmType": "Contact",
  "EmailConfirmed": false,
  "Role": "General",
  "CreatedDate": "2026-07-01T00: 00: 00Z",
  "Address": "string",
  "City": "string",
  "State": "string",
  "ZipCode": "string",
  "Country": "string",
  "BillingAddress": "string",
  "BillingCity": "string",
  "BillingState": "string",
  "BillingZipCode": "string",
  "BillingCountry": "string",
  "Site": "string",
  "Phone": "string",
  "Status": "string",
  "Notes": "string",
  "Type": "Consumer",
  "IsDataUsingAllowed": false,
  "CustomCrmGroups": [
    {
      "Alias": "string",
      "Fields": [
        {
          "Alias": "string",
          "Value": "string",
          "Type": "DateTime"
        }
      ]
    }
  ]
}
DELETE/api/v2/admin/contacts/{id}#

Deletes an existing contact

Parameters
idinteger · pathrequired
Existent contact id.
curl -X DELETE "https://your-site.webinone.com/api/v2/admin/contacts/1" \
  -H "Authorization: Bearer <token>"
PUT/api/v2/admin/contacts/{id}/set-password#

Sets a contact password

Parameters
idinteger · pathrequired
Resource identifier.
Body parameters
Passwordstring · nullable
Password. Pass only for Member.
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Emailstring · nullable
User's email.
FirstNamestring · nullable
The contact's first name.
LastNamestring · nullable
The contact's last name.
CrmTypeenum
Type of record in the CRM system. Possible values: Contact, Member.Possible values: ContactMember
EmailConfirmedboolean
Email confirmation status.
Roleenum
Access level granted to the member. Possible values: General, AdminUser.Possible values: GeneralAdminUser
CreatedDatestring · date-time
Date and time of record creation.
Addressstring · nullable
Street/residential address.
Citystring · nullable
City of residence.
Statestring · nullable
State of residence.
ZipCodestring · nullable
Postal code.
Countrystring · nullable
Country.
BillingAddressstring · nullable
The street and number of the contact's billing address.
BillingCitystring · nullable
The city of the contact's billing address.
BillingStatestring · nullable
The state, province, or region of the contact's billing address.
BillingZipCodestring · nullable
The postal code of the contact's billing address.
BillingCountrystring · nullable
The country of the contact's billing address.
Sitestring · nullable
The member's website address.
Phonestring · nullable
The contact's phone number, ideally in E.164 format.
Statusstring · nullable
Current object status.
Notesstring · nullable
Free-text notes for internal use.
Typeenum
User category. Possible values: Consumer, Wholesaler.Possible values: ConsumerWholesaler
IsDataUsingAllowedboolean
Consent to the use of personal data.
CustomCrmGroupsarray of objects
Custom CRM group field values attached to this record.
curl -X PUT "https://your-site.webinone.com/api/v2/admin/contacts/1/set-password" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Password":"string"}'
Response · 200
{
  "Id": 1,
  "Email": "user@example.com",
  "FirstName": "Example",
  "LastName": "Example",
  "CrmType": "Contact",
  "EmailConfirmed": false,
  "Role": "General",
  "CreatedDate": "2026-07-01T00: 00: 00Z",
  "Address": "string",
  "City": "string",
  "State": "string",
  "ZipCode": "string",
  "Country": "string",
  "BillingAddress": "string",
  "BillingCity": "string",
  "BillingState": "string",
  "BillingZipCode": "string",
  "BillingCountry": "string",
  "Site": "string",
  "Phone": "string",
  "Status": "string",
  "Notes": "string",
  "Type": "Consumer",
  "IsDataUsingAllowed": false,
  "CustomCrmGroups": [
    {
      "Alias": "string",
      "Fields": [
        {
          "Alias": "string",
          "Value": "string",
          "Type": "DateTime"
        }
      ]
    }
  ]
}