Create contact

post

https://bolt.thena.ai/v3/contacts

The CreateContact API allows for the creation of new contacts in the system.

Request Body structure

{
    "name": "String",
    "account_ids": ["String"],
    "email": "String",
    "user_id": "String",
    "metadata": {
        "slack": {
            "id": "String",
            "team_id": "String",
            "name": "String",
            "deleted": "Boolean",
            "real_name": "String",
            "tz": "String",
            "tz_label": "String",
            "tz_offset": "Number",
            "profile": "Object",
            "is_admin": "Boolean",
            "is_owner": "Boolean",
            "is_primary_owner": "Boolean",
            "is_restricted": "Boolean",
            "is_bot": "Boolean",
            "updated": "Number",
            "is_app_user": "Boolean",
            "has_2fa": "Boolean"
        },
        "email": {
            "email": "String",
            "domain": "String",
            "hostname": "String",
            "subdomain": "String",
            "public_suffix": "String",
            "domain_without_suffix": "String"
        },
        "web_widget": {
            "email": "String",
            "domain": "String",
            "hostname": "String",
            "subdomain": "String",
            "public_suffix": "String",
            "domain_without_suffix": "String"
        }
    }
}

Field descriptions

name: (String) The name of the contact. This field is required.
account_ids: (Array of Strings) The IDs of the accounts associated with the contact. This field is required.
email: (String) The email address of the contact. This field is required.
user_id: (String) The user ID of the contact. This field is required.
metadata: (Object) Additional metadata about the contact, which includes:
- slack: (Object) Slack-related information.
  - id: (String) Slack user ID.
  - team_id: (String) Slack team ID.
  - name: (String) Slack user name.
  - deleted: (Boolean) Indicates if the Slack user is deleted.
  - real_name: (String) Real name of the Slack user.
  - tz: (String) Timezone of the Slack user.
  - tz_label: (String) Timezone label.
  - tz_offset: (Number) Timezone offset.
  - profile: (Object) Profile information.
  - is_admin: (Boolean) Indicates if the Slack user is an admin.
  - is_owner: (Boolean) Indicates if the Slack user is an owner.
  - is_primary_owner: (Boolean) Indicates if the Slack user is the primary owner.
  - is_restricted: (Boolean) Indicates if the Slack user has restricted access.
  - is_bot: (Boolean) Indicates if the Slack user is a bot.
  - updated: (Number) Timestamp of the last update.
  - is_app_user: (Boolean) Indicates if the Slack user is an app user.
  - has_2fa: (Boolean) Indicates if the Slack user has two-factor authentication enabled.
- email: (Object) Email-related information.
  - email: (String) Email address.
  - domain: (String) Domain of the email address.
  - hostname: (String) Hostname of the email address.
  - subdomain: (String) Subdomain of the email address.
  - public_suffix: (String) Public suffix of the email address.
  - domain_without_suffix: (String) Domain without the public suffix.
- web_widget: (Object) Web widget-related information.
  - email: (String) Email address.
  - domain: (String) Domain of the email address.
  - hostname: (String) Hostname of the email address.
  - subdomain: (String) Subdomain of the email address.
  - public_suffix: (String) Public suffix of the email address.
  - domain_without_suffix: (String) Domain without the public suffix.