> ## Documentation Index
> Fetch the complete documentation index at: https://docs.enginy.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# 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
## OpenAPI
````yaml https://openapi.enginy.ai/definitions.json patch /v1/identities/{identityId}
openapi: 3.1.0
info:
title: Enginy API
version: 1.0.0
description: Public API for Enginy platform
servers:
- url: https://openapi.enginy.ai
description: Configured server
security: []
tags:
- name: AI Variables
description: >-
Manage AI variables and discover the entity fields you can reference in
prompts and entity requests.
- name: Inbox
description: >-
Inbox endpoints for listing contact threads, reading thread messages,
managing tags, and sending manual replies.
- name: Workflows
description: >-
Build, validate, publish, run, and inspect advanced (graph) workflows,
plus the block/condition catalog needed to author a workflow plan.
paths:
/v1/identities/{identityId}:
patch:
tags:
- Identities
summary: Update identity
description: >-
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
parameters:
- schema:
type: string
description: The identity ID to update.
required: true
description: The identity ID to update.
name: identityId
in: path
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type:
- string
- 'null'
description: Full display name for the identity.
firstName:
type:
- string
- 'null'
description: First name for the identity.
lastName:
type:
- string
- 'null'
description: Last name for the identity.
jobTitle:
type:
- string
- 'null'
description: Current job title for the identity.
email:
type:
- string
- 'null'
format: email
description: Primary email address for the identity.
phoneNumber:
type:
- string
- 'null'
description: Phone number for the identity.
linkedInUrl:
type:
- string
- 'null'
description: LinkedIn profile URL for the identity.
scheduleMeetingUrl:
type:
- string
- 'null'
description: Meeting scheduling URL for the identity.
timezone:
type:
- string
- 'null'
description: Timezone used for identity scheduling context.
profileOverview:
type:
- string
- 'null'
description: Profile overview used by the AI playbook.
keyResponsibilities:
type:
- string
- 'null'
description: Responsibilities used by the AI playbook.
interests:
type:
- array
- 'null'
items:
type: string
description: Identity interests or professional functions.
languages:
type:
- array
- 'null'
items:
type: string
description: Languages associated with the identity.
gender:
type:
- string
- 'null'
enum:
- MALE
- FEMALE
- OTHER
- null
description: 'Identity gender value. Allowed values: MALE, FEMALE, OTHER.'
seniorityLevel:
type:
- string
- 'null'
enum:
- IN_TRAINING
- ENTRY_LEVEL
- SENIOR
- STRATEGIC
- ENTRY_LEVEL_MANAGER
- EXPERIENCED_MANAGER
- DIRECTOR
- VICE_PRESIDENT
- CXO
- OWNER_PARTNER
- null
description: >-
Identity seniority level. Allowed values: IN_TRAINING,
ENTRY_LEVEL, SENIOR, STRATEGIC, ENTRY_LEVEL_MANAGER,
EXPERIENCED_MANAGER, DIRECTOR, VICE_PRESIDENT, CXO,
OWNER_PARTNER.
educations:
type:
- string
- 'null'
description: Education history used by the AI playbook.
previousPositions:
type:
- string
- 'null'
description: Previous positions used by the AI playbook.
countryCode:
type:
- string
- 'null'
description: Country code associated with the identity context.
signature:
type:
- string
- 'null'
description: >-
Email signature HTML. Enginy stores this exact HTML in
`signature`. Send `null` to clear the signature.
additionalProperties: false
description: >-
Fields to update on an identity. Only public profile fields and
the email signature are writable through OpenAPI.
examples:
updateProfileAndSignature:
summary: Update identity profile fields and HTML signature
value:
name: Jane Doe
jobTitle: VP Sales
phoneNumber: '+34600000000'
signature: >-
Jane Doe
VP Sales at Enginy
enginy.ai
clearSignature:
summary: Clear an identity signature
value:
signature: null
responses:
'200':
description: Identity updated successfully
content:
application/json:
schema:
type: object
properties:
status:
type: string
enum:
- success
message:
type: string
data:
type: object
properties:
id:
type: number
description: Unique identifier for the identity
appUrl:
type: string
format: uri
description: Direct Enginy app URL for opening this identity.
name:
type:
- string
- 'null'
description: Full name of the identity
firstName:
type:
- string
- 'null'
description: First name of the identity
lastName:
type:
- string
- 'null'
description: Last name of the identity
jobTitle:
type:
- string
- 'null'
description: Job title of the identity
email:
type:
- string
- 'null'
description: Email address of the identity
phoneNumber:
type:
- string
- 'null'
description: Phone number of the identity
emails:
type: array
items:
type: string
description: >-
All mailbox email addresses associated with the
identity
linkedInUrl:
type:
- string
- 'null'
description: LinkedIn profile URL of the identity
scheduleMeetingUrl:
type:
- string
- 'null'
description: Meeting scheduling URL for the identity
timezone:
type:
- string
- 'null'
description: Timezone of the identity
profileOverview:
type:
- string
- 'null'
description: Identity profile overview used by the AI playbook
keyResponsibilities:
type:
- string
- 'null'
description: Identity responsibilities used by the AI playbook
interests:
type: array
items:
type: string
description: Identity interests or professional functions
languages:
type: array
items:
type: string
description: Languages associated with the identity
gender:
type:
- string
- 'null'
enum:
- MALE
- FEMALE
- OTHER
- null
description: Identity gender value, when configured
seniorityLevel:
type:
- string
- 'null'
enum:
- IN_TRAINING
- ENTRY_LEVEL
- SENIOR
- STRATEGIC
- ENTRY_LEVEL_MANAGER
- EXPERIENCED_MANAGER
- DIRECTOR
- VICE_PRESIDENT
- CXO
- OWNER_PARTNER
- null
description: Identity seniority level, when configured
educations:
type:
- string
- 'null'
description: Education history used by the AI playbook
previousPositions:
type:
- string
- 'null'
description: Previous positions used by the AI playbook
countryCode:
type:
- string
- 'null'
description: >-
Country code associated with the identity proxy or
context
signature:
type:
- string
- 'null'
description: >-
Email signature HTML appended to outbound emails sent
from this identity.
createdAt:
type: string
format: date-time
description: Date and time when the identity was created
linkedinAccess:
type: array
items:
type: string
enum:
- salesNav
- recruiter
- premium
- advertiseBadge
- hiringManagerMailbox
description: >-
LinkedIn access levels enabled for this identity (e.g.
`salesNav`, `recruiter`, `premium`). Empty when no
LinkedIn account is connected. Sales Navigator
(`salesNav`) is required to run AI Finder LinkedIn
searches.
linkedinSearchEnabled:
type: boolean
description: >-
Whether this identity can run AI Finder LinkedIn
searches — true when it has Sales Navigator access and
its LinkedIn credentials are not expired. Pass this
identity’s `id` as `identityId` to POST
/v1/ai-finder/previews to scope a LinkedIn list to
this account.
required:
- id
- appUrl
- name
- firstName
- lastName
- jobTitle
- email
- phoneNumber
- emails
- linkedInUrl
- scheduleMeetingUrl
- timezone
- profileOverview
- keyResponsibilities
- interests
- languages
- gender
- seniorityLevel
- educations
- previousPositions
- countryCode
- signature
- createdAt
- linkedinAccess
- linkedinSearchEnabled
required:
- status
- message
- data
'400':
description: Bad request - invalid identity ID or request body
'404':
description: Identity not found
security:
- apiKey: []
components:
securitySchemes:
apiKey:
type: apiKey
in: header
name: x-api-key
````