Buttondown logo

Introduction

Users represent the team members on a Buttondown account, along with their permission levels. Use the /users endpoints to list, retrieve, create, update, and delete teammates.

Invitation statuses

flowchart
  pending e1@--> accepted
  pending e2@--> declined
  pending e3@--> revoked
  owner
  e1@{ animate: true }
  e2@{ animate: true }
  e3@{ animate: true }

{
    "id": "13121cd6-0dfc-424c-bb12-988b0a32fcb3",
    "creation_date": "2020-09-01T00:00:00+00:00",
    "email_address": "owner@buttondown.email",
    "permissions": {
        "subscriber": "write",
        "email": "write",
        "sending": "write",
        "styling": "write",
        "administrivia": "write",
        "automations": "write",
        "surveys": "write"
    },
    "status": "owner",
    "last_logged_in": "2020-09-29T12:00:00+00:00"
}

Fields

permissionsPermissions

email_addressstring

The email address of the user.

idstring

A unique TypeID associated with the object.

creation_datestring

The date and time at which the object was first created.

statusstring · enum

The status of the user's invitation (e.g. pending, accepted).

values
  • pending

    The invitation has been sent but not yet responded to by the recipient.

  • accepted

    The invitation has been accepted by the recipient.

  • declined

    The invitation has been declined by the recipient.

  • revoked

    The invitation has been revoked by the sender before being accepted.

  • owner

    Special status indicating the user is the owner of the newsletter.

last_logged_instring

When the user last logged in, or null if they haven't accepted the invitation.