Team

Invite a team member

Changed on

Adds an existing Sequenzy user to the team directly, or emails an invitation to a new user. Requires owner or admin access.

post/team/invitations

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/team/invitations
  • Auth
    HTTP bearer

Request body

emailstring email required

Email address to invite.

role'admin' | 'marketer' | 'viewer' | 'restricted' required

Role for the new member. Marketers create, edit, and send campaigns and sequences and manage subscribers but cannot access transactional emails, settings, billing, or the team. Restricted members can open direct campaign links only.

canManageBillingboolean

Whether the member can manage billing. Only the company owner can grant this.

Response

Member added or invitation sent

successboolean

Example response

{
  "success": true,
  "member": {
    "id": "member_abc123"
  },
  "invitation": {
    "status": "pending"
  }
}

Changes

  • db3873ca3d4dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 8e23a15840faRevision changes
    • warning

      added the new marketer enum value to the / response property for the response status

    • warning

      added the new marketer enum value to the / response property for the response status

    • info

      added the new marketer enum value to the request property