PATCH /portal/user/{email}ΒΆ

Update a user.

Path parameters:

Name

Type

Description

email

string, required

retailer portal user email address

Query parameters:

Name

Type

Description

pretty

boolean, optional, default: false

readable output formatting

Body parameters:

Name

Type

Description

group

string, optional

group this user belongs to

status

string, optional

user status

  • groups and group names must be configured before this api can be used, please contact your Yocuda representative

  • an empty group name "" can be used to indicate that the user is not a member of any group

  • status can be one of active or inactive

Possible responses:

  • 204 - if a user was updated

  • 400 - if the payload is incorrect, e.g.:
    • the group is invalid

    • the status is invalid

  • 404
    • the user already exists, but is not manageable by this api

    • if the user does not already exist

Example request:

Update a user.

PATCH /portal/user/me@example.com HTTP/1.1
Host: api.ereceipts.co.uk
Accept: application/json
Content-Length: 41
Content-Type: application/json

{
  "group": "",
  "status": "inactive"
}

Example response:

HTTP/1.1 204 No Content