Update an end-user

Update an existing end-user entry

Request

PUT https://api.nexway.store/endusers/{id}

Path parameters

Parameter name Value Description Additional
id string

id

Required

Query parameters

Parameter name Value Description Additional
version int64

version

Request body

The request body takes a complete EndUserPut resource, containing the following writable properties:

{
    "accountCreated": "boolean",
    "city": "string",
    "company": {
        "cnpj": "string",
        "companyName": "string",
        "vatNumber": "string"
    },
    "country": "string",
    "cpf": "string",
    "createDate": "date-time",
    "dbVersion": "int64",
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "locale": "string",
    "originalId": "string",
    "streetAddress": "string",
    "updateDate": "date-time",
    "zipCode": "string"
}

Properties

Name Type Description Additional
accountCreated boolean Optional
city string

City

company object Company Optional
company.cnpj string

CPNJ

Optional
company.companyName string

End-user company name

company.vatNumber string

Company VAT number

Optional
country string

Country

cpf string

CPF value

createDate date-time Optional
dbVersion int64 Optional
email string

Email

firstName string

First name

id string Optional
lastName string

Last name

locale string

Locale used by end-user

originalId string Optional
streetAddress string

Street address

Optional
updateDate date-time Optional
zipCode string

Zip/postal code of town

Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

Success

EndUser
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error

Failure

Example

{
    "company": {}
}

Explore this API

id

id

version

version

endUserPut

endUserPut

Request Content-Type
Response Content-Type
Try it out!