Merran documentation API & integrations

Stop a link import

POST

/api/recipes/import/links/{importId}/stop

const url = 'http://localhost:3000/api/recipes/import/links/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/stop';
const options = {
  method: 'POST',
  headers: {cookie: 'merran.session_token=<merran.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:3000/api/recipes/import/links/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/stop \
  --cookie merran.session_token=<merran.session_token>

The recipes it added stay. The link it’s on finishes first, so the answer may still say it’s running. With an API key, it needs the imports: write permission.

Authorizations

session
apiKey

Parameters

Path Parameters

importId

required

string format: uuid

Responses

200

Stopped, or stopping.

application/json

object

required

The import’s job.

string

status

required

string

Allowed values: queued running done failed cancelled

tag

required

string | null

total

required

integer

done

required

integer

added

required

integer

already

required

integer

failed

required

integer

stopped

required

integer

items

required

Array<object>

object

url

required

string

state

required

Where the link has got to: added, already in the library, failed (see error), or stopped before it was reached.

string

Allowed values: waiting adding added already failed stopped

recipe

required

The recipe it made, or was already.

object

required

string

slug

required

string

name

required

string

photo

required

string | null

error

required

string | null

createdAt

required

string format: date-time

finishedAt

required

string | null format: date-time

Example

{
  "id": "0199e8b0-5a10-7a01-8b00-00000000000b",
  "status": "running",
  "tag": "to try",
  "total": 2,
  "done": 1,
  "added": 1,
  "already": 0,
  "failed": 0,
  "stopped": 0,
  "items": [
    {
      "url": "https://example.com/garlic-rice",
      "state": "added",
      "recipe": {
        "id": "0199e8b0-5a10-7a01-8b00-000000000007",
        "slug": "garlic-rice",
        "name": "Garlic Rice",
        "photo": null
      },
      "error": null
    },
    {
      "url": "https://example.com/lemon-chicken",
      "state": "adding",
      "recipe": null,
      "error": null
    }
  ],
  "createdAt": "2026-10-15T18:30:00.000Z",
  "finishedAt": null
}

401

Not signed in.

application/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}

403

Not allowed.

application/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}

404

No such import in this household.

application/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}

409

It has already finished.

application/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}