Developers API reference Version 1 · generated from the code openapi.json
Routes

organisation

Add a member

POST /api/v1/organisation/members

Give a root role to an address. An address with no account gets one and an invitation; an existing account is told. An address attached to another organisation is refused.

Required scope: org:admin

Request body application/json

  • email string · required

    Address of the person.

  • role string · required

    The root role to give them.

  • first_name string · optional

    First name, for an address with no account yet.

  • last_name string · optional

    Last name, for an address with no account yet.

Response

201 Member

  • id integer

    Id of the member.

  • email string

    Their address.

  • first_name string

    First name; may be empty.

  • last_name string

    Last name; may be empty.

  • role string

    Root role: admin, editor or reader.

  • registered boolean

    false while the person has not accepted their invitation.

Errors

  • 401

    No valid credential.

  • 403

    The credential lacks the required scope, or the account may not do this.

  • 409

    The current state of the content forbids the request.

  • 422

    A value is missing or malformed.

  • 429

    Too many requests; Retry-After gives the seconds to wait.

planner_banner_ad_pt