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

sharing

Send the pending invitations of a binder

POST /api/v1/binders/{entity_id}/sharing/invitations/send

Email the invited addresses that have no account yet: all of them, or those listed in emails. rate_limited says the mail quota cut the sending short.

Required scope: share

Path parameters

  • entity_id integer · required

    Id of the binder or flow.

Request body application/json

  • emails array of string or null · optional

    Only these invited addresses. Left out: all of them.

  • message string · optional

    A few words added to the invitation.

Response

200 InvitationsSent

  • sent integer

    Number of invitations that left.

  • rate_limited boolean

    Whether the mail quota cut the sending short; the rest can be sent later.

Errors

  • 401

    No valid credential.

  • 403

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

  • 404

    Nothing with that id, or nothing the account may open.

  • 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