Create an email account intent

curl --request POST \
  --url https://api.getprimo.com/email-account-intents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "employeeId": "<string>",
  "credentialsRecipient": {
    "email": "jsmith@example.com"
  },
  "groups": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "roles": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "licenses": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "organizationUnits": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "personalEmail": "jsmith@example.com",
  "parentTicketId": "<string>",
  "scheduleDate": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.getprimo.com/email-account-intents"

payload = {
    "employeeId": "<string>",
    "credentialsRecipient": { "email": "jsmith@example.com" },
    "groups": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "roles": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "licenses": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "organizationUnits": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "personalEmail": "jsmith@example.com",
    "parentTicketId": "<string>",
    "scheduleDate": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    employeeId: '<string>',
    credentialsRecipient: {email: 'jsmith@example.com'},
    groups: [{id: '<string>', name: '<string>'}],
    roles: [{id: '<string>', name: '<string>'}],
    licenses: [{id: '<string>', name: '<string>'}],
    organizationUnits: [{id: '<string>', name: '<string>'}],
    personalEmail: 'jsmith@example.com',
    parentTicketId: '<string>',
    scheduleDate: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.getprimo.com/email-account-intents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getprimo.com/email-account-intents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'employeeId' => '<string>',
    'credentialsRecipient' => [
        'email' => 'jsmith@example.com'
    ],
    'groups' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'roles' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'licenses' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'organizationUnits' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'personalEmail' => 'jsmith@example.com',
    'parentTicketId' => '<string>',
    'scheduleDate' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getprimo.com/email-account-intents"

	payload := strings.NewReader("{\n  \"employeeId\": \"<string>\",\n  \"credentialsRecipient\": {\n    \"email\": \"jsmith@example.com\"\n  },\n  \"groups\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"roles\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"licenses\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"organizationUnits\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"personalEmail\": \"jsmith@example.com\",\n  \"parentTicketId\": \"<string>\",\n  \"scheduleDate\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getprimo.com/email-account-intents")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"employeeId\": \"<string>\",\n  \"credentialsRecipient\": {\n    \"email\": \"jsmith@example.com\"\n  },\n  \"groups\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"roles\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"licenses\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"organizationUnits\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"personalEmail\": \"jsmith@example.com\",\n  \"parentTicketId\": \"<string>\",\n  \"scheduleDate\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/email-account-intents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"employeeId\": \"<string>\",\n  \"credentialsRecipient\": {\n    \"email\": \"jsmith@example.com\"\n  },\n  \"groups\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"roles\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"licenses\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"organizationUnits\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"personalEmail\": \"jsmith@example.com\",\n  \"parentTicketId\": \"<string>\",\n  \"scheduleDate\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "taskId": "<string>",
  "ticketId": "<string>",
  "employeeId": "<string>",
  "companySaasApplicationId": "<string>",
  "credentialsRecipient": {
    "type": "ADMIN",
    "email": "jsmith@example.com"
  },
  "personalEmail": "<string>",
  "groups": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "roles": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "licenses": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "organizationUnits": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "createdEmail": "<string>",
  "executedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Onboardings

Create an email account intent

Ask for an employee’s professional mailbox at the company’s email provider as a task a ticket tracks. Creates the intent and its EMAIL_ACCOUNT task. Without scheduleDate the mailbox is created right away; with one, the task sleeps until that date and the mailbox is created when it wakes up — nobody has to execute it. Pass the onboarding ticket as parentTicketId; without one Primo opens a ticket for the employee to hold the task. createTicket and createTask cannot make a typed task. The mailbox is created at the employee’s email as it stands when the task runs: set or fix that address on the employee (updateEmployee), not here. Returns the intent id, its taskId and the ticketId holding it. The task cannot be marked done by hand; it completes when the mailbox exists. Take the groups, roles, licenses and organization units from getSaasById of the email provider (the SaaS with isEmailProvider in getSaas). For an onboarding still on the classic email step, the step is handled by the onboarding itself; this intent is the email work tracked as a task on a ticket (an EMAIL_ACCOUNT task), and never closes an onboarding email step. Refused with EMAIL_PROVIDER_NOT_FOUND (no connected email provider), COMPANY_SAAS_APPLICATION_NOT_CAPABLE (the provider does not create users automatically), EMPLOYEE_NOT_FOUND, PARENT_TICKET_IS_TYPED or PARENT_TICKET_IS_A_TASK (pass the untyped ticket instead), PARENT_TICKET_NOT_FOUND.

POST

email-account-intents

curl --request POST \
  --url https://api.getprimo.com/email-account-intents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "employeeId": "<string>",
  "credentialsRecipient": {
    "email": "jsmith@example.com"
  },
  "groups": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "roles": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "licenses": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "organizationUnits": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "personalEmail": "jsmith@example.com",
  "parentTicketId": "<string>",
  "scheduleDate": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.getprimo.com/email-account-intents"

payload = {
    "employeeId": "<string>",
    "credentialsRecipient": { "email": "jsmith@example.com" },
    "groups": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "roles": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "licenses": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "organizationUnits": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "personalEmail": "jsmith@example.com",
    "parentTicketId": "<string>",
    "scheduleDate": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    employeeId: '<string>',
    credentialsRecipient: {email: 'jsmith@example.com'},
    groups: [{id: '<string>', name: '<string>'}],
    roles: [{id: '<string>', name: '<string>'}],
    licenses: [{id: '<string>', name: '<string>'}],
    organizationUnits: [{id: '<string>', name: '<string>'}],
    personalEmail: 'jsmith@example.com',
    parentTicketId: '<string>',
    scheduleDate: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.getprimo.com/email-account-intents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getprimo.com/email-account-intents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'employeeId' => '<string>',
    'credentialsRecipient' => [
        'email' => 'jsmith@example.com'
    ],
    'groups' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'roles' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'licenses' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'organizationUnits' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'personalEmail' => 'jsmith@example.com',
    'parentTicketId' => '<string>',
    'scheduleDate' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getprimo.com/email-account-intents"

	payload := strings.NewReader("{\n  \"employeeId\": \"<string>\",\n  \"credentialsRecipient\": {\n    \"email\": \"jsmith@example.com\"\n  },\n  \"groups\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"roles\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"licenses\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"organizationUnits\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"personalEmail\": \"jsmith@example.com\",\n  \"parentTicketId\": \"<string>\",\n  \"scheduleDate\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getprimo.com/email-account-intents")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"employeeId\": \"<string>\",\n  \"credentialsRecipient\": {\n    \"email\": \"jsmith@example.com\"\n  },\n  \"groups\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"roles\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"licenses\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"organizationUnits\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"personalEmail\": \"jsmith@example.com\",\n  \"parentTicketId\": \"<string>\",\n  \"scheduleDate\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/email-account-intents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"employeeId\": \"<string>\",\n  \"credentialsRecipient\": {\n    \"email\": \"jsmith@example.com\"\n  },\n  \"groups\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"roles\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"licenses\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"organizationUnits\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"personalEmail\": \"jsmith@example.com\",\n  \"parentTicketId\": \"<string>\",\n  \"scheduleDate\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "taskId": "<string>",
  "ticketId": "<string>",
  "employeeId": "<string>",
  "companySaasApplicationId": "<string>",
  "credentialsRecipient": {
    "type": "ADMIN",
    "email": "jsmith@example.com"
  },
  "personalEmail": "<string>",
  "groups": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "roles": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "licenses": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "organizationUnits": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "createdEmail": "<string>",
  "executedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Key: Write Scope: Company

Authorizations

Authorization

string

header

required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Body

application/json

employeeId

string

required

The employee the mailbox is for (from getEmployees). Fixed once created.

Pattern: ^[a-f\d]{24}$

credentialsRecipient

object

required

Show child attributes

groups

object[]

Show child attributes

roles

object[]

Show child attributes

licenses

object[]

Show child attributes

organizationUnits

object[]

Show child attributes

personalEmail

string<email> | null

The employee's personal address, saved on the employee on execute.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

parentTicketId

string | null

The untyped ticket the work belongs to (an onboarding ticket). Omit it and Primo opens one.

Pattern: ^[a-f\d]{24}$

scheduleDate

string<date-time> | null

Creates the task SCHEDULED until this date; the mailbox is created when it wakes up. Without it, the mailbox is created right away.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Response

default - application/json

string

required

Intent id — pass it to updateEmailAccountIntent and executeEmailAccountIntent

taskId

string | null

required

The EMAIL_ACCOUNT task that tracks the mailbox

ticketId

string | null

required

The ticket holding that task: the parentTicketId sent, or the one Primo opened. Null if unreadable.

employeeId

string

required

companySaasApplicationId

string

required

The company's email provider

credentialsRecipient

object

required

Show child attributes

personalEmail

string | null

required

groups

object[]

required

Show child attributes

roles

object[]

required

Show child attributes

licenses

object[]

required

Show child attributes

organizationUnits

object[]

required

Show child attributes

createdEmail

string | null

required

The address the provider created, null until executed

executedAt

string<date-time> | null

required

When the mailbox was created; null while the intent can change

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

createdAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Get started

API Reference

Create an email account intent

Authorizations

Body

Response