Update Contact

PATCH

/public/v1/contacts/{contact_id}

curl --request PATCH \
  --url https://api.aymaragents.com/public/v1/contacts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "fullName": "example", "email": "example", "marketingOptOut": true }'

• Producción

Partial update of fullName/email/marketingOptOut – the curated field set SPEC_API_PUBLICA.md §2.2 names for this endpoint.

Unknown/foreign/deleted -> 404.

---

Permiso necesario: tenant:contacts.manage

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

contact_id

required

Contact Id

string format: uuid

Request Body^required

Media typeapplication/json

PublicContactUpdateRequest

PATCH /public/v1/contacts/{id} body – all fields optional (partial update).

Curated to EXACTLY the three fields SPEC_API_PUBLICA.md §2.2 names for this endpoint (fullName/email/marketingOptOut) – narrower than the internal PATCH /customers/{id} on purpose (no signingEmail/country here, same curation reasoning as PublicLeadUpdateRequest).

object

fullName

Any of:

string

string

null

null

email

Any of:

string

string

null

null

marketingOptOut

Any of:

boolean

boolean

null

null

Example^generated

{
  "fullName": "example",
  "email": "example",
  "marketingOptOut": true
}

Responses

200

Successful Response

Media typeapplication/json

PublicContactOut

A single contact, curated subset of the internal CustomerOut.

Drops signingEmail (INT-PANDADOC-1 internal-integration concern, meaningless to a third party reading/writing contacts generically).

object

id

required

Id

string

fullName

Any of:

string

string

null

null

phone

Any of:

string

string

null

null

email

Any of:

string

string

null

null

country

Any of:

string

string

null

null

phoneVerifiedAt

Any of:

string

string

null

null

emailVerifiedAt

Any of:

string

string

null

null

marketingOptOut

required

Marketingoptout

boolean

marketingOptOutAt

Any of:

string

string

null

null

origin

required

Origin

string

createdAt

required

Createdat

string

Example^generated

{
  "id": "example",
  "fullName": "example",
  "phone": "example",
  "email": "example",
  "country": "example",
  "phoneVerifiedAt": "example",
  "emailVerifiedAt": "example",
  "marketingOptOut": true,
  "marketingOptOutAt": "example",
  "origin": "example",
  "createdAt": "example"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}