> ## Documentation Index
> Fetch the complete documentation index at: https://docs.reply.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Create a contact
> _Requires the `contacts:write` scope (or a broader one that includes it)._
Creates a new contact. All fields are optional — at minimum provide email or a LinkedIn URL.
## OpenAPI
````yaml /api-reference/bundled.yaml post /v3/contacts
openapi: 3.1.0
info:
version: 3.0.0
title: Reply API
description: API for managing email sequences, contacts, and automation workflows
servers:
- url: https://api.reply.io
security:
- bearerAuth: []
tags:
- name: User Account
description: Account information and authentication verification
- name: Accounts
description: Manage accounts (companies/organizations)
- name: AI SDR Insights
description: Read AI SDR insights for sequence contacts
- name: AI SDR Intent Signals
description: >-
Read Reply industry IDs and technology slugs used in AI SDR intent-signal
configuration (typeahead)
- name: AI SDR Sequences
description: >-
Manage AI SDR sequences and their AI SDR-specific settings — create, read
settings, partial update, autopilot enable/disable/force-start, approval
mode, generated step types, and playbook/knowledge-base connections
- name: AI SDR Web Search
description: Find contacts via AI-driven web search and review past searches
- name: Attachments
description: >-
Upload file attachments used across email templates, sequence steps, and
direct emails
- name: Account Lists
description: Manage account lists and account membership
- name: Background Jobs
description: >-
Track and cancel asynchronous background operations (e.g., email
validation)
- name: Custom Fields
description: Manage custom contact fields
- name: Direct Outreach
description: >-
Send one-off outreach directly to a contact outside of any sequence —
direct emails and LinkedIn connection requests, messages, InMails, and
voice messages
- name: Contact Blacklist Rules
description: Manage blacklist rules for domains, emails, and email exceptions
- name: Contact Enrichment
description: >-
Enrich contacts with emails, phone numbers, LinkedIn data, and AI-filled
custom fields
- name: Contact Lists
description: Manage contact lists and contact membership
- name: Contacts
description: Manage individual contacts
- name: Email Accounts
description: Manage email accounts used for sending and receiving
- name: Email Templates
description: Manage email templates and template folders
- name: Email Validations
description: Estimate and schedule asynchronous email validation jobs
- name: Holiday Calendars
description: Manage holiday calendars for scheduling
- name: Inbox
description: >-
Manage inbox threads and per-team thread categories — list/filter, read
state, replies, category assignment, and meeting-intent flagging
- name: LinkedIn Accounts
description: Manage LinkedIn accounts for outreach
- name: Live Data
description: >-
Find new contacts via Live Data searches and read typeahead values for the
Live Data / Autopilot filter sidebar
- name: AI SDR Knowledge Bases
description: >-
Manage AI SDR knowledge bases — collections of documents, links, reply
handlers, and reengagement cards that inform the agent's responses
- name: AI SDR Offers
description: >-
Manage AI SDR offers — bundles of company-context inputs (ICP, pain
points, value propositions, etc.) used to personalize outreach
- name: AI SDR Pending Approvals
description: >-
Review, send, regenerate, and provide feedback on AI-generated messages
awaiting human approval
- name: AI SDR Playbooks
description: >-
Manage AI SDR playbooks — tone, voice, and style guides applied during
personalized message generation
- name: Reports
description: >-
Generate and access performance reports across email, calls, tasks,
LinkedIn, and team performance
- name: Schedules
description: Manage email send schedules and timing
- name: Settings
description: Manage team and user settings
- name: Sequence Contacts
description: Manage contacts within sequences
- name: Sequence Email Accounts
description: Manage email accounts linked to sequences
- name: Sequence Folders
description: Organize sequences into folders
- name: Sequence LinkedIn Accounts
description: Manage LinkedIn accounts linked to sequences
- name: AI SDR Sequence Preview
description: >-
Read and regenerate per-contact previews of the messages a sequence will
send, and provide feedback on preview messages
- name: Sequence Steps
description: Manage individual steps in sequences
- name: Sequence Templates
description: Manage sequence templates
- name: Sequences
description: Manage email automation sequences
- name: AI SDR Strategist
description: Trigger AI Strategist runs
- name: Tasks
description: Manage tasks and to-do items
- name: Webhooks
description: Manage webhook subscriptions and inspect delivery history
paths:
/v3/contacts:
post:
tags:
- Contacts
summary: Create a contact
description: >-
_Requires the `contacts:write` scope (or a broader one that
includes it)._
Creates a new contact. All fields are optional — at minimum provide
email or a LinkedIn URL.
operationId: CreateContact
requestBody:
required: true
content:
application/json:
schema:
type: object
title: Contact Creation Request
description: >-
Request model for creating a new contact. All fields are
optional — at minimum provide email or a LinkedIn URL.
properties:
email:
type: string
format: email
description: Primary email address
firstName:
type: string
description: First name
lastName:
type: string
description: Last name
phone:
type: string
description: Phone number
phone2:
type: string
description: Secondary phone number
title:
type: string
description: Job title
company:
type: string
description: Organization name
companySize:
type: string
enum:
- Empty
- SelfEmployed
- Ten
- Fifty
- TwoHundred
- FiveHundred
- OneThousand
- FiveThousand
- TenThousand
- OverTenThousand
description: Organization employee count range
industry:
type: string
description: Business sector
city:
type: string
description: City of residence
state:
type: string
description: State/province
country:
type: string
description: Country
timeZoneId:
type: string
description: Timezone identifier
linkedInUrl:
type: string
format: uri
description: LinkedIn profile URL
linkedInSalesNavigatorUrl:
type: string
format: uri
description: Sales Navigator URL
linkedInRecruiterUrl:
type: string
format: uri
description: Recruiter URL
notes:
type: string
description: Additional information
accountId:
type: integer
nullable: true
description: ID of the contact account to link this contact to
customFields:
type: array
items:
type: object
properties:
key:
type: string
description: Field identifier
value:
type: string
nullable: true
description: Field content
required:
- key
description: User-defined fields
example:
email: john.doe@company.com
firstName: John
lastName: Doe
title: Senior Product Manager
company: Tech Solutions Inc
phone: +1-415-555-0123
linkedInUrl: https://www.linkedin.com/in/johndoe
accountId: 100
customFields:
- key: leadSource
value: Conference
responses:
'201':
description: Contact created successfully
content:
application/json:
schema:
type: object
title: Contact
description: Contact response model
properties:
id:
type: integer
readOnly: true
description: Unique ID
email:
type: string
format: email
description: Primary email address
domain:
type: string
readOnly: true
description: Email domain (derived from email)
firstName:
type: string
description: First name
lastName:
type: string
description: Last name
phone:
type: string
description: Phone number
title:
type: string
description: Job title
company:
type: string
description: Organization name
companySize:
type: string
enum:
- empty
- selfEmployed
- ten
- fifty
- twoHundred
- fiveHundred
- oneThousand
- fiveThousand
- tenThousand
- overTenThousand
description: Organization employee count range
industry:
type: string
description: Business sector
city:
type: string
description: City of residence
state:
type: string
description: State/province
country:
type: string
description: Country
timeZoneId:
type: string
description: Timezone identifier
linkedInUrl:
type: string
format: uri
description: LinkedIn profile URL
linkedInSalesNavigatorUrl:
type: string
format: uri
description: Sales Navigator URL
linkedInRecruiterUrl:
type: string
format: uri
description: Recruiter URL
phoneStatus:
type: string
enum:
- pending
- invalid
- valid
- validationFailed
- notValidated
description: Phone validation status
notes:
type: string
description: Additional information
ownerUserId:
type: integer
description: ID of the user who owns this contact
accountId:
type: integer
nullable: true
description: ID of the contact account this contact belongs to
isOptedOut:
type: boolean
readOnly: true
description: Whether the contact has opted out of communications
callStatus:
type: string
allOf:
- type: string
title: Contact Call Status
description: >-
Contact-level call status. Set via `PATCH
/v3/contacts/{id}` (`callStatus` field). Pass `none`
to clear.
enum:
- none
- toCall
- called
description: Contact-level call status
meetingStatus:
type: string
allOf:
- type: string
title: Contact Meeting Status
description: >-
Contact-level meeting status. Set via `PATCH
/v3/contacts/{id}` (`meetingStatus` field). Pass
`none` to clear.
enum:
- none
- meetingBooked
description: Contact-level meeting status
addingDate:
type: string
format: date-time
readOnly: true
nullable: true
description: Date the contact was added
createdAt:
type: string
format: date-time
readOnly: true
nullable: true
description: Creation timestamp
lastModifiedAt:
type: string
format: date-time
readOnly: true
nullable: true
description: Last modification timestamp
customFields:
type: array
items:
type: object
properties:
key:
type: string
description: Field identifier
value:
type: string
nullable: true
description: Field content
required:
- key
description: User-defined fields
example:
id: 12345
email: john.doe@company.com
firstName: John
lastName: Doe
title: Senior Product Manager
company: Tech Solutions Inc
domain: company.com
companySize: oneThousand
city: San Francisco
state: CA
country: United States
timeZoneId: America/Los_Angeles
phone: +1-415-555-0123
phoneStatus: valid
linkedInUrl: https://www.linkedin.com/in/johndoe
linkedInSalesNavigatorUrl: https://www.linkedin.com/sales/profile/123456
linkedInRecruiterUrl: https://www.linkedin.com/recruiter/profile/789012
industry: Software & Technology
notes: Met at SaaS Conference 2024
ownerUserId: 42
accountId: 100
isOptedOut: false
callStatus: toCall
meetingStatus: none
addingDate: '2024-03-08T10:00:00+00:00'
createdAt: '2024-03-08T10:00:00'
lastModifiedAt: '2024-03-10T15:30:00'
customFields:
- key: leadSource
value: Conference
- key: budget
value: 100k-250k
'400':
description: |-
Validation failure on the request body, or a business rule rejection
(e.g. contact already exists, missing required identifier).
content:
application/problem+json:
schema:
oneOf:
- allOf:
- allOf:
- type: object
title: Problem Details
description: >-
Bare RFC 9457 problem-details envelope. Returned
by middleware-level errors
that don't carry domain context: 401 Unauthorized
(auth middleware),
429 Too Many Requests (rate-limit middleware), and
route-level 404 / 405 /
415 (framework middleware).
Business and validation responses extend this
envelope and add additional
fields — see `business-problem.model.yaml` (adds
`code` slug) and
`validation-problem.model.yaml` (adds `errors[]`
array).
properties:
title:
type: string
description: Short, human-readable summary of the problem.
status:
type: integer
description: HTTP status code.
minimum: 100
maximum: 599
detail:
type: string
description: >-
Human-readable explanation specific to this
occurrence.
- type: object
properties:
errors:
type: array
description: >-
List of field-level validation errors. Always
non-empty when this
envelope is returned. Each entry pins a single
offending field
via JSON Pointer plus a sanitized detail
string.
items:
type: object
title: Validation Error
description: A single field-level validation error.
properties:
pointer:
type: string
description: >-
JSON Pointer (RFC 6901) to the offending
field — e.g.
`/steps/0/subject`.
* An empty string (`""`) means the error
applies to the whole
request body (e.g. body is missing or unparseable).
* For route or query parameter failures
the pointer is the parameter
name (e.g. `id`, `top`).
example: /steps/0/subject
detail:
type: string
description: >-
Sanitized, human-readable explanation of
this field's error. One of a
small set of templates — `"Field is
required."`, `"Value has an
invalid type."`, `"Value has an invalid
format."`, `"Request body is
not valid JSON."`, `"The request body is
required and cannot be
empty."` — or a FluentValidator message
on body endpoints.
example: Field is required.
title: Validation Problem
description: >-
Input-validation error response at 400. Returned when
the request body
fails binding, FluentValidator rules, or when
route/query parameter
attribute validation (`[Range]`, `[Required]`) fails.
Route, query, and
body errors are combined into a single `errors[]`
array — clients should
not assume one error per request.
- example:
title: Validation failed
status: 400
detail: The request body contains validation errors.
errors:
- pointer: /name
detail: Field is required.
- allOf:
- allOf:
- type: object
title: Problem Details
description: >-
Bare RFC 9457 problem-details envelope. Returned
by middleware-level errors
that don't carry domain context: 401 Unauthorized
(auth middleware),
429 Too Many Requests (rate-limit middleware), and
route-level 404 / 405 /
415 (framework middleware).
Business and validation responses extend this
envelope and add additional
fields — see `business-problem.model.yaml` (adds
`code` slug) and
`validation-problem.model.yaml` (adds `errors[]`
array).
properties:
title:
type: string
description: Short, human-readable summary of the problem.
status:
type: integer
description: HTTP status code.
minimum: 100
maximum: 599
detail:
type: string
description: >-
Human-readable explanation specific to this
occurrence.
- type: object
properties:
code:
type: string
description: >-
Stable, machine-readable error slug in the
form
`"."`.
* `resource` is the camelCased domain — e.g.
`sequence`,
`contact`, `inboxThread`, `blacklistDomainRule`.
* `variant` is the camelCased specific failure
mode — e.g.
`notFound`, `forbidden`, `duplicateName`, `globalRuleReadOnly`.
Use `code` for programmatic error handling;
use `detail` for
user-facing messages. Slugs are stable across
server-side enum
reorderings and never change meaning under a
given resource.
pattern: ^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)+$
example: sequence.notFound
title: Business Problem
description: >-
Domain error response carrying a stable, namespaced
error slug.
Emitted for most 4xx responses (business 400, 403,
404, 409, …) and
for 503 when a downstream dependency is unavailable.
- example:
title: Bad Request
status: 400
detail: Pagination parameters are invalid.
code: sequence.invalidPagination
examples:
validation_failed:
summary: Body validation failure (FluentValidator)
value:
title: Validation failed
status: 400
detail: The request body contains validation errors.
errors:
- pointer: /email
detail: '''email'' is not a valid email address.'
business_invalid_input:
summary: Domain rule rejection
value:
title: Bad Request
status: 400
detail: A contact must have at least an email or a LinkedIn URL.
code: contact.invalidInput
'401':
description: >-
Unauthorized. The response body is empty; check the
`WWW-Authenticate` header for the expected scheme.
content:
application/problem+json:
schema:
allOf:
- type: object
title: Problem Details
description: >-
Bare RFC 9457 problem-details envelope. Returned by
middleware-level errors
that don't carry domain context: 401 Unauthorized (auth
middleware),
429 Too Many Requests (rate-limit middleware), and
route-level 404 / 405 /
415 (framework middleware).
Business and validation responses extend this envelope and
add additional
fields — see `business-problem.model.yaml` (adds `code`
slug) and
`validation-problem.model.yaml` (adds `errors[]` array).
properties:
title:
type: string
description: Short, human-readable summary of the problem.
status:
type: integer
description: HTTP status code.
minimum: 100
maximum: 599
detail:
type: string
description: >-
Human-readable explanation specific to this
occurrence.
- example:
title: Unauthorized
status: 401
detail: Authentication credentials are missing or invalid.
'403':
description: User lacks required feature scope to create contacts
content:
application/problem+json:
schema:
allOf:
- allOf:
- type: object
title: Problem Details
description: >-
Bare RFC 9457 problem-details envelope. Returned by
middleware-level errors
that don't carry domain context: 401 Unauthorized
(auth middleware),
429 Too Many Requests (rate-limit middleware), and
route-level 404 / 405 /
415 (framework middleware).
Business and validation responses extend this envelope
and add additional
fields — see `business-problem.model.yaml` (adds
`code` slug) and
`validation-problem.model.yaml` (adds `errors[]`
array).
properties:
title:
type: string
description: Short, human-readable summary of the problem.
status:
type: integer
description: HTTP status code.
minimum: 100
maximum: 599
detail:
type: string
description: >-
Human-readable explanation specific to this
occurrence.
- type: object
properties:
code:
type: string
description: >-
Stable, machine-readable error slug in the form
`"."`.
* `resource` is the camelCased domain — e.g.
`sequence`,
`contact`, `inboxThread`, `blacklistDomainRule`.
* `variant` is the camelCased specific failure
mode — e.g.
`notFound`, `forbidden`, `duplicateName`, `globalRuleReadOnly`.
Use `code` for programmatic error handling; use
`detail` for
user-facing messages. Slugs are stable across
server-side enum
reorderings and never change meaning under a given
resource.
pattern: ^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)+$
example: sequence.notFound
title: Business Problem
description: >-
Domain error response carrying a stable, namespaced error
slug.
Emitted for most 4xx responses (business 400, 403, 404,
409, …) and
for 503 when a downstream dependency is unavailable.
- example:
title: Forbidden
status: 403
detail: You do not have permission to access this resource.
code: sequence.forbidden
example:
title: Forbidden
status: 403
detail: Feature scopes [AddProspect] are denied for userId 123.
code: contact.forbidden
'429':
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before retrying
schema:
type: integer
minimum: 1
content:
application/problem+json:
schema:
allOf:
- type: object
title: Problem Details
description: >-
Bare RFC 9457 problem-details envelope. Returned by
middleware-level errors
that don't carry domain context: 401 Unauthorized (auth
middleware),
429 Too Many Requests (rate-limit middleware), and
route-level 404 / 405 /
415 (framework middleware).
Business and validation responses extend this envelope and
add additional
fields — see `business-problem.model.yaml` (adds `code`
slug) and
`validation-problem.model.yaml` (adds `errors[]` array).
properties:
title:
type: string
description: Short, human-readable summary of the problem.
status:
type: integer
description: HTTP status code.
minimum: 100
maximum: 599
detail:
type: string
description: >-
Human-readable explanation specific to this
occurrence.
example:
title: Too Many Requests
status: 429
detail: Rate limit exceeded. Retry after 60 seconds.
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
Authenticate every request with a Bearer token. Pass your Reply API key
in the
`Authorization` header:
```
Authorization: Bearer
```
Get your API key from the Reply dashboard: **Settings → API Key**.
````