> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ziplined.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Rename, pause, resume or repoint a destination

> Adds or changes a webhook or an email list that Ziplined can send people to. Adds a destination that syncs can send people to. That is a webhook (an https URL) or an email list (1 to 20 addresses). A webhook first gets a signed test event. Ziplined saves it only when it answers with a 2xx within ten seconds. The answer for a webhook carries its signing secret exactly once. Give the secret to the user to store in the receiving system, because Ziplined cannot show it again. Give the destination a name when the workspace has more than one. Email goes only to members of this workspace, and to addresses on a member's company domain. The first call saves and sends nothing. It returns a summary of where people will go, and a confirm_id. It saves when you call again with the same arguments plus confirm_id, once the user agreed. With destination, it updates a destination that exists. name renames it. paused: true pauses every sync to it and keeps their choices. paused: false resumes them, and sends only the people who enter from then on. url (webhook) or to (email) replaces where it points, and asks first in the same way. A new url gets a new secret, shown once. A rename or a pause needs no confirm_id. The connection of Slack or another app is a secret, and never an argument. connect_destination gives the user a link to connect it again. fields says what a webhook or a Clay table gets about each person. list_destinations shows the fields of each destination. You cannot change the columns of a Google Sheets tab.

Use when: The user wants people sent to their own endpoint (Make, Zapier, n8n) or to a list of email addresses. Or the user wants to rename a destination, or pause or resume every sync to it. Or the user wants to point a webhook or email list elsewhere.

Do not use for: Slack and other apps: they need a sign-in or a key that you never pass as an argument. Use connect_destination instead, which also replaces their connection. Pausing one sync (use save_sync with paused instead).

Example: {"provider":"webhook","url":"https://hook.eu2.make.com/abc123","name":"Make leads"}



## OpenAPI

````yaml /openapi.json patch /v1/integrations/{id}
openapi: 3.1.0
info:
  title: Ziplined API
  version: 1.0.0
  description: >-
    LinkedIn engagement data about people, companies and posts. The workspace
    comes from the credential; lists page with `limit` and `cursor`.
servers:
  - url: https://api.ziplined.io
    description: Production
security: []
tags:
  - name: People
    description: The people in your workspace, and what you sent them.
  - name: Companies
    description: The companies those people work at.
  - name: Posts
    description: Your own posts and their numbers.
  - name: Engagements
    description: One act by one person on one post.
  - name: Insights
    description: Period against period, and the series behind it.
  - name: Views
    description: The saved views of the app, and who is in a hand-picked one.
  - name: Audiences
    description: The scored target groups, and their membership.
  - name: ICP
    description: 'Who you sell to: the rules every person is scored against.'
  - name: Sources
    description: What your radar collects from.
  - name: Account
    description: Who is asking, what is set up, and what is next.
  - name: Credits
    description: What is left to spend on sources, and when it resets.
  - name: Integrations
    description: 'Where syncs send people: webhook, email, Slack and app destinations.'
paths:
  /v1/integrations/{id}:
    patch:
      tags:
        - Integrations
      summary: Rename, pause, resume or repoint a destination
      description: >-
        Adds or changes a webhook or an email list that Ziplined can send people
        to. Adds a destination that syncs can send people to. That is a webhook
        (an https URL) or an email list (1 to 20 addresses). A webhook first
        gets a signed test event. Ziplined saves it only when it answers with a
        2xx within ten seconds. The answer for a webhook carries its signing
        secret exactly once. Give the secret to the user to store in the
        receiving system, because Ziplined cannot show it again. Give the
        destination a name when the workspace has more than one. Email goes only
        to members of this workspace, and to addresses on a member's company
        domain. The first call saves and sends nothing. It returns a summary of
        where people will go, and a confirm_id. It saves when you call again
        with the same arguments plus confirm_id, once the user agreed. With
        destination, it updates a destination that exists. name renames it.
        paused: true pauses every sync to it and keeps their choices. paused:
        false resumes them, and sends only the people who enter from then on.
        url (webhook) or to (email) replaces where it points, and asks first in
        the same way. A new url gets a new secret, shown once. A rename or a
        pause needs no confirm_id. The connection of Slack or another app is a
        secret, and never an argument. connect_destination gives the user a link
        to connect it again. fields says what a webhook or a Clay table gets
        about each person. list_destinations shows the fields of each
        destination. You cannot change the columns of a Google Sheets tab.


        Use when: The user wants people sent to their own endpoint (Make,
        Zapier, n8n) or to a list of email addresses. Or the user wants to
        rename a destination, or pause or resume every sync to it. Or the user
        wants to point a webhook or email list elsewhere.


        Do not use for: Slack and other apps: they need a sign-in or a key that
        you never pass as an argument. Use connect_destination instead, which
        also replaces their connection. Pausing one sync (use save_sync with
        paused instead).


        Example:
        {"provider":"webhook","url":"https://hook.eu2.make.com/abc123","name":"Make
        leads"}
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 200
            description: >-
              An existing destination, by name or id from list_destinations: the
              call updates it instead of adding one. With it, pass name, paused,
              url (webhook) or to (email); provider is not needed.
          required: false
          description: >-
            An existing destination, by name or id from list_destinations: the
            call updates it instead of adding one. With it, pass name, paused,
            url (webhook) or to (email); provider is not needed.
          name: id
          in: path
        - schema:
            type: string
            minLength: 1
            maxLength: 255
            description: >-
              Any client-chosen key, a uuid for example. Sending the same
              request twice with the same key has one effect and returns the
              same response twice; the same key with a different body returns
              409.
            example: 3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d
          required: false
          description: >-
            Any client-chosen key, a uuid for example. Sending the same request
            twice with the same key has one effect and returns the same response
            twice; the same key with a different body returns 409.
          name: idempotency-key
          in: header
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                provider:
                  type: string
                  enum:
                    - webhook
                    - email
                  description: >-
                    For a new destination: webhook or email. connect_destination
                    connects Slack and other apps.
                url:
                  type: string
                  format: uri
                  description: >-
                    For webhook: the https URL that receives the signed events.
                    On an update it replaces the URL and makes a new secret.
                to:
                  type: array
                  items:
                    type: string
                    format: email
                  minItems: 1
                  maxItems: 20
                  description: >-
                    For email: the addresses that receive the emails, 1 to 20.
                    On an update it replaces the list.
                paused:
                  type: boolean
                  description: >-
                    Only with destination. true pauses every sync to it: they
                    send nothing until you resume them. The syncs keep their
                    choices. false resumes them. They do not send the people who
                    entered a view during the pause.
                name:
                  type: string
                  minLength: 1
                  maxLength: 120
                  description: >-
                    A name to tell destinations apart, such as "Make leads".
                    list_destinations shows it, and save_sync takes it.
                fields:
                  type: array
                  items:
                    type: string
                  maxItems: 27
                  description: >-
                    For webhook and Clay: what it sends about each person, as
                    field keys in order. Examples: first_name, last_name,
                    job_title, company, signal, post_topic, post_url,
                    ziplined_url. An unknown key gets an error with all keys.
                    Left out, a new webhook gets the default set. You cannot
                    change the columns of a Google Sheets tab.
                confirm_id:
                  type: string
                  description: >-
                    The confirm_id of a needs_confirmation answer: commits what
                    that answer summarised.
      responses:
        '200':
          description: >-
            The result, or without confirm_id first a needs_confirmation answer:
            nothing happened yet.
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    properties:
                      destination:
                        type: object
                        properties:
                          id:
                            type: string
                          provider:
                            type: string
                          name:
                            type: string
                            nullable: true
                          status:
                            type: string
                            enum:
                              - connected
                              - paused
                              - failed
                              - disconnected
                            description: >-
                              The stored state, not a live test. connected: it
                              sends. paused: it sends nothing until you resume
                              it (save_destination paused: false). failed: it
                              reported an error, so its syncs send nothing. Run
                              test_destination to check the receiver now.
                          host:
                            type: string
                            nullable: true
                            description: Where it points. Null for email.
                          created_at:
                            type: string
                          last_delivery:
                            type: object
                            nullable: true
                            properties:
                              status:
                                type: string
                              at:
                                type: string
                            required:
                              - status
                              - at
                            description: >-
                              The newest send to it, or null when nothing was
                              sent yet.
                          failed_deliveries:
                            type: integer
                            description: >-
                              How many of its recent sends failed. See
                              list_deliveries.
                          fields:
                            type: array
                            nullable: true
                            items:
                              type: string
                            description: >-
                              What it sends about each person: field keys in
                              column order, such as first_name, company, signal.
                              For sheets, clay and webhook. Null for Slack and
                              email, which send a message.
                        required:
                          - id
                          - provider
                          - name
                          - status
                          - host
                          - created_at
                          - last_delivery
                          - failed_deliveries
                          - fields
                      secret:
                        type: string
                        nullable: true
                        description: >-
                          The webhook signing secret, shown this one time. Null
                          for email, and null when this answer is a replay. A
                          lost secret is not recoverable: rotate it with POST
                          /v1/integrations/{id}/rotate-secret.
                      app_url:
                        type: string
                    required:
                      - destination
                      - secret
                      - app_url
                  - $ref: '#/components/schemas/Confirmation'
        '400':
          description: A filter value is invalid, or this resource has no such filter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Not included in this plan, or a usage cap was exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Wrong workspace, or the credential lacks the required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such record, or it does not belong to this workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            The same `Idempotency-Key` was used for a different request, or that
            request is still in flight.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Confirmation:
      type: object
      properties:
        needs_confirmation:
          type: boolean
          enum:
            - true
        message:
          type: string
          description: >-
            Nothing changed yet. Ask the user, then send the same request with
            confirm_id.
        confirm_id:
          type: string
          description: Send it back with the same request to commit. Valid for 10 minutes.
        summary:
          nullable: true
          description: What the commit will do, to show the user before confirming.
        cost:
          type: object
          properties:
            estimate:
              type: number
            ceiling:
              type: number
          required:
            - estimate
            - ceiling
          description: >-
            Credits: estimate is what the commit is expected to spend. ceiling
            is 0: no ceiling is stored, and later spend stops when the balance
            reaches 0.
        expires_at:
          type: string
          description: ISO instant. After it, confirm_id is refused as confirm_stale.
      required:
        - needs_confirmation
        - message
        - confirm_id
        - cost
        - expires_at
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.