Updates a Plural Contact in matteroTM using only the provided fields in the JSON body.
PATCH
https://my.mattero.com.au/public/api/v1/contacts/plural/{id}
Name | Location | Type | Description |
---|---|---|---|
id | Route | string:required | The unique identifier associated with a Contact. |
name | Body | string:optional | The name of the plural contact |
memberIds | Body | string[]:optional | The member contacts associated with this plural contact. |
website | Body | string:optional | The website url associated with the contact. |
notes | Body | string:optional | Notes made against the associated contact. |
abn | Body | string:optional | The Australian Business Number associated with the contact. |
addresses | Body | Address[]:optional | A list of physical addresses associated with the contact. |
phones | Body | string[]:optional | A list of phone numbers associated with the contact. |
emails | Body | string[]:optional | A list of email addresses associated with the contact. |
customFields | Body | Dictionary:optional | A list of custom fields and their associated values as defined in Mattero. |
Address object
Name | Type | Description |
---|---|---|
regionCode | string | Required. CLDR region code of the country/region of the address. |
administrativeArea | string | Generally refers to the state or region of the address. |
locality | string | Generally refers to the city/town portion of the address. |
subLocality | string | Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. |
postalCode | string | Postal code of the address. |
line1 | string | Line1 of unstructured address lines describing the lower levels of an address. The order of address lines should be "envelope order" for the country/region of the address. |
line2 | string | Line2 of unstructured address lines describing the lower levels of an address. |
{
"regionCode": "AU",
"administrativeArea": "WA",
"locality": "Newman",
"subLocality": "",
"postalCode": "6753",
"line1": "742 Evergreen Terrace",
"line2": ""
}
Code | Summary | Description |
---|---|---|
204 | No Content | The request was successful, no body in response. |
400 | Bad Request | The request failed validation checks. |
401 | Unauthorized | Failed authentication check. |
403 | Forbidden | Failed authorization check. |
404 | Not Found | Either couldn't find the endpoint or the query's entity. |