Update an account

PUT

accounts

{id}

curl --request PUT \
  --url https://platform.thena.ai/v1/accounts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-org-id: <api-key>' \
  --data '{
  "description": "<string>",
  "source": "hubspot",
  "accountOwnerId": "USER123",
  "logo": "https://example.com/logo.png",
  "status": "STATUS123",
  "classification": "CLASSIFICATION123",
  "health": "HEALTH123",
  "industry": "INDUSTRY123",
  "secondaryDomain": "example.com",
  "annualRevenue": 1000000,
  "employees": 100,
  "website": "https://example.com",
  "billingAddress": "123 Main St, Town, State, USA 12345",
  "shippingAddress": "123 Main St, Town, State, USA 12345",
  "customFieldValues": [
    {}
  ],
  "addExistingUsersToAccountContacts": true,
  "metadata": {},
  "name": "Example",
  "primaryDomain": "example.com"
}'

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "source": "hubspot",
  "logo": "<string>",
  "statusId": "<string>",
  "status": "<string>",
  "statusConfiguration": {},
  "classificationId": "<string>",
  "classification": "<string>",
  "classificationConfiguration": {},
  "healthId": "<string>",
  "health": "<string>",
  "healthConfiguration": {},
  "industryId": "<string>",
  "industry": "<string>",
  "industryConfiguration": {},
  "primaryDomain": "<string>",
  "secondaryDomain": "<string>",
  "accountOwner": "<string>",
  "accountOwnerId": "<string>",
  "accountOwnerEmail": "<string>",
  "accountOwnerAvatarUrl": "<string>",
  "annualRevenue": 123,
  "employees": 123,
  "website": "<string>",
  "billingAddress": "<string>",
  "shippingAddress": "<string>",
  "customFieldValues": [
    "<string>"
  ],
  "metadata": {},
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

Authorization

string

header

required

Enter JWT bearer token

x-org-id

string

header

required

Enter organization ID

Path Parameters

string

required

Body

application/json

description

string

The description of the account

source

string

The source of the account

Example:

"hubspot"

accountOwnerId

string

The user identifier of the account owner

Example:

"USER123"

logo

string

The URL of the account logo

Example:

"https://example.com/logo.png"

status

string

The identifier / value of the status attribute

Example:

"STATUS123"

classification

string

The identifier / value of the classification attribute

Example:

"CLASSIFICATION123"

health

string

The identifier / value of the health attribute

Example:

"HEALTH123"

industry

string

The identifier / value of the industry attribute

Example:

"INDUSTRY123"

secondaryDomain

string

The secondary domain of the account

Example:

"example.com"

annualRevenue

number

The annual revenue of the account

Example:

1000000

employees

number

The number of employees of the account

Example:

100

website

string

The website of the account

Example:

"https://example.com"

billingAddress

string

The billing address of the account

Example:

"123 Main St, Town, State, USA 12345"

shippingAddress

string

The shipping address of the account

Example:

"123 Main St, Town, State, USA 12345"

customFieldValues

object[]

The custom field values of the account

addExistingUsersToAccountContacts

boolean

Whether to add existing users matching the email domain to account contacts (false by default)

Example:

true

metadata

object

The metadata of the account

name

string

The name of the account

Example:

"Example"

primaryDomain

string

The primary domain of the account

Example:

"example.com"

Response

200

application/json

Operation successful

string

required

Unique identifier of the account

name

string

required

Name of the account

source

string

required

The source of the account

Example:

"hubspot"

statusId

string

required

The identifier of the status of the account

status

string

required

The status of the account

statusConfiguration

object

required

The configuration of the status

classificationId

string

required

The identifier of the classification of the account

classification

string

required

The classification of the account

classificationConfiguration

object

required

The configuration of the classification

healthId

string

required

The identifier of the health attribute

health

string

required

The health of the account

healthConfiguration

object

required

The configuration of the health

industryId

string

required

The identifier of the industry attribute

industry

string

required

The industry of the account

industryConfiguration

object

required

The configuration of the industry

primaryDomain

string

required

Primary domain of the account

customFieldValues

string[]

required

The custom field values

metadata

object

required

The metadata of the account

createdAt

string

required

Creation date of the account

updatedAt

string

required

Last update date of the account

description

string

The description of the account

logo

string

The URL of the account logo

secondaryDomain

string

Secondary domain of the account

accountOwner

string

Name of the account owner

accountOwnerId

string

Unique identifier of the account owner

accountOwnerEmail

string

Email of the account owner

accountOwnerAvatarUrl

string

The avatar URL of the account owner

annualRevenue

number

Annual revenue of the account

employees

number

Number of employees of the account

website

string

Website of the account

billingAddress

string

Billing address of the account

shippingAddress

string

Shipping address of the account

Get account details

Delete an account

curl --request PUT \
  --url https://platform.thena.ai/v1/accounts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-org-id: <api-key>' \
  --data '{
  "description": "<string>",
  "source": "hubspot",
  "accountOwnerId": "USER123",
  "logo": "https://example.com/logo.png",
  "status": "STATUS123",
  "classification": "CLASSIFICATION123",
  "health": "HEALTH123",
  "industry": "INDUSTRY123",
  "secondaryDomain": "example.com",
  "annualRevenue": 1000000,
  "employees": 100,
  "website": "https://example.com",
  "billingAddress": "123 Main St, Town, State, USA 12345",
  "shippingAddress": "123 Main St, Town, State, USA 12345",
  "customFieldValues": [
    {}
  ],
  "addExistingUsersToAccountContacts": true,
  "metadata": {},
  "name": "Example",
  "primaryDomain": "example.com"
}'

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "source": "hubspot",
  "logo": "<string>",
  "statusId": "<string>",
  "status": "<string>",
  "statusConfiguration": {},
  "classificationId": "<string>",
  "classification": "<string>",
  "classificationConfiguration": {},
  "healthId": "<string>",
  "health": "<string>",
  "healthConfiguration": {},
  "industryId": "<string>",
  "industry": "<string>",
  "industryConfiguration": {},
  "primaryDomain": "<string>",
  "secondaryDomain": "<string>",
  "accountOwner": "<string>",
  "accountOwnerId": "<string>",
  "accountOwnerEmail": "<string>",
  "accountOwnerAvatarUrl": "<string>",
  "annualRevenue": 123,
  "employees": 123,
  "website": "<string>",
  "billingAddress": "<string>",
  "shippingAddress": "<string>",
  "customFieldValues": [
    "<string>"
  ],
  "metadata": {},
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Introduction

Authorizations

Path Parameters

Body

Response