---
title: "Create a member"
method: POST
path: "/v0.1/merchants/{merchant_code}/members"
tags: ["Members"]
---

# Create a member

`POST /v0.1/merchants/{merchant_code}/members`

Create a merchant member.

## Path parameters

- `merchant_code` string, required

## Request body

- object
  - `is_managed_user` boolean — True if the user is managed by the merchant. In this case, we'll created a virtual user with the provided password and nickname.
  - `email` string, email, required — Email address of the member to add.
  - `password` string, password — Password of the member to add. Only used if `is_managed_user` is true. In the case of service accounts, the password is not used and can not be defined by the caller.
  - `nickname` string — Nickname of the member to add. Only used if `is_managed_user` is true. Used for display purposes only.
  - `roles` string[], required — List of roles to assign to the new member.
  - `metadata` Metadata — Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always submit whole metadata. Maximum of 64 parameters are allowed in the object.
  - `attributes` Attributes — Object attributes that are modifiable only by SumUp applications.

## Response `201`

Returns the Member object if the creation succeeded.

- Member — A member is user within specific resource identified by resource id, resource type, and associated roles.
  - `id` string, required — ID of the member.
  - `roles` string[], required — User's roles.
  - `permissions` string[], required — User's permissions.
  - `created_at` string, date-time, required — The timestamp of when the member was created.
  - `updated_at` string, date-time, required — The timestamp of when the member was last updated.
  - `user` MembershipUser — Information about the user associated with the membership.
    - `id` string, required — Identifier for the End-User (also called Subject).
    - `type` 'user' | 'managed_user' | 'service_account' | 'system_account', required — Type of the user account.
    - `email` string, required — End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, for unique identification use ID instead.
    - `mfa_on_login_enabled` boolean, required — True if the user has enabled MFA on login.
    - `virtual_user` boolean, required — True if the user is a virtual user (operator).
    - `service_account_user` boolean, required — True if the user is a service account.
    - `disabled_at` string, date-time — Time when the user has been disabled. Applies only to virtual users (`virtual_user: true`).
    - `nickname` string — User's nickname. Used for display purposes only.
    - `picture` string, uri — URL of the End-User's profile picture. This URL refers to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image.
    - `classic` MembershipUserClassic — Classic identifiers of the user.
      - `user_id` integer, required
  - `invite` Invite — Pending invitation for membership.
    - `email` string, email, required — Email address of the invited user.
    - `expires_at` string, date-time, required
  - `status` 'accepted' | 'pending' | 'expired' | 'disabled' | 'unknown', required — The status of the membership.
  - `metadata` Metadata — Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always submit whole metadata. Maximum of 64 parameters are allowed in the object.
  - `attributes` Attributes — Object attributes that are modifiable only by SumUp applications.

## Other responses

- `400` — Invalid request.
- `404` — Merchant not found.
- `429` — Too many invitations were sent to that user and the rate limit was exceeded. The Retry-After header indicates when the client can retry.

---

[API](https://skmtc.net/sumup/apis/sumup-rest-api.md) · [All operations](https://skmtc.net/sumup/apis/sumup-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sumup/sumup-rest-api/versions/f50e1dc97523/schema)