Inbound API

10 operations. Guide: Receive email on your domain. Requests and responses are JSON with snake_case fields; authenticate with Authorization: Bearer <api key>. The examples assume a client built as in SDKs and the command line.

List inbound routing rules

GET /v1/inbound/routes

Operation listInboundRoutes, SDK minket.inbound.routes.list. Keys: full access. Test keys work on test-mode data.

Response

200 Success: object.

Field	Type	Required	Description
`object`	"list"	yes
`data`	array of object	yes
`data[].id`	string	yes	A UUID.
`data[].object`	"route"	yes
`data[].project_id`	string	yes	A UUID.
`data[].domain_id`	string	yes	A UUID.
`data[].match`	object	yes
`data[].match (shape 1).type`	"address"	yes
`data[].match (shape 1).local_part`	string	yes	1 to 64 characters.
`data[].match (shape 2).type`	"plus"	yes
`data[].match (shape 2).local_part`	string	yes	1 to 64 characters.
`data[].match (shape 3).type`	"catchall"	yes
`data[].action`	object	yes
`data[].action (shape 1).type`	"webhook"	yes
`data[].action (shape 1).webhook_id`	string	yes	A UUID.
`data[].action (shape 2).type`	"forward"	yes
`data[].action (shape 2).to`	array of string	yes	At most 5 items.
`data[].action (shape 3).type`	"store"	yes
`data[].spam_handling`	one of "flag", "drop", "quarantine"	yes
`data[].enabled`	boolean	yes
`data[].created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`has_more`	boolean	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/inbound/routes \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.inbound.routes.list();

CLI

minket api listInboundRoutes

Python

from minket.api.inbound import list_inbound_routes

result = list_inbound_routes.sync(client=client)

res, err := client.ListInboundRoutesWithResponse(ctx)

Create an inbound routing rule

POST /v1/inbound/routes

An exact address, a plus-address base (support matches support+anything@) or the catch-all, to a webhook endpoint of the project, confirmed forwarding addresses, or storage only. Mail no rule matches goes to every endpoint subscribed to email.received.

Operation createInboundRoute, SDK minket.inbound.routes.create. Keys: full access. Live keys only: test keys get 403 test_mode_only.

Request body

Field	Type	Required	Description
`domain_id`	string	yes	A UUID.
`match`	object	yes
`match (shape 1).type`	"address"	yes
`match (shape 1).local_part`	string	yes	1 to 64 characters.
`match (shape 2).type`	"plus"	yes
`match (shape 2).local_part`	string	yes	1 to 64 characters.
`match (shape 3).type`	"catchall"	yes
`action`	object	yes
`action (shape 1).type`	"webhook"	yes
`action (shape 1).webhook_id`	string	yes	A UUID.
`action (shape 2).type`	"forward"	yes
`action (shape 2).to`	array of string	yes	At most 5 items.
`action (shape 3).type`	"store"	yes
`spam_handling`	one of "flag", "drop", "quarantine"	no	Default `"flag"`.
`enabled`	boolean	no	Default `true`.

Response

201 Created: object.

Field	Type	Required	Description
`id`	string	yes	A UUID.
`object`	"route"	yes
`project_id`	string	yes	A UUID.
`domain_id`	string	yes	A UUID.
`match`	object	yes
`match (shape 1).type`	"address"	yes
`match (shape 1).local_part`	string	yes	1 to 64 characters.
`match (shape 2).type`	"plus"	yes
`match (shape 2).local_part`	string	yes	1 to 64 characters.
`match (shape 3).type`	"catchall"	yes
`action`	object	yes
`action (shape 1).type`	"webhook"	yes
`action (shape 1).webhook_id`	string	yes	A UUID.
`action (shape 2).type`	"forward"	yes
`action (shape 2).to`	array of string	yes	At most 5 items.
`action (shape 3).type`	"store"	yes
`spam_handling`	one of "flag", "drop", "quarantine"	yes
`enabled`	boolean	yes
`created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X POST https://api.minket.com/v1/inbound/routes \
  -H "Authorization: Bearer $MINKET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain_id":"019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b","match":{"type":"address","local_part":"support"},"action":{"type":"store"}}'

TypeScript

const result = await minket.inbound.routes.create({
  domain_id: "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b",
  match: {
    type: "address",
    local_part: "support"
  },
  action: {
    type: "store"
  }
});

CLI

minket api createInboundRoute --body '{"domain_id":"019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b","match":{"type":"address","local_part":"support"},"action":{"type":"store"}}'

Python

from minket.api.inbound import create_inbound_route
from minket.models import CreateInboundRouteBody

result = create_inbound_route.sync(client=client, body=CreateInboundRouteBody.from_dict({"domain_id":"019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b","match":{"type":"address","local_part":"support"},"action":{"type":"store"}}))

var body minket.CreateInboundRouteJSONRequestBody
res, err := client.CreateInboundRouteWithResponse(ctx, body)

Update an inbound routing rule

PATCH /v1/inbound/routes/{id}

Operation updateInboundRoute, SDK minket.inbound.routes.update. Keys: full access. Live keys only: test keys get 403 test_mode_only.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Request body

Field	Type	Required	Description
`match`	object	no
`match (shape 1).type`	"address"	yes
`match (shape 1).local_part`	string	yes	1 to 64 characters.
`match (shape 2).type`	"plus"	yes
`match (shape 2).local_part`	string	yes	1 to 64 characters.
`match (shape 3).type`	"catchall"	yes
`action`	object	no
`action (shape 1).type`	"webhook"	yes
`action (shape 1).webhook_id`	string	yes	A UUID.
`action (shape 2).type`	"forward"	yes
`action (shape 2).to`	array of string	yes	At most 5 items.
`action (shape 3).type`	"store"	yes
`spam_handling`	one of "flag", "drop", "quarantine"	no
`enabled`	boolean	no

Response

200 Success: object.

Field	Type	Required	Description
`id`	string	yes	A UUID.
`object`	"route"	yes
`project_id`	string	yes	A UUID.
`domain_id`	string	yes	A UUID.
`match`	object	yes
`match (shape 1).type`	"address"	yes
`match (shape 1).local_part`	string	yes	1 to 64 characters.
`match (shape 2).type`	"plus"	yes
`match (shape 2).local_part`	string	yes	1 to 64 characters.
`match (shape 3).type`	"catchall"	yes
`action`	object	yes
`action (shape 1).type`	"webhook"	yes
`action (shape 1).webhook_id`	string	yes	A UUID.
`action (shape 2).type`	"forward"	yes
`action (shape 2).to`	array of string	yes	At most 5 items.
`action (shape 3).type`	"store"	yes
`spam_handling`	one of "flag", "drop", "quarantine"	yes
`enabled`	boolean	yes
`created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X PATCH https://api.minket.com/v1/inbound/routes/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b \
  -H "Authorization: Bearer $MINKET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":false}'

TypeScript

const result = await minket.inbound.routes.update("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", {
  enabled: false
});

CLI

minket api updateInboundRoute 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b --body '{"enabled":false}'

Python

from minket.api.inbound import update_inbound_route
from minket.models import UpdateInboundRouteBody

result = update_inbound_route.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client, body=UpdateInboundRouteBody.from_dict({"enabled":false}))

var body minket.UpdateInboundRouteJSONRequestBody
res, err := client.UpdateInboundRouteWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", body)

Delete an inbound routing rule

DELETE /v1/inbound/routes/{id}

Operation deleteInboundRoute, SDK minket.inbound.routes.delete. Keys: full access. Live keys only: test keys get 403 test_mode_only.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Response

200 Success: object.

Field	Type	Required	Description
`id`	string	yes	A UUID.
`object`	"route"	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X DELETE https://api.minket.com/v1/inbound/routes/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.inbound.routes.delete("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api deleteInboundRoute 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.inbound import delete_inbound_route

result = delete_inbound_route.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.DeleteInboundRouteWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

List received messages

GET /v1/inbound

Operation listInbound, SDK minket.inbound.list. Keys: full access, inbound read. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`limit`	query	integer	no	Default `20`.
`after`	query	string	no	A UUID.
`before`	query	string	no	A UUID.
`domain_id`	query	string	no	A UUID.
`from`	query	string	no
`to`	query	string	no
`status`	query	one of "received", "routed", "forwarded", "dropped", "quarantined"	no
`spam`	query	boolean	no

Response

200 Success: object.

Field	Type	Required	Description
`object`	"list"	yes
`data`	array of object	yes
`data[].id`	string	yes	A UUID.
`data[].object`	"inbound"	yes
`data[].project_id`	string	yes	A UUID.
`data[].domain_id`	string or null	yes	A UUID.
`data[].from`	string	yes
`data[].to`	array of string	yes
`data[].cc`	array of string	yes
`data[].bcc`	array of string	yes
`data[].reply_to`	array of string	yes
`data[].received_for`	array of string	yes
`data[].subject`	string	yes
`data[].message_id`	string	yes
`data[].in_reply_to`	string or null	yes
`data[].attachments`	array of object	yes
`data[].attachments[].id`	string	yes	A UUID.
`data[].attachments[].object`	"attachment"	yes
`data[].attachments[].filename`	string or null	yes
`data[].attachments[].content_type`	string	yes
`data[].attachments[].size`	integer	yes
`data[].attachments[].content_id`	string or null	yes
`data[].attachments[].disposition`	one of "attachment", "inline"	yes
`data[].attachments[].download_url`	string	no
`data[].attachments[].expires_at`	string (date-time)	no	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`data[].verdicts`	object	yes
`data[].verdicts.spf`	one of "pass", "fail", "softfail", "neutral", "none", "temperror", "permerror"	yes
`data[].verdicts.dkim`	one of "pass", "fail", "none", "temperror", "permerror"	yes
`data[].verdicts.dmarc`	one of "pass", "fail", "none", "temperror", "permerror"	yes
`data[].verdicts.spam`	one of "pass", "fail", "unknown"	yes
`data[].verdicts.virus`	one of "pass", "fail", "unknown"	yes
`data[].spam`	boolean	yes
`data[].virus`	boolean	yes
`data[].size`	integer	yes
`data[].status`	one of "received", "routed", "forwarded", "dropped", "quarantined"	yes
`data[].routing`	array of object	yes
`data[].routing[].kind`	one of "webhook", "forward", "store"	yes
`data[].routing[].target`	string	yes
`data[].routing[].status`	one of "pending", "done", "failed", "skipped"	yes
`data[].routing[].error`	string	no
`data[].routing[].email_id`	string	no	A UUID.
`data[].issues`	array of one of "message_too_large", "malformed", "headers_too_large", "too_many_parts", "too_deep", "nested_messages_kept", "attachments_truncated", "addresses_truncated", "virus", "spam", "forward_loop", "dmarc_refused"	yes
`data[].created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`has_more`	boolean	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/inbound \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.inbound.list();

CLI

minket api listInbound

Python

from minket.api.inbound import list_inbound

result = list_inbound.sync(client=client)

res, err := client.ListInboundWithResponse(ctx, &minket.ListInboundParams{})

Get a received message with its parsed content and verdicts

GET /v1/inbound/{id}

html carries inline images as data URIs unless html_format=cid. raw.download_url downloads the message as received until raw.expires_at (an hour at most).

Operation getInbound, SDK minket.inbound.get. Keys: full access, inbound read. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.
`html_format`	query	one of "data_uri", "cid"	no	Default `"data_uri"`.

Response

200 Success: Inbound.

Field	Type	Required	Description
`id`	string	yes	A UUID.
`object`	"inbound"	yes
`project_id`	string	yes	A UUID.
`domain_id`	string or null	yes	A UUID.
`from`	string	yes
`to`	array of string	yes
`cc`	array of string	yes
`bcc`	array of string	yes
`reply_to`	array of string	yes
`received_for`	array of string	yes
`subject`	string	yes
`message_id`	string	yes
`in_reply_to`	string or null	yes
`headers`	map of string	no
`html`	string or null	no
`text`	string or null	no
`attachments`	array of object	yes
`attachments[].id`	string	yes	A UUID.
`attachments[].object`	"attachment"	yes
`attachments[].filename`	string or null	yes
`attachments[].content_type`	string	yes
`attachments[].size`	integer	yes
`attachments[].content_id`	string or null	yes
`attachments[].disposition`	one of "attachment", "inline"	yes
`attachments[].download_url`	string	no
`attachments[].expires_at`	string (date-time)	no	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`verdicts`	object	yes
`verdicts.spf`	one of "pass", "fail", "softfail", "neutral", "none", "temperror", "permerror"	yes
`verdicts.dkim`	one of "pass", "fail", "none", "temperror", "permerror"	yes
`verdicts.dmarc`	one of "pass", "fail", "none", "temperror", "permerror"	yes
`verdicts.spam`	one of "pass", "fail", "unknown"	yes
`verdicts.virus`	one of "pass", "fail", "unknown"	yes
`spam`	boolean	yes
`virus`	boolean	yes
`size`	integer	yes
`status`	one of "received", "routed", "forwarded", "dropped", "quarantined"	yes
`routing`	array of object	yes
`routing[].kind`	one of "webhook", "forward", "store"	yes
`routing[].target`	string	yes
`routing[].status`	one of "pending", "done", "failed", "skipped"	yes
`routing[].error`	string	no
`routing[].email_id`	string	no	A UUID.
`issues`	array of one of "message_too_large", "malformed", "headers_too_large", "too_many_parts", "too_deep", "nested_messages_kept", "attachments_truncated", "addresses_truncated", "virus", "spam", "forward_loop", "dmarc_refused"	yes
`raw`	object or null	no
`raw.download_url`	string	yes
`raw.expires_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/inbound/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.inbound.get("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api getInbound 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.inbound import get_inbound

result = get_inbound.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.GetInboundWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", &minket.GetInboundParams{})

List a received message's attachments with download URLs

GET /v1/inbound/{id}/attachments

Operation listInboundAttachments, SDK minket.inbound.attachments. Keys: full access, inbound read. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Response

200 Success: object.

Field	Type	Required	Description
`object`	"list"	yes
`data`	array of object	yes
`data[].id`	string	yes	A UUID.
`data[].object`	"attachment"	yes
`data[].filename`	string or null	yes
`data[].content_type`	string	yes
`data[].size`	integer	yes
`data[].content_id`	string or null	yes
`data[].disposition`	one of "attachment", "inline"	yes
`data[].download_url`	string	yes
`data[].expires_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`has_more`	boolean	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/inbound/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/attachments \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.inbound.attachments("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api listInboundAttachments 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.inbound import list_inbound_attachments

result = list_inbound_attachments.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.ListInboundAttachmentsWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

Get one attachment with a download URL

GET /v1/inbound/{id}/attachments/{attachmentId}

Operation getInboundAttachment, SDK minket.inbound.attachment. Keys: full access, inbound read. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.
`attachmentId`	path	string	yes	A UUID.

Response

200 Success: object.

Field	Type	Required	Description
`id`	string	yes	A UUID.
`object`	"attachment"	yes
`filename`	string or null	yes
`content_type`	string	yes
`size`	integer	yes
`content_id`	string or null	yes
`disposition`	one of "attachment", "inline"	yes
`download_url`	string	yes
`expires_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/inbound/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/attachments/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.inbound.attachment("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api getInboundAttachment 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.inbound import get_inbound_attachment

result = get_inbound_attachment.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.GetInboundAttachmentWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

Forward a received message

POST /v1/inbound/{id}/forward

Only mail SES scanned as spam pass (and not a virus), only to addresses confirmed in the console, and never past three platform forwards. From becomes the receiving address and Reply-To the sender. Send Idempotency-Key to make retries safe.

Operation forwardInbound, SDK minket.inbound.forward. Keys: full access. Live keys only: test keys get 403 test_mode_only.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Request body

Field	Type	Required	Description
`to`	array of string	yes	At most 5 items.
`from`	string	no	An email address, optionally with a display name as `Name <address>`. 3 to 998 characters.
`passthrough`	boolean	no	Default `true`.
`text`	string	no	At most 1048576 characters.
`html`	string	no	At most 1048576 characters.

Response

200 Success: object.

Field	Type	Required	Description
`id`	string	yes	A UUID.
`object`	"email"	yes
`status`	one of "queued", "scheduled", "sent", "delivered", "delivery_delayed", "opened", "clicked", "bounced", "complained", "failed", "canceled", "suppressed"	yes
`scheduled_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`idempotent_replay`	boolean	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X POST https://api.minket.com/v1/inbound/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/forward \
  -H "Authorization: Bearer $MINKET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":["jane@example.com"]}'

TypeScript

const result = await minket.inbound.forward("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", {
  to: [
    "jane@example.com"
  ]
});

CLI

minket api forwardInbound 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b --body '{"to":["jane@example.com"]}'

Python

from minket.api.inbound import forward_inbound
from minket.models import ForwardInboundBody

result = forward_inbound.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client, body=ForwardInboundBody.from_dict({"to":["jane@example.com"]}))

var body minket.ForwardInboundJSONRequestBody
res, err := client.ForwardInboundWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", body)

Share a received message

POST /v1/inbound/{id}/share

A link on links. that shows the email's headers and content to whoever has it, until expires_at (expires_in: up to and by default 48 hours). The content opens in a sandboxed frame: no scripts or forms. The link cannot be revoked; it only expires.

Operation shareInbound, SDK minket.inbound.share. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Request body

Field	Type	Required	Description
`expires_in`	string	no	At most 40 characters.

Response

201 Created: object.

Field	Type	Required	Description
`object`	one of "email", "inbound"	yes
`id`	string	yes	A UUID.
`url`	string	yes
`expires_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X POST https://api.minket.com/v1/inbound/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/share \
  -H "Authorization: Bearer $MINKET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

TypeScript

const result = await minket.inbound.share("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", {});

CLI

minket api shareInbound 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b --body '{}'

Python

from minket.api.inbound import share_inbound
from minket.models import ShareInboundBody

result = share_inbound.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client, body=ShareInboundBody.from_dict({}))

var body minket.ShareInboundJSONRequestBody
res, err := client.ShareInboundWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", body)

Updated 30 October 2026