Show examples in:
    Invite a new user

    Parameters

    email  Required  string  Example: "mark.smith@example.com"

    Email

    role  Required  { type: "role", id: role.id }

    Role

    Returns

    Returns a site_invitation resource object.

    Examples

    Example code:
    import { buildClient } from '@datocms/cma-client-node';
    async function run() {
    const client = buildClient({ apiToken: '<YOUR_API_TOKEN>' });
    const siteInvitation = await client.siteInvitations.create({
    email: 'mark.smith@example.com',
    role: {
    type: 'role',
    id: '34'
    }
    });
    console.log(siteInvitation);
    }
    run();
    Returned output:
    {
    id: '312',
    email: 'mark.smith@example.com',
    expired: 'mark.smith@example.com',
    invitation_link: 'https://dashboard.datocms.com/join-site?email=my-email%40datocms.comff&id=43796&preference=signup&token=xxx',
    role: {
    type: 'role',
    id: '34'
    }
    }