Release Candidate — the API is undergoing final validation before general availability, and minor changes may still occur.
Hellomateo API Documentation
Deals

Update Deal By Locator

PATCH
/v1/deals/by

Custom fields can be written as additional top-level properties using each custom field key. Values are validated against the field definitions returned by List Custom Fields.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

id?string

Unique identifier for the resource.

Formatuuid
external_id?string

Identifier assigned by an external system.

Length1 <= length
include_details?array<string>

Dynamic detail fields to include. Use repeated query syntax: include_details=foo&include_details=bar.

Itemsitems <= 10

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Human-readable name of the resource.

external_id?|

Identifier assigned by an external system.

status_key?string

Status Key value for this resource.

Length1 <= length
type_key?string

Type Key value for this resource.

Length1 <= length
assignee_id?|

Unique identifier of the related assignee.

contact_id?string

Unique identifier of the related contact.

Formatuuid
value?||

Value value for this resource.

currency?"CHF" | "EUR" | "USD"

Currency value for this resource.

won_at?|

Timestamp for won at.

lost_at?|

Timestamp for lost at.

[key: string]?unknown

Response Body

application/json

curl -X PATCH "https://api.getmateo.com/v1/deals/by" \  -H "Content-Type: application/json" \  -d '{    "property1": null,    "property2": null  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "external_id": "string",  "name": "string",  "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",  "assignee_id": "e209ca2d-190b-4818-b659-67d4ef4f1ce8",  "type_key": "string",  "status_key": "string",  "value": 0,  "currency": "CHF",  "won_at": "2019-08-24T14:15:22Z",  "lost_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "property1": null,  "property2": null}