ProfileExperimental

Update profile

Partially updates a profile: only the fields sent change, and at least one is required. Returns the updated profile.

patch/profiles/{profileReference}

Authorization

Authorization: Bearer {token} — an OAuth2 access token from the client-credentials flow. How authentication works

Path parameters

profileReferencestringrequired

The eSIM's profile reference (16-digit numeric string)

Request body

application/json · required

communicationLanguageCodestring | null

The language to message the customer in, as a two-character lowercase ISO 639-1 code. null clears it, so messages use the client's default language.

Responses

200The updated profileapplication/json

Show response body

dataobject

Show properties

profileReferencestring

Profile reference identifier (16-digit opaque token)

externalProfileIdstring | null

Your own identifier for this profile, supplied when the eSIM was ordered

statusstring

Lifecycle state of the profile.

Optionsactivesuspendedterminated

communicationLanguageCodestring | null

The language the customer is messaged in, as an ISO 639-1 code. null when none is set, in which case messages use the client's default language.

createdAtstring · date-time

updatedAtstring · date-time

400Bad request - invalid parameters 401Unauthorized - missing or invalid API key 404Resource not found 429Rate limit exceeded 500Internal server error

Request

curl 'https://connect.firsty.app/api/v3/profiles/{profileReference}' \
  --request PATCH \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "communicationLanguageCode": "nl"
}'

fetch('https://connect.firsty.app/api/v3/profiles/{profileReference}', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    communicationLanguageCode: 'nl'
  })
})

requests.patch(
    "https://connect.firsty.app/api/v3/profiles/{profileReference}",
    headers={
      "Authorization": "Bearer YOUR_ACCESS_TOKEN",
      "Content-Type": "application/json"
    },
    json={
      "communicationLanguageCode": "nl"
    }
)

$client = new GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://connect.firsty.app/api/v3/profiles/{profileReference}', [
  'headers' => [
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type' => 'application/json'
  ],
  'json' => [
    'communicationLanguageCode' => 'nl'
  ]
]);

package main

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

func main() {
	requestUrl := "https://connect.firsty.app/api/v3/profiles/{profileReference}"

	payload := strings.NewReader(`{
  "communicationLanguageCode": "nl"
}`)

	req, _ := http.NewRequest("PATCH", requestUrl, payload)

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

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://connect.firsty.app/api/v3/profiles/{profileReference}"))
    .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\n  \"communicationLanguageCode\": \"nl\"\n}"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

curl 'https://connect.test.firsty.app/api/v3/profiles/{profileReference}' \
  --request PATCH \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "communicationLanguageCode": "nl"
}'

fetch('https://connect.test.firsty.app/api/v3/profiles/{profileReference}', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    communicationLanguageCode: 'nl'
  })
})

requests.patch(
    "https://connect.test.firsty.app/api/v3/profiles/{profileReference}",
    headers={
      "Authorization": "Bearer YOUR_ACCESS_TOKEN",
      "Content-Type": "application/json"
    },
    json={
      "communicationLanguageCode": "nl"
    }
)

$client = new GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://connect.test.firsty.app/api/v3/profiles/{profileReference}', [
  'headers' => [
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type' => 'application/json'
  ],
  'json' => [
    'communicationLanguageCode' => 'nl'
  ]
]);

package main

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

func main() {
	requestUrl := "https://connect.test.firsty.app/api/v3/profiles/{profileReference}"

	payload := strings.NewReader(`{
  "communicationLanguageCode": "nl"
}`)

	req, _ := http.NewRequest("PATCH", requestUrl, payload)

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

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://connect.test.firsty.app/api/v3/profiles/{profileReference}"))
    .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\n  \"communicationLanguageCode\": \"nl\"\n}"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response

{
  "data": {
    "profileReference": "1234560000000001",
    "externalProfileId": "my-customer-123",
    "status": "active",
    "communicationLanguageCode": "nl",
    "createdAt": "2026-01-15T09:30:00Z",
    "updatedAt": "2026-01-15T09:30:00Z"
  }
}

{
  "type": "https://developers.firsty.app/errors/validation-failed",
  "title": "Validation failed",
  "status": 400,
  "detail": "Request contains invalid fields",
  "errors": [
    {
      "field": "planReference",
      "detail": "Must be a valid 14-character plan reference"
    }
  ]
}