name_photo.get

POST /v1/commands/name_photo.get

Reads this line's own Messages name and photo. That is the card name_photo.share later offers in a direct message. It is not a vCard, and it is not someone else's nickname.

The target is the line itself, not a chat. Omit target, or send { "kind": "connector" }.

Honours Idempotency-Key.

Payload

Empty — the key is still required:

{}

Request

curl https://api.mapier.ai/v1/commands/name_photo.get \
  -H "Authorization: Bearer $MAPIER_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: name-photo-read-1" \
  -d '{ "payload": {} }'

Passing the line explicitly is the same read:

{ "target": { "kind": "connector" }, "payload": {} }

Response

{ "commandId": "cmd-5", "status": "queued", "disposition": "queued" }

A proved read settles succeeded with outcome: "read". The card rides namePhoto on that command event, and on POST /v1/replay for the same commandId. A proved name_photo.set carries the same snapshot. No other verb returns namePhoto.

wallpaper is always null. This read never reports one, and name_photo.set never writes one.

{
  "hasPersonalNickname": true,
  "firstName": "Ada",
  "lastName": "Lovelace",
  "displayName": "Ada Lovelace",
  "hasAvatar": true,
  "wallpaper": null
}

When the Mac cannot read it

A Mac that has not been updated to this read refuses the command. It settles failed with a capability errorCode and changes nothing. There is no discovery call that tells you beforehand.

Any authenticated caller for the account may post this. Which Mac answers is the account's connector.

Errors

Related