Contractors API

update values

PUT /api/rest/admin/contractors/:id

Parameters

Name	Description
data[type]	Resource type (contractors)
data[id]	Contractor ID
data[attributes][name]	Name
data[attributes][vendor]	Vendor
data[attributes][customer]	Customer
data[attributes][enabled]	Enabled
data[attributes][description]	Description
data[attributes][address]	Address
data[attributes][phones]	Phones
data[attributes][external-id]	External id
data[relationships][smtp-connection]	Smtp connection

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjYyLCJhdWQiOlsiYWRtaW4iXSwiZXhwIjoxNzQwODUzMDI2fQ.erjNmfERKW7kPt7U1NzE7exj10EV2Y7GG2ZZcDMkDQQ
Host: example.org
Cookie: 

Route

PUT /api/rest/admin/contractors/32

Body

{"data":{"type":"contractors","id":32,"attributes":{"name":"name","customer":true}}}

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
ETag: W/"eb05fe6daf54d7e223a45d8e03319f4f"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 52cf2a45-3b36-4d65-a857-4d5249c09935
X-Runtime: 0.016029
Content-Length: 475

Status

200 OK

Body

{
  "data": {
    "id": "32",
    "type": "contractors",
    "links": {
      "self": "http://example.org/api/rest/admin/contractors/32"
    },
    "attributes": {
      "name": "name",
      "enabled": true,
      "vendor": true,
      "customer": true,
      "description": null,
      "address": null,
      "phones": null,
      "external-id": null
    },
    "relationships": {
      "smtp-connection": {
        "links": {
          "self": "http://example.org/api/rest/admin/contractors/32/relationships/smtp-connection",
          "related": "http://example.org/api/rest/admin/contractors/32/smtp-connection"
        },
        "data": null
      }
    }
  }
}