Update an email account intent

curl --request PATCH \
  --url https://api.getprimo.com/email-account-intents/{intentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groups": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "roles": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "licenses": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "organizationUnits": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "personalEmail": "jsmith@example.com"
}
'

import requests

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

payload = {
    "groups": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "roles": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "licenses": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "organizationUnits": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "personalEmail": "jsmith@example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    groups: [{id: '<string>', name: '<string>'}],
    roles: [{id: '<string>', name: '<string>'}],
    licenses: [{id: '<string>', name: '<string>'}],
    organizationUnits: [{id: '<string>', name: '<string>'}],
    personalEmail: 'jsmith@example.com'
  })
};

fetch('https://api.getprimo.com/email-account-intents/{intentId}', 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/{intentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'groups' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'roles' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'licenses' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'organizationUnits' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'personalEmail' => 'jsmith@example.com'
  ]),
  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/{intentId}"

	payload := strings.NewReader("{\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}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.getprimo.com/email-account-intents/{intentId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\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}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\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}"

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

Update an email account intent

Change the credentials recipient, the personal email or the groups, roles, licenses and organization units of an email account intent before its mailbox is created — typically while its task sleeps until its date. Only the fields you send change; a resource list is replaced whole. The employee cannot change: create a new intent for someone else. Refused with INTENT_ALREADY_EXECUTED once the mailbox exists, EXECUTION_IN_PROGRESS while it is being created, TICKET_CLOSED when its task is completed or cancelled. 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.

PATCH

email-account-intents

{intentId}

curl --request PATCH \
  --url https://api.getprimo.com/email-account-intents/{intentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groups": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "roles": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "licenses": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "organizationUnits": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "personalEmail": "jsmith@example.com"
}
'

import requests

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

payload = {
    "groups": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "roles": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "licenses": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "organizationUnits": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "personalEmail": "jsmith@example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    groups: [{id: '<string>', name: '<string>'}],
    roles: [{id: '<string>', name: '<string>'}],
    licenses: [{id: '<string>', name: '<string>'}],
    organizationUnits: [{id: '<string>', name: '<string>'}],
    personalEmail: 'jsmith@example.com'
  })
};

fetch('https://api.getprimo.com/email-account-intents/{intentId}', 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/{intentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'groups' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'roles' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'licenses' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'organizationUnits' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'personalEmail' => 'jsmith@example.com'
  ]),
  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/{intentId}"

	payload := strings.NewReader("{\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}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.getprimo.com/email-account-intents/{intentId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\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}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\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}"

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>.

Path Parameters

intentId

string

required

Body

application/json

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,}$

credentialsRecipient

object

Show child attributes

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

Update an email account intent

Authorizations

Path Parameters

Body

Response