BUbuttondown
Users

Create User

Changed on

Invite a new user to the newsletter

post/users

Request

  • Base URL
    https://api.buttondown.com/v1
  • URL
    https://api.buttondown.com/v1/users
  • Auth
    API key in header Authorization

Request body

email_addressstring required

The email address of the user.

Response

Created

email_addressstring required

The email address of the user.

idstring required

A unique TypeID associated with the object.

creation_datestring date-time required

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

status'pending' | 'accepted' | 'declined' | 'revoked' | 'owner' required

An enumeration.

last_logged_instring date-time nullable

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

Changes

  • 228cc05ba97dRevision changes
    • info

      added the non-success response with the status

  • 13f3bc084194Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      response property last_logged_in list-of-types was widened by adding types null to media type application/json of response 201

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from string to no type for status

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      the endpoint scheme security PermissionAuthenticationRequirement was removed from the API

    • info

      api tag Users added

    • info

      added the non-success response with the status

    • info

      added to the response property allOf list for the response status

    • info

      removed the email_already_exists enum value from the response property for the response status