USusepylon
contacts

Update a contact by its ID or external ID

Changed on

Updates a contact by ID or external ID. Only provided fields are modified.

Rate limit: 300 requests per minute

patch/contacts/{id}

Request

  • Base URL
    https://api.usepylon.com
  • URL
    https://api.usepylon.com/contacts/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID or external ID of the contact to update.

Request body

account_external_idstring

The external ID of the account to move the contact to. Cannot be used together with account_id.

account_idstring

The account to move the contact to. If empty string is passed in, the contact will be removed from its account.

avatar_urlstring

The avatar URL of the contact. Must be a square .png, .jpg or .jpeg.

emailstring

The email of the contact. Replaces all of the contact's emails with this single email. Cannot be used together with the emails array field.

namestring

in: body The name of the contact.

phone_numbersstring[]

The phone numbers of the contact. Must contain only digits 0-9, optionally preceded by + (E.164, e.g. +4365446231), and be 15 digits or less. Include the + and country code for non-US numbers; a 10-digit number without + is treated as US.

portal_rolestring

The portal role to assign to the contact. Can be one of no_access, member, or admin, or a custom role slug.

Known values: no_access, member, admin. This list is not exhaustive.

portal_role_idstring

The ID of the custom portal role to assign to the contact. Takes precedence over portal_role if provided.

primary_phone_numberstring

The primary phone number. Must be in the list of phone_numbers. If there are any phone_numbers and this is not specified, the first phone number will be primary.

Response

request_idstring required

The request ID for tracking.

Example response

{
  "data": {
    "custom_fields": {
      "role": {
        "value": "admin"
      }
    }
  }
}

Changes

  • 40bf3229d58fRevision changes
    • info

      the response property became required for the status

  • dfb481067e5aRevision changes
    • breaking

      removed the enum value admin of the request property

    • breaking

      removed the enum value member of the request property

    • breaking

      removed the enum value no_access of the request property

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the / response's property type changed from object to no type for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added to the / response property allOf list for the response status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      removed the admin enum value from the / response property for the response status

    • info

      removed the duplicate_object enum value from the response property for the response status

    • info

      removed the duplicate_object enum value from the response property for the response status

    • info

      removed the duplicate_object enum value from the response property for the response status

    • info

      removed the duplicate_object enum value from the response property for the response status

    • info

      removed the email_bounced enum value from the response property for the response status

    • info

      removed the email_bounced enum value from the response property for the response status

    • info

      removed the email_bounced enum value from the response property for the response status

    • info

      removed the email_bounced enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the internal_issue_reply_not_allowed enum value from the response property for the response status

    • info

      removed the internal_issue_reply_not_allowed enum value from the response property for the response status

    • info

      removed the internal_issue_reply_not_allowed enum value from the response property for the response status

    • info

      removed the internal_issue_reply_not_allowed enum value from the response property for the response status

    • info

      removed the invalid_api_token enum value from the response property for the response status

    • info

      removed the invalid_api_token enum value from the response property for the response status

    • info

      removed the invalid_api_token enum value from the response property for the response status

    • info

      removed the invalid_api_token enum value from the response property for the response status

    • info

      removed the invalid_authorization_header enum value from the response property for the response status

    • info

      removed the invalid_authorization_header enum value from the response property for the response status

    • info

      removed the invalid_authorization_header enum value from the response property for the response status

    • info

      removed the invalid_authorization_header enum value from the response property for the response status

    • info

      removed the invalid_oauth_token enum value from the response property for the response status

    • info

      removed the invalid_oauth_token enum value from the response property for the response status

    • info

      removed the invalid_oauth_token enum value from the response property for the response status

    • info

      removed the invalid_oauth_token enum value from the response property for the response status

    • info

      removed the invalid_request_body enum value from the response property for the response status

    • info

      removed the invalid_request_body enum value from the response property for the response status

    • info

      removed the invalid_request_body enum value from the response property for the response status

    • info

      removed the invalid_request_body enum value from the response property for the response status

    • info

      removed the invalid_webhook_credentials enum value from the response property for the response status

    • info

      removed the invalid_webhook_credentials enum value from the response property for the response status

    • info

      removed the invalid_webhook_credentials enum value from the response property for the response status

    • info

      removed the invalid_webhook_credentials enum value from the response property for the response status

    • info

      removed the member enum value from the / response property for the response status

    • info

      removed the method_not_allowed enum value from the response property for the response status

    • info

      removed the method_not_allowed enum value from the response property for the response status

    • info

      removed the method_not_allowed enum value from the response property for the response status

    • info

      removed the method_not_allowed enum value from the response property for the response status

    • info

      removed the no_access enum value from the / response property for the response status

    • info

      removed the not_found enum value from the response property for the response status

    • info

      removed the not_found enum value from the response property for the response status

    • info

      removed the not_found enum value from the response property for the response status

    • info

      removed the not_found enum value from the response property for the response status

    • info

      removed the oauth_not_permitted enum value from the response property for the response status

    • info

      removed the oauth_not_permitted enum value from the response property for the response status

    • info

      removed the oauth_not_permitted enum value from the response property for the response status

    • info

      removed the oauth_not_permitted enum value from the response property for the response status

    • info

      removed the organization_deactivated enum value from the response property for the response status

    • info

      removed the organization_deactivated enum value from the response property for the response status

    • info

      removed the organization_deactivated enum value from the response property for the response status

    • info

      removed the organization_deactivated enum value from the response property for the response status

    • info

      removed the organization_inactive enum value from the response property for the response status

    • info

      removed the organization_inactive enum value from the response property for the response status

    • info

      removed the organization_inactive enum value from the response property for the response status

    • info

      removed the organization_inactive enum value from the response property for the response status

    • info

      removed the organization_suspended enum value from the response property for the response status

    • info

      removed the organization_suspended enum value from the response property for the response status

    • info

      removed the organization_suspended enum value from the response property for the response status

    • info

      removed the organization_suspended enum value from the response property for the response status

    • info

      removed the payload_too_large enum value from the response property for the response status

    • info

      removed the payload_too_large enum value from the response property for the response status

    • info

      removed the payload_too_large enum value from the response property for the response status

    • info

      removed the payload_too_large enum value from the response property for the response status

    • info

      removed the permission_denied enum value from the response property for the response status

    • info

      removed the permission_denied enum value from the response property for the response status

    • info

      removed the permission_denied enum value from the response property for the response status

    • info

      removed the permission_denied enum value from the response property for the response status

    • info

      removed the rate_limited enum value from the response property for the response status

    • info

      removed the rate_limited enum value from the response property for the response status

    • info

      removed the rate_limited enum value from the response property for the response status

    • info

      removed the rate_limited enum value from the response property for the response status

    • info

      removed the recipients_suppressed enum value from the response property for the response status

    • info

      removed the recipients_suppressed enum value from the response property for the response status

    • info

      removed the recipients_suppressed enum value from the response property for the response status

    • info

      removed the recipients_suppressed enum value from the response property for the response status

    • info

      removed the wrong_region_token enum value from the response property for the response status

    • info

      removed the wrong_region_token enum value from the response property for the response status

    • info

      removed the wrong_region_token enum value from the response property for the response status

    • info

      removed the wrong_region_token enum value from the response property for the response status