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

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjY3LCJhdWQiOlsiYWRtaW4iXSwiZXhwIjoxNzcyMjEyMDAxfQ.A4dmLJzFE-WwVzE8yClfYtrA6SFwSp39HNBj0JXKI7I
Host: example.org
Cookie: 

Route

PUT /api/rest/admin/contractors/34

Body

{"data":{"type":"contractors","id":34,"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/"d2db91c0d02b6fb8f45b452e2df134c1"
cache-control: max-age=0, private, must-revalidate
x-request-id: 58904fbd-cdd8-422c-8389-10e74a2b2b42
x-runtime: 0.012491
content-length: 473

Status

200 OK

Body

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