POST/api/v1/contacts

Crear Contacto

Crea un nuevo contacto.

Autenticación

Envía tu API key en el header x-api-key header.

x-api-keybearer

Cuerpo de la petición

obligatorio

PublicApiCreateContactDto

firstName

string

First name of the contact

lastName

string

Last name of the contact

salutation

string

Salutation of the contact

birthday

string (date-time)

Birthday of the contact

emailrequired

string

Email address of the contact

phone

string

Phone number of the contact

genderIdentity

string

Gender identity of the contact

pronouns

string

Pronouns of the contact

fax

string

Fax number of the contact

linkedinUrl

string

LinkedIn URL of the contact

address

string

Address of the contact

postalCode

string

Postal code of the contact

city

string

City of the contact

state

string

State of the contact

country

string

Country of the contact

currency

string

Currency preference of the contact

titlePosition

string

Title/Position of the contact

language

string

Language preference of the contact

assistant

string

Assistant name of the contact

assistantPhone

string

Assistant phone number

division

string

Division of the contact

department

string

Department of the contact

description

string

Description of the contact

leadSource

string

Lead source of the contact

leadRecordType

string

Lead record type

reportsTo

string

Reports to contact ID

Ejemplo de petición

json

{
  "firstName": "John",
  "lastName": "Doe",
  "salutation": "Mr.",
  "birthday": "1990-01-15T00:00:00.000Z",
  "email": "john.doe@example.com",
  "phone": "+1-555-123-4567",
  "genderIdentity": "Male",
  "pronouns": "he/him",
  "fax": "+1-555-123-4568",
  "linkedinUrl": "https://linkedin.com/in/johndoe",
  "address": "123 Main Street",
  "postalCode": "12345",
  "city": "New York",
  "state": "NY",
  "country": "United States",
  "currency": "USD",
  "titlePosition": "Software Engineer",
  "language": "English",
  "assistant": "Jane Smith",
  "assistantPhone": "+1-555-123-4569",
  "division": "Engineering",
  "department": "Software Development",
  "description": "Senior software engineer with 5 years of experience",
  "leadSource": "Website",
  "leadRecordType": "Lead",
  "reportsTo": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
}

Respuestas

201

PublicApiCreateContactResponseDto

statusCoderequired

number

countrequired

number

errorrequired

string

datarequired

PublicApiContactDto

Ejemplo de respuesta

json

{
  "statusCode": 200,
  "count": 0,
  "error": null,
  "data": {
    "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "firstName": "John",
    "lastName": "Doe",
    "salutation": "Mr.",
    "birthday": "1990-01-15T00:00:00.000Z",
    "email": "john.doe@example.com",
    "phone": "+1-555-123-4567",
    "genderIdentity": "Male",
    "pronouns": "he/him",
    "fax": "+1-555-123-4568",
    "linkedinUrl": "https://linkedin.com/in/johndoe",
    "address": "123 Main Street",
    "postalCode": "12345",
    "city": "New York",
    "state": "NY",
    "country": "United States",
    "currency": "USD",
    "titlePosition": "Software Engineer",
    "language": "English",
    "assistant": "Jane Smith",
    "assistantPhone": "+1-555-123-4569",
    "division": "Engineering",
    "department": "Software Development",
    "description": "Senior software engineer with 5 years of experience",
    "leadSource": "Website",
    "leadRecordType": "Lead",
    "reportsTo": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-01-15T10:00:00.000Z",
    "personId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
  }
}

401No autorizado - clave API o token Bearer faltante o inválido