Create shared line assignment

import { Photon } from "@photon-ai/api";

const photon = new Photon({
  headers: { Authorization: `Bearer ${process.env.PHOTON_API_TOKEN}` },
});
const result = await photon.projects.platforms.imessage.assignments.create({
  path: {
    id: "id",
  },
  headers: {
    idempotencyKey: "idempotencyKey",
  },
  body: {
    handle: "handle",
  },
});

import os

from photon_api import Photon
from photon_api.rpc_generated import CreateSharedLineAssignmentInput

photon = Photon(headers={"Authorization": f"Bearer {os.environ['PHOTON_API_TOKEN']}"})
result = photon.projects.platforms.imessage.assignments.create(
    CreateSharedLineAssignmentInput.model_validate({
        "path": {
            "id": "id",
        },
        "headers": {
            "Idempotency-Key": "idempotencyKey",
        },
        "body": {
            "handle": "handle",
        },
    })
)

use photon_ai_api::{Credential, PhotonClientBuilder, SecretString};

let token = std::env::var("PHOTON_API_TOKEN")?;
let client = PhotonClientBuilder::new()
    .credential("accountServiceKey", Credential::Bearer(SecretString::from(token)))
    .build()?;
let result = client
    .create_shared_line_assignment(
        "idempotencyKey".to_owned(),
        "id".to_owned(),
        &serde_json::from_value(serde_json::json!({
            "handle": "handle",
        }))?,
    )
    .await
    .map_err(|error| format!("{error:?}"))?
    .into_inner();

{
  "assignedPhoneNumber": "string",
  "assignmentId": "string",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "email": "string",
  "firstName": "string",
  "handle": "string",
  "lastName": "string",
  "platform": "imessage",
  "projectId": "string",
  "releasedAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

import { Photon } from "@photon-ai/api";

const photon = new Photon({
  headers: { Authorization: `Bearer ${process.env.PHOTON_API_TOKEN}` },
});
const result = await photon.projects.platforms.imessage.assignments.create({
  path: {
    id: "id",
  },
  headers: {
    idempotencyKey: "idempotencyKey",
  },
  body: {
    handle: "handle",
  },
});

import os

from photon_api import Photon
from photon_api.rpc_generated import CreateSharedLineAssignmentInput

photon = Photon(headers={"Authorization": f"Bearer {os.environ['PHOTON_API_TOKEN']}"})
result = photon.projects.platforms.imessage.assignments.create(
    CreateSharedLineAssignmentInput.model_validate({
        "path": {
            "id": "id",
        },
        "headers": {
            "Idempotency-Key": "idempotencyKey",
        },
        "body": {
            "handle": "handle",
        },
    })
)

use photon_ai_api::{Credential, PhotonClientBuilder, SecretString};

let token = std::env::var("PHOTON_API_TOKEN")?;
let client = PhotonClientBuilder::new()
    .credential("accountServiceKey", Credential::Bearer(SecretString::from(token)))
    .build()?;
let result = client
    .create_shared_line_assignment(
        "idempotencyKey".to_owned(),
        "id".to_owned(),
        &serde_json::from_value(serde_json::json!({
            "handle": "handle",
        }))?,
    )
    .await
    .map_err(|error| format!("{error:?}"))?
    .into_inner();

{
  "assignedPhoneNumber": "string",
  "assignmentId": "string",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "email": "string",
  "firstName": "string",
  "handle": "string",
  "lastName": "string",
  "platform": "imessage",
  "projectId": "string",
  "releasedAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

POST /v1/projects/{id}/platforms/imessage/assignments Maps an end user’s iMessage handle — an E.164 phone number or an email address — onto one of the project’s pooled shared iMessage lines, consuming a seat from the project’s entitlement. The assigned number is allocated by the server. When an email address is supplied in email the user is sent an invite asynchronously to that address; it is never inferred from the handle, and the response never reports whether the send succeeded. Requires the platforms:write permission bound to the project resource in the path.

TypeScript
Python
Rust

TypeScript

photon.projects.platforms.imessage.assignments.create(input: CreateSharedLineAssignmentInput, options?: RequestOptions): Promise<CreateSharedLineAssignmentOutput>

Python

photon.projects.platforms.imessage.assignments.create(input: CreateSharedLineAssignmentInput) -> models.SharedLineAssignment

Rust

client.create_shared_line_assignment(idempotency_key: String, id: String, body: &types::CreateSharedLineAssignmentRequest).await -> Result<ResponseValue<types::SharedLineAssignment>, Error<CreateSharedLineAssignmentError>>

import { Photon } from "@photon-ai/api";

const photon = new Photon({
  headers: { Authorization: `Bearer ${process.env.PHOTON_API_TOKEN}` },
});
const result = await photon.projects.platforms.imessage.assignments.create({
  path: {
    id: "id",
  },
  headers: {
    idempotencyKey: "idempotencyKey",
  },
  body: {
    handle: "handle",
  },
});

import os

from photon_api import Photon
from photon_api.rpc_generated import CreateSharedLineAssignmentInput

photon = Photon(headers={"Authorization": f"Bearer {os.environ['PHOTON_API_TOKEN']}"})
result = photon.projects.platforms.imessage.assignments.create(
    CreateSharedLineAssignmentInput.model_validate({
        "path": {
            "id": "id",
        },
        "headers": {
            "Idempotency-Key": "idempotencyKey",
        },
        "body": {
            "handle": "handle",
        },
    })
)

use photon_ai_api::{Credential, PhotonClientBuilder, SecretString};

let token = std::env::var("PHOTON_API_TOKEN")?;
let client = PhotonClientBuilder::new()
    .credential("accountServiceKey", Credential::Bearer(SecretString::from(token)))
    .build()?;
let result = client
    .create_shared_line_assignment(
        "idempotencyKey".to_owned(),
        "id".to_owned(),
        &serde_json::from_value(serde_json::json!({
            "handle": "handle",
        }))?,
    )
    .await
    .map_err(|error| format!("{error:?}"))?
    .into_inner();

{
  "assignedPhoneNumber": "string",
  "assignmentId": "string",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "email": "string",
  "firstName": "string",
  "handle": "string",
  "lastName": "string",
  "platform": "imessage",
  "projectId": "string",
  "releasedAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Parameters

string

required

Identifies one logical mutation across retries.

string

required

Body

string (email)

string

ImessageHandle

required

string

Returns

201 The created shared line assignment. SharedLineAssignment

string

required

string

required

string (date-time)

required

string

required

string

SharedLineAssignmentPlatform

required

string

required

string (date-time)

required

⌘I

Get started

Guides

Reference

SDK reference

Create shared line assignment

Parameters

Body

Returns

​Parameters

​Body

​Returns

Parameters

Body

Returns