marketing

Scan a website again

Read the same website again and publish a new manifest version beside the old ones. Projects already made keep the version they were built from; only new work sees the new one. The address must be the one the source was created with — a refresh that pointed somewhere else would silently replace a customer's site with a different one. Answers 202 with a Location; poll marketing.sources.get until state is terminal.

post/marketing/sources/{id}/refresh

Request

  • Base URL: https://api.gogoscreen.com/api/v1
  • URL: https://api.gogoscreen.com/api/v1/marketing/sources/{id}/refresh
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

The resource id, from a create answer or the matching list.

Headers

Idempotency-Keystring required

1–128 characters, unique to this request. A retry with the same key and the same body returns the STORED response with Idempotent-Replayed: true; the same key with a different body is 409 idempotency_conflict; a duplicate still in flight is 409 idempotency_in_progress. Claims expire after 24 hours.

Request body

demoobject
urlstring required

The same address the source was created with.

Response

The work was already known — the service recognised this key on its own record and queued nothing new. Answered when the 24-hour idempotency claim has expired but the work has not.

createdboolean required
dispatchedboolean required

Whether the job has started. False means it is accepted and will start shortly; it is not a failure.

operationIdstring required

The scan attempt. Poll the SOURCE, not this: a source has many scans and one current manifest.

resourceobject required

Changes

No recorded changes to this operation across all 1 revision of this API.