Skip to content
Hayonix

API reference · Invitations

Accept an invitation addressed to your verified email

POST/v1/orgs/{org_id}/invitations/{invitation_id}/accept
Console sessionOrganization

Makes you a member of the organization with the role the invitation names, and returns the new membership. An invitation addressed to someone else answers 404.

Console session only. The console calls this with a signed-in session; API keys are refused.

Request

Path parameters

  • org_idstring

    Your organization. The SDKs and the CLI fill it in from the API key.

    ID with prefix org_

  • invitation_idstringrequired

    ID of the invitation

    ID with prefix inv_

Response

200 Member — Your new membership

  • objectstringrequired

    Always `member`: the type of this object

    One ofmember

  • idstringrequired

    Unique ID (`mem_…`)

    ID with prefix mem_

  • org_idstringrequired

    Organization it belongs to

    ID with prefix org_

  • user_idstringrequired

    ID of the user

    ID with prefix usr_

  • roleRolerequired

    One ofowneradmindeveloperbillingviewer

  • userobjectrequired

    The user who holds this membership

    Show 3 fields of user
    • namestringrequired

      Its name

    • emailstringrequired

      Email address of the user

    • imagestring | nullrequired

      Container image reference

  • created_atstring (date-time)required

    When it was created (ISO 8601, UTC)

Example response
Example response
{
  "object": "member",
  "id": "mem_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "org_id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "user_id": "usr_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "role": "owner",
  "user": {
    "name": "string",
    "email": "string",
    "image": "string"
  },
  "created_at": "2026-01-01T00:00:00.000Z"
}

Errors

Errors use the standard envelope. What this operation can answer:

Errors
StatusTypeWhen
400invalid_request_errorA parameter or body field is missing or not allowed; param names it.
401authentication_errorThe key or session is missing, revoked or expired.
403permission_errorThe credential lacks the permission this needs, or the organization is suspended.
404not_found_errorNo such resource in this project (an ID from another project is answered the same way).
409conflict_errorThe resource's current state does not allow this.
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.