Update participant

PATCH/participants/{participantId}

Updates participant information. This is an authenticated route.

Request

curl --request PATCH \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/participants/PARTICIPANT_ID' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "João Silva",
  "email": "joao.silva@example.com",
  "phone": {
    "areaCode": "+55",
    "ddd": "11",
    "number": "999999999",
    "isMobile": true
  },
  "document": {
    "type": "CPF",
    "number": "12345678909"
  }
}'

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/participants/PARTICIPANT_ID', {
  method: 'PATCH',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'x-api-secret': 'YOUR_API_SECRET',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "João Silva",
    "email": "joao.silva@example.com",
    "phone": {
      "areaCode": "+55",
      "ddd": "11",
      "number": "999999999",
      "isMobile": true
    },
    "document": {
      "type": "CPF",
      "number": "12345678909"
    }
  }),
});

const data = await response.json();
console.log(data);

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/participants/PARTICIPANT_ID"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
}
payload = {
    "name": "João Silva",
    "email": "joao.silva@example.com",
    "phone": {
        "areaCode": "+55",
        "ddd": "11",
        "number": "999999999",
        "isMobile": True,
    },
    "document": {
        "type": "CPF",
        "number": "12345678909",
    },
}

response = requests.patch(url, headers=headers, json=payload)
print(response.json())

Response

{
  "statusCode": 200,
  "data": {
    "updated": true
  }
}

{
  "message": "Invalid param: []",
  "error": "Bad Request",
  "statusCode": 400,
  "errorCode": "string"
}

Generated from the schema

{
  "message": "Unauthorized",
  "error": "Unauthorized",
  "statusCode": 401
}

Generated from the schema

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403
}

Generated from the schema

{
  "statusCode": 500,
  "message": "Internal Server Error"
}

Generated from the schema

Headers

x-api-keystringrequired
Api key provided on integrations tab in Easyflow platform.
x-api-secretstringrequired
Api Secret provided on integrations tab in Easyflow platform.