Update a customer

PATCH /customers/{id}

Update a customer by its ID

Headers

Path parameters

  • id string Required

    Primary identifier of the requested resource

    Minimum length is 1.

application/json

Body

Responses

PATCH /customers/{id}
curl \
 -X PATCH https://api.development.pexipengage.com/enterprises/acme/customers/1234 \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
 -H "Accept-Language: en *" \
 -d '{"externalId":"ABCD1234","customerNumber":"123456","email":"john.doe@pexip.com","firstName":"John","lastName":"Doe","company":"Acme Corp","language":"da","notes":"Lorem ipsum","phoneNumber":"+32412345678","existing":true,"timeZone":"Europe/Brussels","location":{"postalCode":"9000","countryCode":"BE","geolocation":{"latitude":51.0479466,"longitude":3.6912248},"translations":{"city":[{"language":"en","value":"Lorem ipsum"}],"state":[{"language":"en","value":"Lorem ipsum"}],"street1":[{"language":"en","value":"Lorem ipsum"}],"street2":[{"language":"en","value":"Lorem ipsum"}]}}}'
Request examples
# Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002
Accept-Language: en *

# Payload
{
  "externalId": "ABCD1234",
  "customerNumber": "123456",
  "email": "john.doe@pexip.com",
  "firstName": "John",
  "lastName": "Doe",
  "company": "Acme Corp",
  "language": "da",
  "notes": "Lorem ipsum",
  "phoneNumber": "+32412345678",
  "existing": true,
  "timeZone": "Europe/Brussels",
  "location": {
    "postalCode": "9000",
    "countryCode": "BE",
    "geolocation": {
      "latitude": 51.0479466,
      "longitude": 3.6912248
    },
    "translations": {
      "city": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ],
      "state": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ],
      "street1": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ],
      "street2": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ]
    }
  }
}
Response examples (200)
{
  "data": {
    "id": "123",
    "externalId": "ABCD1234",
    "customerNumber": "123456",
    "email": "john.doe@pexip.com",
    "firstName": "John",
    "lastName": "Doe",
    "company": "Acme Corp",
    "language": "da",
    "notes": "Lorem ipsum",
    "phoneNumber": "+32412345678",
    "existing": true,
    "timeZone": "Europe/Brussels",
    "createdAt": "2022-08-17T19:05:21.362Z",
    "updatedAt": "2022-08-17T19:05:21.362Z",
    "deletedAt": "2022-08-17T19:05:21.362Z",
    "location": {
      "city": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "state": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "street1": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "street2": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "postalCode": "9000",
      "countryCode": "BE",
      "formattedAddress": "string",
      "geolocation": {
        "latitude": 51.0479466,
        "longitude": 3.6912248
      },
      "translations": {
        "city": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ],
        "state": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ],
        "street1": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ],
        "street2": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ]
      }
    }
  }
}
Response examples (404)
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string"
    }
  ]
}
Response examples (422)
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string",
      "arguments": {}
    }
  ]
}