Organization operations

Preview an organization operation and obtain a confirmation

Organization, member and invitation changes need two calls. This one reports the concrete changes, the side effects, the warnings and the conditions, and returns a confirmation valid for five minutes. Send it back in the X-Mencoro-Confirmation header, together with an Idempotency-Key, on the call that performs the operation. Previewing has no effects of any kind.

post/api/v1/organization-operation-previews

Request

  • Base URL: https://api.mencoro.com
  • URL: https://api.mencoro.com/api/v1/organization-operation-previews
  • Auth: HTTP bearer

Request body

action'createOrganization' | 'updateOrganization' | 'archiveOrganization' | 'restoreOrganization' | 'changeMemberRole' | 'suspendMember' | 'reactivateMember' | 'createInvitation' | 'cancelInvitation'
organizationIdstring uuid nullable

Required for every action except createOrganization.

resourceIdstring uuid nullable

The member or invitation the action acts on, for the actions that name one.

payloadobject

The body you intend to send to the operation itself.

Response

What the operation would do, plus a confirmation

actionstring
resourceIdstring uuid nullable

The member or invitation the action acts on; null for the actions that name none.

actorobject

Who the confirmation is issued to: the user and the API key. It is valid for that pair only.

confirmationobject

The token to send back, the header to send it in, and how long it lives.

Example response

{
  "changes": [
    {
      "code": "projects_will_be_archived"
    }
  ],
  "sideEffects": [
    {
      "code": "projects_will_be_archived"
    }
  ],
  "warnings": [
    {
      "code": "projects_will_be_archived"
    }
  ],
  "conditions": [
    {
      "code": "projects_will_be_archived"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.