name_photo.share

Offer your contact card — name and photo — in a direct message.

POST /v1/commands/name_photo.share

Offers your iMessage name and photo to the other party in a direct message, the same prompt Messages shows when you share your contact card. Takes no arguments.

Routing path: agent-turn. Honours Idempotency-Key.

Target

Prop

Type

Some earlier API notes list a recipient target for this command. The wire schema the connector validates against accepts a direct-message conversation and nothing else, so a recipient target is not rejected at the boundary — it returns 202 and then settles failed. Use a conversation target, which means the thread has to exist first.

Payload

Empty — but the key is still required:

{}

Request

curl $MAPIER_BASE_URL/v1/commands/name_photo.share \
  -H "Authorization: Bearer $MAPIER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "target": {
      "kind": "conversation",
      "conversationId": "a0000000-0000-4000-8000-000000000001"
    },
    "payload": {}
  }'

Response

202 Accepted
{ "commandId": "cmd-4", "status": "queued", "disposition": "queued" }

The command settles succeeded both when the card was offered and when iMessage declined to show the prompt — usually because it was already shared with that person. The settlement carries nothing that distinguishes the two.

Errors

StatusCodeCause
400invalid_conversationIdNot a UUID
400target_and_payload_requiredpayload omitted entirely — send {}
404conversation_not_foundUnknown conversation, or another account's
503no_live_connectorNo Mac available

Capabilities

Requires command.name_photo_share.v1.

On this page