updateBranch

Update a repository branch (label only)

updateBranch(
  input: UpdateBranchInput!
): UpdateBranchPayload

Arguments

updateBranch.input ● UpdateBranchInput! non-null input

Parameters for UpdateBranch

Type

UpdateBranchPayload object

Autogenerated return type of UpdateBranch.

Example request

This generated mutation uses placeholders for required values. Replace them with values available to your API key before running it.

cURL

curl --request POST https://api.convisoappsec.com/graphql \
  --header "x-api-key: $CONVISO_API_KEY" \
  --header "content-type: application/json" \
  --data '{"query":"mutation MutateUpdateBranch($input: UpdateBranchInput!) {\n  updateBranch(input: $input) { branch { id name default } clientMutationId }\n}","variables":{"input":{"branchId":"<branch_id>","name":"example"}}}'

JavaScript

const response = await fetch('https://api.convisoappsec.com/graphql', {
  method: 'POST',
  headers: {
    'content-type': 'application/json',
    'x-api-key': process.env.CONVISO_API_KEY,
  },
  body: JSON.stringify({
    query: "mutation MutateUpdateBranch($input: UpdateBranchInput!) {\n  updateBranch(input: $input) { branch { id name default } clientMutationId }\n}",
    variables: {
    "input": {
        "branchId": "<branch_id>",
        "name": "example"
    }
},
  }),
});

const { data, errors } = await response.json();

if (errors) throw new Error(errors.map(({ message }) => message).join(', '));
console.log(data);

Python

import json
import os
import requests

response = requests.post(
    'https://api.convisoappsec.com/graphql',
    headers={
        'content-type': 'application/json',
        'x-api-key': os.environ['CONVISO_API_KEY'],
    },
    json={
        'query': "mutation MutateUpdateBranch($input: UpdateBranchInput!) {\n  updateBranch(input: $input) { branch { id name default } clientMutationId }\n}",
        'variables': json.loads("{\"input\":{\"branchId\":\"<branch_id>\",\"name\":\"example\"}}"),
    },
    timeout=30,
)
response.raise_for_status()

payload = response.json()
if payload.get('errors'):
    raise RuntimeError(payload['errors'])

print(payload['data'])