Update a contact

PATCH 
/api/contact/:id

• crm.edit: allows edit resources.

Here the dedicated support page.

Request

Path Parameters

id integerrequired

The ID of the contact to update

Header Parameters

Wethod-Company stringrequired

The company you want to interact with

Wethod-Version stringrequired

The API version you want to use

application/json

Body

email string

Email of the contact

name string

Name of the contact

surname string

Surname of the contact

role string

Role of the contact

notes string

Notes of the contact

linkedin string

Linkedin of the contact

description string

Description of the contact

client_id integer

ID of the client to associate with this contact

Responses

200

Returns the contact updated.

application/json

Schema

Schema

id integerrequired

Possible values: >= 1

created_at date-timerequired
updated_at date-timerequired
client_id integerrequired

Possible values: >= 1

ID of the client

email stringrequired

Possible values: <= 150 characters

name stringrequired

Possible values: <= 100 characters

surname stringrequired

Possible values: <= 100 characters

role string

Possible values: <= 75 characters

notes string
linkedin string

Possible values: <= 250 characters

description string
telephone integer

Possible values: <= 100 characters

Example (from schema)

{
  "id": 1,
  "created_at": "2025-01-21T10:16:02.250Z",
  "updated_at": "2025-01-21T10:16:02.250Z",
  "client_id": 1,
  "email": "client@email.com",
  "name": "Client name",
  "surname": "Client surname",
  "role": "Client role",
  "notes": "Some notes about the client",
  "linkedin": "https://www.linkedin.com/in/example",
  "description": "A brief description of the client",
  "telephone": "123456789"
}

400

Validation failed

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

failures

object[]

List of validation errors

Array [

field string

Name of the field causing the error

message string

Human-readable description of the error

]

Example (from schema)

{
  "key": "invalid_data",
  "message": "You provided invalid data. Check 'failures' for details.",
  "failures": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

Loading...