curl --request PATCH \
  --url https://openapi.enginy.ai/v1/identities/{identityId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Jane Doe",
  "jobTitle": "VP Sales",
  "phoneNumber": "+34600000000",
  "signature": "<p>Jane Doe<br>VP Sales at Enginy</p><p><a href=\"https://enginy.ai\">enginy.ai</a></p>"
}
'

{
  "status": "success",
  "message": "<string>",
  "data": {
    "id": 123,
    "appUrl": "<string>",
    "name": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "jobTitle": "<string>",
    "email": "<string>",
    "phoneNumber": "<string>",
    "emails": [
      "<string>"
    ],
    "linkedInUrl": "<string>",
    "scheduleMeetingUrl": "<string>",
    "timezone": "<string>",
    "profileOverview": "<string>",
    "keyResponsibilities": "<string>",
    "interests": [
      "<string>"
    ],
    "languages": [
      "<string>"
    ],
    "educations": "<string>",
    "previousPositions": "<string>",
    "countryCode": "<string>",
    "signature": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "linkedinAccess": [],
    "linkedinSearchEnabled": true
  }
}

Identities

Update identity

Update public identity profile fields and email signature HTML.

Writable fields: name, firstName, lastName, jobTitle, email, phoneNumber, linkedInUrl, scheduleMeetingUrl, timezone, profileOverview, keyResponsibilities, interests, languages, gender, seniorityLevel, educations, previousPositions, countryCode, and signature.

Send signature as HTML. Enginy stores that HTML in signature and uses it when appending signatures to outbound emails. Send signature: null to clear the signature.

Required scope: ALL

Rate limit: 30 requests per minute

PATCH

identities

{identityId}

curl --request PATCH \
  --url https://openapi.enginy.ai/v1/identities/{identityId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Jane Doe",
  "jobTitle": "VP Sales",
  "phoneNumber": "+34600000000",
  "signature": "<p>Jane Doe<br>VP Sales at Enginy</p><p><a href=\"https://enginy.ai\">enginy.ai</a></p>"
}
'

{
  "status": "success",
  "message": "<string>",
  "data": {
    "id": 123,
    "appUrl": "<string>",
    "name": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "jobTitle": "<string>",
    "email": "<string>",
    "phoneNumber": "<string>",
    "emails": [
      "<string>"
    ],
    "linkedInUrl": "<string>",
    "scheduleMeetingUrl": "<string>",
    "timezone": "<string>",
    "profileOverview": "<string>",
    "keyResponsibilities": "<string>",
    "interests": [
      "<string>"
    ],
    "languages": [
      "<string>"
    ],
    "educations": "<string>",
    "previousPositions": "<string>",
    "countryCode": "<string>",
    "signature": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "linkedinAccess": [],
    "linkedinSearchEnabled": true
  }
}

Authorizations

x-api-key

string

header

required

Path Parameters

identityId

string

required

The identity ID to update.

Body

application/json

Fields to update on an identity. Only public profile fields and the email signature are writable through OpenAPI.

name

string | null

Full display name for the identity.

firstName

string | null

First name for the identity.

lastName

string | null

Last name for the identity.

jobTitle

string | null

Current job title for the identity.

string<email> | null

Primary email address for the identity.

phoneNumber

string | null

Phone number for the identity.

linkedInUrl

string | null

LinkedIn profile URL for the identity.

scheduleMeetingUrl

string | null

Meeting scheduling URL for the identity.

timezone

string | null

Timezone used for identity scheduling context.

profileOverview

string | null

Profile overview used by the AI playbook.

keyResponsibilities

string | null

Responsibilities used by the AI playbook.

interests

string[] | null

Identity interests or professional functions.

languages

string[] | null

Languages associated with the identity.

gender

enum<string> | null

Identity gender value. Allowed values: MALE, FEMALE, OTHER.

Available options:

MALE,

FEMALE,

OTHER,

null

seniorityLevel

enum<string> | null

Identity seniority level. Allowed values: IN_TRAINING, ENTRY_LEVEL, SENIOR, STRATEGIC, ENTRY_LEVEL_MANAGER, EXPERIENCED_MANAGER, DIRECTOR, VICE_PRESIDENT, CXO, OWNER_PARTNER.

Available options:

IN_TRAINING,

ENTRY_LEVEL,

SENIOR,

STRATEGIC,

ENTRY_LEVEL_MANAGER,

EXPERIENCED_MANAGER,

DIRECTOR,

VICE_PRESIDENT,

CXO,

OWNER_PARTNER,

null

educations

string | null

Education history used by the AI playbook.

previousPositions

string | null

Previous positions used by the AI playbook.

countryCode

string | null

Country code associated with the identity context.

signature

string | null

Email signature HTML. Enginy stores this exact HTML in signature. Send null to clear the signature.

Response

Identity updated successfully

status

enum<string>

required

Available options:

success

message

string

required

data

object

required

Show child attributes

Get identity performance metrics Get identity mailboxes

API documentation

Endpoints

Update identity

Authorizations

Path Parameters

Body

Response